[Fleet] Add support for forcing stack aligned versions on bundled packages #139567

kpollich · 2022-08-26T16:45:59Z

Summary

Adds a forceAlignStackVersion option to fleet_packages.json
Implement logic to forcibly rewrite the version of a bundled package to be equal to the current Kibana build version (including -SNAPSHOT suffix if needed) when opted in via forceAlignStackVersion
Opt apm package into new versioning logic

To test

Comment out every task except the "bundle fleet packages" task in build_distributables.ts
Run yarn build --epr-registry=production to fetch bundled packages from the production registry (simulates an older APM version in registry)
Copy the build/kibana/x-pack/plugins/fleet/target/bundled_packages directory outputted by the build to x-pack/plugins/fleet/target/bundled_packages to resolve bundled packages in dev
Add a mock cloud policy to your kibana.dev.yml, e.g.

# Force use of the production registry so we don't resolve `apm-8.5.0` which is technically a greater semver than `8.5.0-SNAPSHOT` by spec
xpack.fleet.registryUrl: https://epr.elastic.co

xpack.fleet.packages:
  - name: apm
    version: latest
  - name: fleet_server
    version: latest
xpack.fleet.agentPolicies:
  # Cloud Agent policy
  - name: Elastic Cloud agent policy
    description: Default agent policy for agents hosted on Elastic Cloud
    id: policy-elastic-agent-on-cloud

    is_default: false
    is_managed: true
    is_default_fleet_server: false

    namespace: default
    monitoring_enabled: []
    unenroll_timeout: 86400 # 1 day TTL

    package_policies:
      - name: Fleet Server
        id: elastic-cloud-fleet-server
        package:
          name: fleet_server
        inputs:
          - type: fleet-server
            keep_enabled: true

            vars:
              - name: host
                value: 0.0.0.0
                frozen: true
              - name: port
                value: 8220
                frozen: true
              - name: custom
                value: |
                  server.runtime:
                    gc_percent: 20          # Force the GC to execute more frequently: see https://golang.org/pkg/runtime/debug/#SetGCPercent
      - name: Elastic APM
        id: elastic-cloud-apm
        package:
          name: apm
        inputs:
          - type: apm
            keep_enabled: true
            vars:
              - name: api_key_enabled
                value: true
              - name: host
                value: '0.0.0.0:8200'
                frozen: true
              - name: secret_token
                value: 'secret'
              - name: tls_enabled
                value: true
                frozen: true
              - name: tls_certificate
                value: /app/config/certs/node.crt
                frozen: true
              - name: tls_key
                value: /app/config/certs/node.key
                frozen: true
              - name: url
                value: 'https://example.com'
                frozen: true

Start up Kibana
Note that APM 8.4.0 is resolved from the registry, but its version is rewritten to 8.5.0-SNAPSHOT in its manifest and when presented in the UI

Dependency alert

I needed a way to manipulate and generate .zip files on the fly here, and https://github.com/thejoshwolfe/yazl seemed like the obvious choice. We already make use of its companion library https://github.com/thejoshwolfe/yauzl elsewhere in Kibana, so I opted to install yazl and @types/yazl to fulfill our needs here.

elasticmachine · 2022-08-26T16:46:02Z

Pinging @elastic/fleet (Team:Fleet)

axw

Looks good @kpollich! Just one question about the package that is fetched from EPR.

src/dev/build/tasks/bundle_fleet_packages.ts

kpollich · 2022-08-30T12:32:11Z

@elasticmachine merge upstream

…-versions

axw

LGTM 🎉

kpollich · 2022-08-30T13:08:53Z

@elasticmachine merge upstream

…-versions

src/dev/build/tasks/bundle_fleet_packages.ts

kpollich · 2022-08-31T13:25:10Z

@elasticmachine merge upstream

…-versions

mtojek · 2022-08-31T13:30:24Z

src/dev/build/tasks/bundle_fleet_packages.ts

+          );
+        }
+
+        const archivePath = `${fleetPackage.name}-${versionToWrite}.zip`;


I'm wondering if we can support 2 endpoints temporarily. The job I'm building here will use indices behind https://epr-v2.ea-web.elastic.dev/, which are different from https://epr-snapshot.elastic.co/ at the moment.

We have 3 options:

We will enable the job once we switch to Package Storage v2.

build_fleet_packages.ts will check also the v2 endpoint.

The job can update the fleet_packages.json with direct links to packages (and signatures).

I would prefer to keep Kibana somewhat unaware of a separate package storage v2 endpoint if possible.

What is your thinking behind checking v1 and v2? Just trying to catch cases where a package hasn't been upload to both places yet when a build occurs?

Actually it's more tangled.

APM pipeline is integrated only with v2, so you will never see this package in v1: https://epr-v2.ea-web.elastic.dev/search?prerelease=true&package=apm (8.5.0-preview-1661950351).

That's why I was thinking about setting download_urls in fleet_packages.json... or we will enable the job once we switch to v2 (epr-snapshot will point to https://epr-v2.ea-web.elastic.dev/).

I'm in favor of enabling the job once we switch to v2 to keep Kibana's assumption around EPR endpoints accurate before and after the release of package storage v2.

src/dev/build/lib/archive_utils.ts

nchaulet · 2022-08-31T18:23:33Z

@kpollich can it cause some issue with the integration list page, I think we are using the search endpoint from EPR here so the version could mismatch somehow no?

kpollich · 2022-08-31T18:25:06Z

@elasticmachine merge upstream

…-versions

kpollich · 2022-08-31T18:25:40Z

can it cause some issue with the integration list page, I think we are using the search endpoint from EPR here so the version could mismatch somehow no?

I don't think so, because bundled packages aren't included on the integrations grid. I'm kicking off a cloud deploy here just to verify in an environment where we have both bundled packages + EPR packages.

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

kpollich · 2022-08-31T20:23:25Z

Cloud deploy failed and I'm not sure why. Seems like a transient issue.

kpollich · 2022-08-31T20:30:04Z

@elasticmachine merge upstream

…-versions

kpollich · 2022-09-01T11:28:39Z

@elasticmachine merge upstream

…-versions

kibana-ci · 2022-09-01T12:10:28Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💔 Build #68854 failed c52584e
💔 Build #68834 failed 4fb7fd8
💚 Build #68813 succeeded 796431d
💚 Build #68676 succeeded 3e060fa
💚 Build #68304 succeeded e7a9440

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

cc @kpollich

kpollich · 2022-09-01T12:15:58Z

Cloud deploy looks good in terms of browse and installed integrations grid. Everything seems to be working as expected. cc @nchaulet

nchaulet

🚀

…kages (elastic#139567) * Add support for forcing stack aligned versions on bundled packages * Revert build_distributables * Add missing module * Enforce version in config even when stack aligned * Throw error on failure to download bundled package * Update comment Co-authored-by: Kibana Machine <[email protected]>

kpollich added 2 commits August 26, 2022 12:36

Add support for forcing stack aligned versions on bundled packages

c7f402d

Revert build_distributables

a4b3373

kpollich added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team labels Aug 26, 2022

kpollich requested a review from axw August 26, 2022 16:46

kpollich self-assigned this Aug 26, 2022

kpollich requested review from a team as code owners August 26, 2022 16:46

kpollich mentioned this pull request Aug 26, 2022

[Fleet] Support stack-aligned versioning scheme for bundled APM package #137759

Closed

Add missing module

bd7f4a9

axw reviewed Aug 30, 2022

View reviewed changes

src/dev/build/tasks/bundle_fleet_packages.ts Outdated Show resolved Hide resolved

kibanamachine and others added 2 commits August 30, 2022 08:32

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

36de3e7

…-versions

Enforce version in config even when stack aligned

4a2319b

axw approved these changes Aug 30, 2022

View reviewed changes

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

e7a9440

…-versions

jbudz reviewed Aug 30, 2022

View reviewed changes

src/dev/build/tasks/bundle_fleet_packages.ts Outdated Show resolved Hide resolved

Throw error on failure to download bundled package

3ed663c

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

3e060fa

…-versions

mtojek reviewed Aug 31, 2022

View reviewed changes

jbudz reviewed Aug 31, 2022

View reviewed changes

src/dev/build/lib/archive_utils.ts Show resolved Hide resolved

jbudz approved these changes Aug 31, 2022

View reviewed changes

kpollich added the ci:cloud-deploy Create or update a Cloud deployment label Aug 31, 2022

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

796431d

…-versions

nchaulet reviewed Aug 31, 2022

View reviewed changes

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

Update comment

4fb7fd8

kpollich added the ci:cloud-redeploy Always create a new Cloud deployment label Aug 31, 2022

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

c52584e

…-versions

Merge branch 'main' into 137759-support-stack-aligned-bundled-package…

45e0e11

…-versions

nchaulet approved these changes Sep 1, 2022

View reviewed changes

kpollich merged commit 29b1428 into elastic:main Sep 1, 2022

kpollich deleted the 137759-support-stack-aligned-bundled-package-versions branch September 1, 2022 13:30

kibanamachine added v8.5.0 backport:skip This commit does not require backporting labels Sep 1, 2022

kpollich mentioned this pull request Sep 22, 2022

[Fleet] Check bundled packages when querying package info in getInfo API #141462

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Add support for forcing stack aligned versions on bundled packages #139567

[Fleet] Add support for forcing stack aligned versions on bundled packages #139567

kpollich commented Aug 26, 2022 •

edited

Loading

elasticmachine commented Aug 26, 2022

axw left a comment

kpollich commented Aug 30, 2022

axw left a comment

kpollich commented Aug 30, 2022

kpollich commented Aug 31, 2022

mtojek Aug 31, 2022

kpollich Aug 31, 2022

mtojek Aug 31, 2022

kpollich Aug 31, 2022

nchaulet commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Sep 1, 2022

kibana-ci commented Sep 1, 2022 •

edited

Loading

kpollich commented Sep 1, 2022

nchaulet left a comment

[Fleet] Add support for forcing stack aligned versions on bundled packages #139567

[Fleet] Add support for forcing stack aligned versions on bundled packages #139567

Conversation

kpollich commented Aug 26, 2022 • edited Loading

Summary

To test

Dependency alert

elasticmachine commented Aug 26, 2022

axw left a comment

Choose a reason for hiding this comment

kpollich commented Aug 30, 2022

axw left a comment

Choose a reason for hiding this comment

kpollich commented Aug 30, 2022

kpollich commented Aug 31, 2022

mtojek Aug 31, 2022

Choose a reason for hiding this comment

kpollich Aug 31, 2022

Choose a reason for hiding this comment

mtojek Aug 31, 2022

Choose a reason for hiding this comment

kpollich Aug 31, 2022

Choose a reason for hiding this comment

nchaulet commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Aug 31, 2022

kpollich commented Sep 1, 2022

kibana-ci commented Sep 1, 2022 • edited Loading

💚 Build Succeeded

Metrics [docs]

History

kpollich commented Sep 1, 2022

nchaulet left a comment

Choose a reason for hiding this comment

kpollich commented Aug 26, 2022 •

edited

Loading

kibana-ci commented Sep 1, 2022 •

edited

Loading