Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 15, 2025

Adds documentation for the kibana-setup CLI tool following the same format and structure as the existing kibana-verification-code documentation added in #120836.

The kibana-setup tool walks users through all required steps to securely connect Kibana with Elasticsearch using enrollment tokens. This documentation provides:

  • Complete command synopsis with all available options
  • Detailed description of the tool's purpose and usage
  • Parameter documentation for all CLI options:
    • -t, --enrollment-token <token>: Elasticsearch enrollment token
    • -s, --silent: Prevent all logging output
    • Standard -h, --help and -V, --version options
  • Usage examples showing interactive setup, token-based setup, and silent operation

The documentation is integrated into the existing CLI tools structure:

  • Added to the main CLI commands page (docs/reference/commands.md)
  • Included in the navigation table of contents (docs/reference/toc.yml)
  • Follows consistent formatting with other CLI documentation

Fixes #120993.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add docs for kibana-setup CLI [DOCS] Add kibana-setup CLI documentation Sep 15, 2025
Copilot AI requested a review from legrego September 15, 2025 17:25
Copilot finished work on behalf of legrego September 15, 2025 17:25
@github-actions
Copy link
Contributor

github-actions bot commented Sep 15, 2025

🔍 Preview links for changed docs

@legrego legrego marked this pull request as ready for review September 15, 2025 18:06
@legrego legrego requested a review from a team as a code owner September 15, 2025 18:06
@legrego legrego added release_note:skip Skip the PR/issue when compiling release notes Team:Security Platform Security: Auth, Users, Roles, Spaces, Audit Logging, etc t// labels Sep 15, 2025
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-security (Team:Security)

@legrego legrego added the docs label Sep 15, 2025
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

LGTM besides the frontmatter. Content looks consistent with other similar pages

Co-authored-by: florent-leborgne <[email protected]>
@legrego legrego enabled auto-merge (squash) September 16, 2025 10:25
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

👍

@legrego
Copy link
Member

legrego commented Sep 16, 2025

/ci

@legrego
Copy link
Member

legrego commented Sep 16, 2025

@elasticmachine run docs-build

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

History

cc @legrego @Copilot

@legrego legrego merged commit 6e08de8 into main Sep 16, 2025
12 checks passed
@legrego legrego deleted the copilot/fix-120993 branch September 16, 2025 12:08
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.1

https://github.com/elastic/kibana/actions/runs/17765226475

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 16, 2025
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
9.1

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 16, 2025
# Backport

This will backport the following commits from `main` to `9.1`:
- [[DOCS] Add kibana-setup CLI documentation
(#235122)](#235122)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT
[{"author":{"name":"Copilot","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-09-16T12:08:21Z","message":"[DOCS]
Add kibana-setup CLI documentation
(#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","💝community","docs","backport:prev-minor","v9.2.0"],"title":"[DOCS]
Add kibana-setup CLI
documentation","number":235122,"url":"https://github.com/elastic/kibana/pull/235122","mergeCommit":{"message":"[DOCS]
Add kibana-setup CLI documentation
(#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/235122","number":235122,"mergeCommit":{"message":"[DOCS]
Add kibana-setup CLI documentation
(#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9"}}]}]
BACKPORT-->

Co-authored-by: Copilot <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

💝community docs release_note:skip Skip the PR/issue when compiling release notes Team:Security Platform Security: Auth, Users, Roles, Spaces, Audit Logging, etc t// v9.1.4 v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for kibana-setup CLI

5 participants