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

[Change Proposal] Add support for "next steps" links to be referenced in Kibana #832

Open
criamico opened this issue Nov 18, 2024 · 3 comments
Assignees
Labels
discuss Issue needs discussion Team:Fleet Label for the Fleet team

Comments

@criamico
Copy link
Contributor

There are some cases when an integration developer might want to prompt the user to navigate to another area of kibana.

For instance, in the case of Agentless policy configuration, the developer might need to display some next steps links that link to the kibana areas where the additional configuration will happen, as shown in the screenshot:
Image

To be able to do an integration developer should be able to enumerate "next step" options for each package/policy template in kibana manifest:

policy_templates:
  - name: foo
    ...
    links:
      - title: Findings
        type: post_install_step
        content: "Consolidated view of security and compliance issues identified within your environment"
        url: "kbn:/app/enterprise_search/content/connector/{{connector_id}}/overview"
      - title: Add more accounts
        type: action
        url: "kbn:..."

There is also a special case of next steps that will navigate the user to the Connectors UI in Kibana and will reference connector ids for this:
Image

These Connector Ids are currently static for the lifetime of a connector instance, (as they are ES Index document _id values for the .elastic-connectors-v1 index) and they are being added as configurable to the policy "advanced" configuration, so they'll show up here. About connectors, they could be defined in one of these two ways:

  • In the package policy ( no changes to package-spec)
  • in package-spec, with the above suggested change to policy templates links, adding a templated variable {{connector_id}} that references the vars content.
@criamico criamico added discuss Issue needs discussion Team:Fleet Label for the Fleet team labels Nov 18, 2024
@criamico criamico self-assigned this Nov 18, 2024
@jsoriano
Copy link
Member

These Connector Ids are currently static for the lifetime of a connector instance, (as they are ES Index document _id values for the .elastic-connectors-v1 index) and they are being added as configurable to the policy "advanced" configuration, so they'll show up here.

So they are variables in the policy, right? This looks good as would be the same templating used in agent policies.

@criamico
Copy link
Contributor Author

I see that there was a recent change done to the elastic_connectors integration and connector_ids now show up there as well: https://github.com/elastic/integrations/blob/69fd5a26c4d0a8e9e999c51fb49a2cf28c078dd2/packages/elastic_connectors/manifest.yml#L45-L62. Here's the PR

@jedrazb
Copy link
Member

jedrazb commented Nov 19, 2024

@criamico Heyo 👋 (I noticed you might mentioned my recent PR by accident). Just to clarify, we extended the policy to optionally (!) define the connector_id in the policy. If the connector_id isn’t set, we fall back to using the input ID as the id for a new connector doc.

This approach ensures the policy always encodes which connector document is tied to a specific integration. Feel free to ping me if you have any questions.

@criamico criamico changed the title [Change Proposal] Add support for "next steps" links and connectors to be referenced in Kibana [Change Proposal] Add support for "next steps" links to be referenced in Kibana Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issue needs discussion Team:Fleet Label for the Fleet team
Projects
None yet
Development

No branches or pull requests

3 participants