Skip to content

[UII] Add remote cluster instructions for syncing integrations#211997

Merged
jen-huang merged 5 commits intoelastic:mainfrom
jen-huang:feat/sync/follower-instructions
Feb 21, 2025
Merged

[UII] Add remote cluster instructions for syncing integrations#211997
jen-huang merged 5 commits intoelastic:mainfrom
jen-huang:feat/sync/follower-instructions

Conversation

@jen-huang
Copy link
Copy Markdown
Contributor

@jen-huang jen-huang commented Feb 21, 2025 •
edited
Loading

Summary

Resolves #206239. This PR adds instructions for configuring the remote cluster to enable syncing integrations (for a Remote Elasticsearch output).

It also hides extra fields when Sync integrations is not enabled:

image

When enabled:

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.
@jen-huang jen-huang added release_note:fix backport:skip This PR does not require backporting Team:Fleet Team label for Observability Data Collection Fleet team v9.1.0 labels Feb 21, 2025
@jen-huang jen-huang self-assigned this Feb 21, 2025
@jen-huang jen-huang requested a review from a team as a code owner February 21, 2025 00:32
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Feb 21, 2025

Pinging @elastic/fleet (Team:Fleet)
jen-huang
jen-huang commented Feb 21, 2025
View reviewed changes
Comment thread ...applications/fleet/sections/settings/components/edit_output_flyout/output_form_remote_es.tsx Outdated
<EuiSpacer size="m" />
<FormattedMessage
id="xpack.fleet.settings.remoteClusterConfiguration.description"
defaultMessage="The Remote Elasticsearch output must have additional configuration to sync integrations from this cluster. {documentationLink}."
Copy link
Copy Markdown
Contributor Author

@jen-huang jen-huang Feb 21, 2025

Choose a reason for hiding this comment

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

@kilfoyle I would appreciate some wordsmithing magic on all the text added in this callout :) There's sort of a two-way "remote cluster" situation which I found hard to explain.

The user is setting up a "remote Elasticsearch" output on this local cluster. In order to automatically sync integration assets to that remote ES, we need them to connect this local cluster to that remote cluster. From that cluster's perspective, this local cluster is considered the "remote cluster." Does it make sense? 😅
Copy link
Copy Markdown
Member

@kilfoyle kilfoyle Feb 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Sure! How about this? Just some slight changes from the original. For the third step, to shorten it a bit I suppose we can omit the "allow this cluster to read integration status" as they'll gather what it's for.

To sync integrations from this cluster, the remote Elasticsearch output needs additional configuration. [Learn more ↗.]

  1. In the remote cluster, open Kibana and go to Stack Management > Remote Clusters, and follow the steps to add this cluster.

  2. Go to Stack Management > Cross-Cluster Replication and create a follower index using the cluster from Step 1. The leader index fleet-synced-integrations from this cluster should be replicated to the follower index fleet-synced-integrations-ccr-<output name> on the remote cluster.

  3. Below, provide the access details for the remote cluster's Kibana instance.
Copy link
Copy Markdown
Contributor Author

@jen-huang jen-huang Feb 21, 2025

Choose a reason for hiding this comment

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

Thanks, updated!
@jen-huang jen-huang requested a review from a team as a code owner February 21, 2025 00:44
jen-huang
jen-huang commented Feb 21, 2025
View reviewed changes
Comment thread ...applications/fleet/sections/settings/components/edit_output_flyout/output_form_remote_es.tsx
defaultMessage="The Remote Elasticsearch output must have additional configuration to sync integrations from this cluster. {documentationLink}."
values={{
documentationLink: (
<EuiLink external={true} href={docLinks.links.fleet.remoteESOoutput}>
Copy link
Copy Markdown
Contributor Author

@jen-huang jen-huang Feb 21, 2025

Choose a reason for hiding this comment

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

@kilfoyle I expect we'll file a docs request when #187323 is near completion and I think it probably makes sense for the new content to live on the same remote ES output docs page, but we can update the link here if not.
Copy link
Copy Markdown
Member

@kilfoyle kilfoyle Feb 21, 2025

Choose a reason for hiding this comment

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

Yup! That makes sense to me. Best to keep all the remote ES stuff together on the same page.
juliaElastic
juliaElastic approved these changes Feb 21, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@juliaElastic juliaElastic left a comment

Choose a reason for hiding this comment

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

LGTM
kilfoyle
kilfoyle approved these changes Feb 21, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@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! 🎸
I added some small suggestions for the UI text.
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Feb 21, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] x-pack/test_serverless/functional/test_suites/security/common_configs/config.group5.ts / discover/group1 discover test nested query should support querying on nested fields

Metrics [docs]

Async chunks

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

id before after diff
aiAssistantManagementSelection 92.5KB 92.5KB -28.0B
fleet 1.7MB 1.7MB +2.9KB
lists 136.5KB 136.5KB -28.0B
total +2.8KB

Page load bundle

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

id before after diff
core 474.6KB 474.6KB -28.0B

History

cc @jen-huang
@jen-huang jen-huang merged commit f0797db into elastic:main Feb 21, 2025
@jen-huang jen-huang deleted the feat/sync/follower-instructions branch February 21, 2025 22:24
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Feb 27, 2025
@jen-huang @JoseLuisGJ
[UII] Add remote cluster instructions for syncing integrations (elast…
1a70b13 
…ic#211997)

## Summary

Resolves elastic#206239. This PR adds
instructions for configuring the remote cluster to enable syncing
integrations (for a Remote Elasticsearch output).

It also hides extra fields when `Sync integrations` is not enabled:


![image](https://github.com/user-attachments/assets/fc76050c-fdc7-4d5f-b169-8fcb97c65b4e)

When enabled: 


![image](https://github.com/user-attachments/assets/23a28086-598c-478b-a898-ad0214c45b37)

### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Mar 22, 2025
@jen-huang @CAWilson94
[UII] Add remote cluster instructions for syncing integrations (elast…
23dcb37 
…ic#211997)

## Summary

Resolves elastic#206239. This PR adds
instructions for configuring the remote cluster to enable syncing
integrations (for a Remote Elasticsearch output).

It also hides extra fields when `Sync integrations` is not enabled:


![image](https://github.com/user-attachments/assets/fc76050c-fdc7-4d5f-b169-8fcb97c65b4e)

When enabled: 


![image](https://github.com/user-attachments/assets/23a28086-598c-478b-a898-ad0214c45b37)

### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
@jillguyonnet jillguyonnet mentioned this pull request Mar 27, 2025
Merged
jillguyonnet added a commit to elastic/docs-content that referenced this pull request Mar 31, 2025
@jillguyonnet
[Fleet] Add documentation for remote ES output integrations syncing (#…
dfc48c9 
…952)

Closes elastic/kibana#206246

This PR updates the documentation about remote Elasticsearch outputs to
detail the requirements and configuration steps of syncing integrations
on the remote cluster.

Preview
[here](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/952/reference/fleet/remote-elasticsearch-output#automatic-integrations-synchronization)

Note that in-product instructions were added in
elastic/kibana#211997 (tiny typo fix in
elastic/kibana#216149).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:fix Team:Fleet Team label for Observability Data Collection Fleet team v9.1.0

4 participants

@jen-huang @elasticmachine @kilfoyle @juliaElastic