Prerelease toggle #143853

juliaElastic · 2022-10-24T12:52:28Z

Summary

Closes #122973

Added prerelease toggle to Integrations list, disabled by default (meaning that prerelease version packages are filtered out)
On changing the toggle, the setting is saved to the backend in Fleet Settings SO.
On subsequent reloads, the value of the toggle value is read from the settings.
On navigating to a package with prerelease version, a callout is displayed with a button to navigate to latest GA version
When the latest prerelease version is newer than a GA version, a version select is displayed on the Integration page.

Pending functionality:

Verify the display of Upgrade available button
Update unit and functional tests
Update OpenAPI spec
Fix scenario when package latest GA is installed, and the newer prerelease version is not showing up as latest

Test instructions

Option 1: use v2 dev registry which has some prerelease packages

Add this to your kibana config:

xpack.fleet.registryUrl: https://epr-v2.ea-web.elastic.dev/

Test with endpoint package, which has endpoint-8.6.0-dev.0 prerelease version.

Option 2: setup local registry

Download the test data zip:
registry-packages.zip
Start a registry:

docker run -p 8080:8080 -v <path to unzipped dir>/input-packages/packages:/packages/test-packages -v <path to unzipped dir>/input-packages/package_registry_config.yml:/package-registry/config.yml docker.elastic.co/package-registry/package-registry:main

Add this to your kibana config:

xpack.fleet.registryUrl: http://localhost:8080

The test registry contains 2 versions of elastic_agent package: 1.3.5 (GA) and 1.3.6-preview (beta).
The toggle can be verified by searching on the elastic_agent package. The GA version should be displayed when the toggle is off, and the newer Beta version when the toggle is on.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

…eginning

juliaElastic · 2022-10-25T15:24:16Z

@elasticmachine merge upstream

elasticmachine · 2022-10-26T11:00:09Z

Pinging @elastic/fleet (Team:Fleet)

x-pack/plugins/fleet/server/services/preconfiguration.ts

nchaulet · 2022-10-26T11:55:39Z

Should we allow the user to set that settings programatically in their kibana config file?

juliaElastic · 2022-10-26T12:06:26Z

Should we allow the user to set that settings programatically in their kibana config file?

Discussed this with @kpollich and decided not to add to kibana config for now, as it would complicate things - we would have to disable the setting on the UI to avoid getting in inconsistent state with the config.

x-pack/plugins/fleet/server/services/epm/packages/install.ts

juliaElastic · 2022-10-28T14:10:53Z

x-pack/plugins/fleet/scripts/install_all_packages/install_all_packages.ts

@@ -57,7 +57,7 @@ async function deletePackage(name: string, version: string) {

 async function getAllPackages() {
  const res = await fetch(
-    `${REGISTRY_URL}/search?experimental=true&kibana.version=${KIBANA_VERSION}`,
+    `${REGISTRY_URL}/search?prerelease=true&kibana.version=${KIBANA_VERSION}`,


should we try to install the prerelease version of packages here or only the GA ones?

I think we may want to make this configurable but that can probably be done later.

x-pack/plugins/fleet/server/services/epm/packages/install.ts

juliaElastic · 2022-10-31T07:00:12Z

@elasticmachine merge upstream

juliaElastic · 2022-10-31T08:30:15Z

@elasticmachine merge upstream

juliaElastic · 2022-11-01T08:08:07Z

x-pack/plugins/fleet/server/services/epm/packages/bulk_install_packages.ts

@@ -35,16 +34,13 @@ export async function bulkInstallPackages({
 }: BulkInstallPackagesParams): Promise<BulkInstallResponse[]> {
  const logger = appContextService.getLogger();

-  // auto upgrade to prerelease versions only if the setting is enabled
-  const prerelease = await getPrereleaseFromSettings(savedObjectsClient);


removed using the settings after discussing here #122973 (comment)

juliaElastic · 2022-11-01T09:35:57Z

x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/home/index.tsx

@@ -100,7 +108,7 @@ export const mapToCard = ({
    fromIntegrations: selectedCategory,
    integration: 'integration' in item ? item.integration || '' : '',
    name: 'name' in item ? item.name : item.id,
-    version: 'version' in item ? item.version || '' : '',
+    version,


Fixing a bug when a GA version is installed (e.g. endpoint-8.5.0), the release badge on Installed integrations tab was showing Beta. I think this was misleading and the badge should show the installed version's release.

Also, on Browse integrations tab, changed the integration card to link to the latest version of the integration, not the installed one as currently. Though I am not sure if the intention here was to show the latest or installed version. In main branch, the card shows a link to the installed version, but the version and release badge is based on the latest version, so it is inconsistent.

Also, on Browse integrations tab, changed the integration card to link to the latest version of the integration, not the installed one as currently. Though I am not sure if the intention here was to show the latest or installed version. In main branch, the card shows a link to the installed version, but the version and release badge is based on the latest version, so it is inconsistent.

Should we browse to the installed version from the installed tab and to the latest from the browse all, or it is odd?

Should we browse to the installed version from the installed tab and to the latest from the browse all, or it is odd?

Yeah, this was the most intuitive to me too, this is how it works in the pr currently.

…to show available upgrade if package is installed

nchaulet

Tested locally and it looks good to me 🚀

kibana-ci · 2022-11-02T08:45:22Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	729	732	+3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	896	897	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	851.1KB	854.9KB	+3.8KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`fleet`	17	18	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`fleet`	114.1KB	114.5KB	+418.0B

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/saved-objects-service.html#_mappings

id	before	after	diff
`ingest_manager_settings`	3	4	+1

Unknown metric groups

API count

id	before	after	diff
`fleet`	999	1000	+1

ESLint disabled in files

id	before	after	diff
`osquery`	1	2	+1

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`fleet`	57	63	+6
`osquery`	103	108	+5
`securitySolution`	439	445	+6
total			+19

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`fleet`	65	71	+6
`osquery`	104	110	+6
`securitySolution`	516	522	+6
total			+20

History

💚 Build #84340 succeeded e8cad3a
💔 Build #84296 failed 38d817b
💔 Build #84265 failed 3c5fbe9
💔 Build #84246 failed 04f890a
💚 Build #83823 succeeded 491e6ab
💔 Build #83796 failed e2fef9a

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @juliaElastic

WIP: prerelease toggle

829224f

juliaElastic added Team:Fleet Team label for Observability Data Collection Fleet team release_note:feature Makes this part of the condensed release notes v8.6.0 labels Oct 24, 2022

juliaElastic self-assigned this Oct 24, 2022

juliaElastic added 7 commits October 24, 2022 17:25

changed styling

108d0bf

fixed switch

e934801

auto upgrade and hiding button on callout if no ga available

6fb4c6b

tweak prereleaseIntegrationsEnabled state to add undefined state in b…

1e917f0

…eginning

fixing types and tests

e4f0c97

fixing types

8ef9d29

removed dummy endpoint package

ddf36c9

kibanamachine and others added 3 commits October 25, 2022 11:24

Merge branch 'main' into feat/prerelease-toggle

86a7bb0

extracted hooks to avoid double loading of packages and categories

ccaed79

prevent double loading of package details

1dafa0e

juliaElastic changed the title ~~WIP: prerelease toggle~~ Prerelease toggle Oct 26, 2022

juliaElastic marked this pull request as ready for review October 26, 2022 11:00

juliaElastic requested review from a team as code owners October 26, 2022 11:00

updated openapi

729c740

nchaulet reviewed Oct 26, 2022

View reviewed changes

x-pack/plugins/fleet/server/services/preconfiguration.ts Outdated Show resolved Hide resolved

fixing tests

098d9b6

juliaElastic requested a review from a team as a code owner October 26, 2022 12:28

nchaulet reviewed Oct 26, 2022

View reviewed changes

x-pack/plugins/fleet/server/services/epm/packages/install.ts Show resolved Hide resolved

juliaElastic added 2 commits October 26, 2022 14:39

added try catch around loading settings in preconfig

de3af8e

error handling on integrations, fixing cypress test with that

5f916ea

nchaulet self-requested a review October 28, 2022 13:37

added UI package version check for prerelease disabled case

ef8d6c9

juliaElastic commented Oct 28, 2022

View reviewed changes

merge 'main' resolved conflicts manually

8d14082

nchaulet reviewed Oct 28, 2022

View reviewed changes

x-pack/plugins/fleet/server/services/epm/packages/install.ts Outdated Show resolved Hide resolved

Merge branch 'main' into feat/prerelease-toggle

e2fef9a

kibanamachine and others added 3 commits October 31, 2022 04:30

Merge branch 'main' into feat/prerelease-toggle

21dd5e5

fixed synthetics test

a21d194

extracted getSettings to a helper function

491e6ab

juliaElastic requested review from nchaulet and a team November 1, 2022 07:16

removed using prerease setting in auto upgrades and install

04f890a

juliaElastic commented Nov 1, 2022

View reviewed changes

fixing tests, added back prerelease flag to install apis

1ff3156

juliaElastic force-pushed the feat/prerelease-toggle branch from 59c01d9 to 1ff3156 Compare November 1, 2022 09:29

fixing a bug with version and release badge of installed integrations

3c5fbe9

juliaElastic commented Nov 1, 2022

View reviewed changes

juliaElastic added 2 commits November 1, 2022 12:31

reload package in overview after loading prerelease setting, this is …

38d817b

…to show available upgrade if package is installed

fixing tests by passing prerelease flag on apis

d4d0e27

nchaulet approved these changes Nov 1, 2022

View reviewed changes

juliaElastic and others added 2 commits November 1, 2022 14:37

fixing cypress test

e8cad3a

Merge branch 'main' into feat/prerelease-toggle

13b381a

juliaElastic merged commit 5431d1f into elastic:main Nov 2, 2022

kibanamachine added the backport:skip This commit does not require backporting label Nov 2, 2022

juliaElastic mentioned this pull request Nov 2, 2022

added fix for add and edit integrations page not loading for beta versions #144431

Merged

amolnater-qasource mentioned this pull request Mar 15, 2023

[Fleet] Add option to toggle search of prerelease packages #122973

Closed

1 task

kpollich mentioned this pull request Oct 29, 2024

[Fleet] Remove deprecated APIs, parameters, and response properties from Fleet API #189746

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prerelease toggle #143853

Prerelease toggle #143853

juliaElastic commented Oct 24, 2022 •

edited

Loading

juliaElastic commented Oct 25, 2022

elasticmachine commented Oct 26, 2022

nchaulet commented Oct 26, 2022

juliaElastic commented Oct 26, 2022

juliaElastic Oct 28, 2022

nchaulet Oct 28, 2022

juliaElastic commented Oct 31, 2022

juliaElastic commented Oct 31, 2022

juliaElastic Nov 1, 2022

juliaElastic Nov 1, 2022 •

edited

Loading

nchaulet Nov 1, 2022

juliaElastic Nov 1, 2022 •

edited

Loading

nchaulet left a comment

kibana-ci commented Nov 2, 2022

API count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

Prerelease toggle #143853

Prerelease toggle #143853

Conversation

juliaElastic commented Oct 24, 2022 • edited Loading

Summary

Test instructions

Option 1: use v2 dev registry which has some prerelease packages

Option 2: setup local registry

Checklist

juliaElastic commented Oct 25, 2022

elasticmachine commented Oct 26, 2022

nchaulet commented Oct 26, 2022

juliaElastic commented Oct 26, 2022

juliaElastic Oct 28, 2022

Choose a reason for hiding this comment

nchaulet Oct 28, 2022

Choose a reason for hiding this comment

juliaElastic commented Oct 31, 2022

juliaElastic commented Oct 31, 2022

juliaElastic Nov 1, 2022

Choose a reason for hiding this comment

juliaElastic Nov 1, 2022 • edited Loading

Choose a reason for hiding this comment

nchaulet Nov 1, 2022

Choose a reason for hiding this comment

juliaElastic Nov 1, 2022 • edited Loading

Choose a reason for hiding this comment

nchaulet left a comment

Choose a reason for hiding this comment

kibana-ci commented Nov 2, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

Saved Objects .kibana field count

API count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

juliaElastic commented Oct 24, 2022 •

edited

Loading

juliaElastic Nov 1, 2022 •

edited

Loading

juliaElastic Nov 1, 2022 •

edited

Loading