Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Fleet/Agent 8.6.0 release notes #2450

Merged
merged 10 commits into from
Jan 10, 2023
Merged

Add Fleet/Agent 8.6.0 release notes #2450

merged 10 commits into from
Jan 10, 2023

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Dec 3, 2022 •
edited
Loading

Closes #2449

Link to preview: https://observability-docs_2450.docs-preview.app.elstc.co/guide/en/fleet/master/release-notes-8.6.0.html

Reviewers:

  • Please verify the "details" and "impact" sections. Some changelog fragments didn't contain sufficient detail, so I winged it.
  • There was only one changelog fragment for Fleet Server. It's not really a feature and feels like internals, so I don't think I should add it to the release notes, but let me know if my assumption is wrong: Fix error when raw error is retrieved fleet-server#2079

Archived notes (please ignore everything below this heading)

Notes for finalizing this PR:

  • The dev team has developed a tool to make it easier to maintain changelogs and generate release notes, but it only works for Elastic Agent.
  • Assuming we want to provide a single place for users to view Elastic Agent, Fleet, and Fleet Server relnotes, we still need to assemble the content manually.
  • I've provided some boilerplate text to make this easier. You may need to modify the boilerplate text and/or the agent changelog entries to get them to work. I feel we can change the style in 8.6, if we want.

Resources

The source content for the release notes will come from the following places:

  • Elastic Agent changelog fragments. The dev team will generate the changelog for 8.6.0 from existing fragments. Reach out to @endorama or @cmacknz about a week before the release. Note that there is a related issue open here to add some fragments: Add changelog entries and update documentation for agent v2 changes that are visible to users elastic-agent#1687
  • Fleet Server changelog fragments. You'll need to look at the changelog fragments in the fleet-server repo and incorporate the list of changes manually. Make sure you look at the fragments for the latest BC (basically https://github.com/elastic/fleet-server/tree/commithash/changelog/fragments where commithash is the hash associated with the release artifact. (Ask dev if you're not sure.)
  • Fleet release notes in Kibana (see [DOCS] Adds the 8.6.0 release notes kibana#145768). You'll need to copy any Fleet-related content from each section for the Kibana release notes and possibly modify attribute references to make it work in the Fleet/Agent docs. (Or we could decide not to cover Fleet and tell users to refer to the Kibana docs. Might be awkward for existing users, tho.)

Here are some related PRs and resources:

Reviewers

When it's ready, this PR should be reviewed by @cmacknz and @jen-huang (or someone they designate)

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2022

A documentation preview will be available soon:

@mergify
Copy link
Contributor

mergify bot commented Dec 3, 2022

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Dec 3, 2022
@dedemorton dedemorton mentioned this pull request Dec 3, 2022
Closed
@dedemorton dedemorton requested a review from a team December 3, 2022 00:24
@dedemorton dedemorton added backport-8.6 Automated backport with mergify Team:Docs Label for the Observability docs team and removed backport-skip Skip notification from the automated backport with mergify labels Dec 3, 2022
@dedemorton dedemorton self-assigned this Dec 3, 2022
@cmacknz cmacknz mentioned this pull request Dec 14, 2022
Closed
2 tasks
@dedemorton dedemorton marked this pull request as ready for review January 10, 2023 02:27
@pierrehilbert
Copy link
Contributor

Some changes are missing:

  • New control protocol between the Elastic Agent and its subprocesses.
  • Internal directory structure change
  • All binaries for every supported integration will be bundled in the Elastic Agent by default.

More details here: https://github.com/elastic/elastic-agent/pull/2076/files

@dedemorton
Copy link
Contributor Author

Some changes are missing:

OK, I will add them. I thought they were in the category of changes you did not want to include because they didn't show up in the asciidoc file. Sorry about that....

dedemorton
dedemorton commented Jan 10, 2023
View reviewed changes
docs/en/ingest-management/release-notes/release-notes-8.6.asciidoc
* Add `inspect components` command to inspect the computed components/units model of the current configuration (for example, `elastic-agent inspect components`) {agent-pull}1701[#1701] {agent-issue}836[#836]
* Add support for the Common Expression Language (CEL) {filebeat} input type {agent-pull}1719[#1719]
* Only support {es} as an output for the beta synthetics integration {agent-pull}1491[#1491]
* New control protocol between the {agent} and its subprocesses enables per integration health reporting and simplifies new input development {agent-issue}836[#836] {agent-pull}1701[#1701]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pierrehilbert I've added the missing changelog items here. However, the change to the internal directory structure does not seem like a "feature" to me. Should it be covered under breaking changes instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point, we should get this content merged and do follow-up PRs if additional changes are required. I just need approval....

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to put it into "upgrade" kind but seems to be not working that's why I changed to "feature". But yes "breaking-change" makes probably more sense.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The internal directory structure change shouldn't be a breaking change, in that the user shouldn't need to take any action to account for it. Agent should keep working. It is definitely notable though.

cmacknz
cmacknz approved these changes Jan 10, 2023
View reviewed changes
Copy link
Member

@cmacknz cmacknz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm approving this to unblock the release notes going up. DeDe make any changes you feel are appropriate in the current PR, and we can use a follow up PR to adjust it further if needed.

@dedemorton dedemorton merged commit 306422e into elastic:main Jan 10, 2023
@dedemorton dedemorton deleted the issue#2449 branch January 10, 2023 17:57
@mergify mergify bot mentioned this pull request Jan 10, 2023
Merged
mergify bot pushed a commit that referenced this pull request Jan 10, 2023
@dedemorton @mergify
Add Fleet/Agent 8.6.0 release notes (#2450)
fda4dd7 
Co-authored-by: Craig MacKenzie <[email protected]>
Co-authored-by: Pierre HILBERT <[email protected]>
(cherry picked from commit 306422e)
dedemorton added a commit that referenced this pull request Jan 10, 2023
@mergify @dedemorton
Add Fleet/Agent 8.6.0 release notes (#2450) (#2489)
cced130 
Co-authored-by: Craig MacKenzie <[email protected]>
Co-authored-by: Pierre HILBERT <[email protected]>
(cherry picked from commit 306422e)

Co-authored-by: DeDe Morton <[email protected]>
@dedemorton dedemorton mentioned this pull request Jan 11, 2023
Merged
@dikshachauhan-qasource
Copy link

Hi @dedemorton

As per current changes suggested in PR, we are able to find notable changes on the Fleet release notes link.

Link validated: https://www.elastic.co/guide/en/fleet/8.6/release-notes-8.6.0.html

Thanks!!
QAS

bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 11, 2023
@dedemorton @cmacknz @pierrehilbert
Add Fleet/Agent 8.6.0 release notes (elastic#2450)
5b6356c 
Co-authored-by: Craig MacKenzie <[email protected]>
Co-authored-by: Pierre HILBERT <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@juliaElastic juliaElastic juliaElastic left review comments

@pierrehilbert pierrehilbert pierrehilbert left review comments

@cmacknz cmacknz cmacknz approved these changes

@jen-huang jen-huang Awaiting requested review from jen-huang

Assignees

@dedemorton dedemorton

Labels
backport-8.6 Automated backport with mergify Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[REQUEST]: Create Fleet/Agent 8.6.0 release notes
5 participants
@dedemorton @pierrehilbert @dikshachauhan-qasource @cmacknz @juliaElastic