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.

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

[DOCS] Fleet managed integrations content #970

Merged
merged 3 commits into from
Mar 25, 2024

Conversation

amyjtechwriter
Copy link
Contributor

Some Fleet installed integrations are now read-only and badged with a 'Managed' tag in the Kibana UI.

system-managed These are Elastic managed and cannot be edited. To be customized they must be copied first, which de-couples them from the original configuration.

Relates to:#175150
Corresponds with Kibana page update: #178380

@amyjtechwriter amyjtechwriter added documentation Improvements or additions to documentation Team:Docs 8.13-request labels Mar 12, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Mar 12, 2024

This pull request does not have a backport label. Could you fix it @amyjtechwriter? 🙏
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.

@amyjtechwriter
Copy link
Contributor Author

@elasticmachine run docs-build

[role="screenshot"]
image::images/system-managed.png[An image of the new managed badge.]

The cloned content is unlinked with the original reference configurations, so becomes independent from the original managed content. For example, with a cloned dashboard, the cloned panels become entirely self-contained copy without any dependencies on the original configuration. Clones can be customized and modified without accidentally affecting the original.

Choose a reason for hiding this comment

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

The cloned content is unlinked with the original reference configurations, so becomes independent from the original managed content.

I don't think we can call this a general rule. For example, a managed visualization may use the logs-* data view which is a managed data view. And the cloned version will, too.

The only case where the unlinking happens is with dashboard panels, as you've described here!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah ok, sorry that was a bad assumption. Let me rework this and also update the corresponding Kibana page.

@@ -61,3 +61,4 @@ The *Integrations* app in {kib} needs access to the public {package-registry} to
discover integrations. If your deployment has network restrictions, you can
{fleet-guide}/air-gapped.html#air-gapped-diy-epr[deploy your own self-managed {package-registry}].
====

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd maybe remove this extra line just to avoid including an extra file in the PR.

kilfoyle
kilfoyle previously approved these changes Mar 12, 2024
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

Looks good to me so far! 🚀

@amyjtechwriter amyjtechwriter marked this pull request as ready for review March 21, 2024 16:04
@amyjtechwriter amyjtechwriter requested a review from a team as a code owner March 21, 2024 16:04
kilfoyle
kilfoyle previously approved these changes Mar 21, 2024
Copy link

@drewdaemon drewdaemon left a comment

Choose a reason for hiding this comment

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

LGTM

[role="screenshot"]
image::images/system-managed.png[An image of the new managed badge.]

When a managed dashboard is cloned, any linked or referenced panels become part of the clone without relying on external sources. The panels are integrated into the cloned dashboard as stand alone components. For example, with a cloned dashboard, the cloned panels become entirely self-contained copies without any dependencies on the original configuration. Clones can be customized and modified without accidentally affecting the original.

Choose a reason for hiding this comment

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

Nice!

@amyjtechwriter amyjtechwriter requested a review from kilfoyle March 25, 2024 20:48
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@amyjtechwriter amyjtechwriter merged commit 65dbe49 into elastic:main Mar 25, 2024
3 checks passed
amyjtechwriter added a commit to elastic/kibana that referenced this pull request Mar 25, 2024
## Summary

The [Fleet
page](https://www.elastic.co/guide/en/kibana/current/fleet.html) in the
Kibana docs needed to be updated to reflect that most Fleet-installed
integrations cannot be directly edited any longer. Users need to make
clones of this managed content to make edits and customizations.

Closes: [#175150](#175150)

Relates to: [#970](elastic/ingest-docs#970)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 25, 2024
## Summary

The [Fleet
page](https://www.elastic.co/guide/en/kibana/current/fleet.html) in the
Kibana docs needed to be updated to reflect that most Fleet-installed
integrations cannot be directly edited any longer. Users need to make
clones of this managed content to make edits and customizations.

Closes: [elastic#175150](elastic#175150)

Relates to: [elastic#970](elastic/ingest-docs#970)

(cherry picked from commit ab98a25)
kibanamachine referenced this pull request in elastic/kibana Mar 25, 2024
# Backport

This will backport the following commits from `main` to `8.13`:
- [[DOCS] Fleet managed content
(#178380)](#178380)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"amyjtechwriter","email":"61687663+amyjtechwriter@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-03-25T22:14:29Z","message":"[DOCS]
Fleet managed content (#178380)\n\n## Summary\r\n\r\nThe
[Fleet\r\npage](https://www.elastic.co/guide/en/kibana/current/fleet.html)
in the\r\nKibana docs needed to be updated to reflect that most
Fleet-installed\r\nintegrations cannot be directly edited any longer.
Users need to make\r\nclones of this managed content to make edits and
customizations.\r\n\r\nCloses:
[#175150](https://github.com/elastic/kibana/issues/175150)\r\n\r\nRelates
to:
[#970](https://github.com/elastic/ingest-docs/pull/970)","sha":"ab98a258b262a3fe3bb6a9a6b56e3d9d9021a1c3","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.13.0","v8.14.0"],"title":"[DOCS]
Fleet managed
content","number":178380,"url":"https://github.com/elastic/kibana/pull/178380","mergeCommit":{"message":"[DOCS]
Fleet managed content (#178380)\n\n## Summary\r\n\r\nThe
[Fleet\r\npage](https://www.elastic.co/guide/en/kibana/current/fleet.html)
in the\r\nKibana docs needed to be updated to reflect that most
Fleet-installed\r\nintegrations cannot be directly edited any longer.
Users need to make\r\nclones of this managed content to make edits and
customizations.\r\n\r\nCloses:
[#175150](https://github.com/elastic/kibana/issues/175150)\r\n\r\nRelates
to:
[#970](https://github.com/elastic/ingest-docs/pull/970)","sha":"ab98a258b262a3fe3bb6a9a6b56e3d9d9021a1c3"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/178380","number":178380,"mergeCommit":{"message":"[DOCS]
Fleet managed content (#178380)\n\n## Summary\r\n\r\nThe
[Fleet\r\npage](https://www.elastic.co/guide/en/kibana/current/fleet.html)
in the\r\nKibana docs needed to be updated to reflect that most
Fleet-installed\r\nintegrations cannot be directly edited any longer.
Users need to make\r\nclones of this managed content to make edits and
customizations.\r\n\r\nCloses:
[#175150](https://github.com/elastic/kibana/issues/175150)\r\n\r\nRelates
to:
[#970](https://github.com/elastic/ingest-docs/pull/970)","sha":"ab98a258b262a3fe3bb6a9a6b56e3d9d9021a1c3"}}]}]
BACKPORT-->

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.13-request backport-skip documentation Improvements or additions to documentation Team:Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants