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

Add documentation for airgap install of the product documentation #202912

Merged

Conversation

pgayvallet
Copy link
Contributor

@pgayvallet pgayvallet commented Dec 4, 2024

Summary

Part of #199999

Add documentation regarding how to install the AI Assistant product documentation on air-gap environments.

Copy link
Contributor

github-actions bot commented Dec 4, 2024

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.

@pgayvallet pgayvallet added release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels Team:AI Infra AppEx AI Infrastructure Team v8.17.0 v8.18.0 labels Dec 4, 2024
@pgayvallet
Copy link
Contributor Author

/ci

@pgayvallet pgayvallet marked this pull request as ready for review December 5, 2024 12:24
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-ai-infra (Team:AI Infra)

@legrego legrego self-requested a review December 5, 2024 12:27
@legrego legrego added the docs label Dec 5, 2024
Copy link
Member

@legrego legrego left a comment

Choose a reason for hiding this comment

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

Content LGTM, my comments are mostly style/phrasing nits

docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved

The product documentation requires network access to its artifact repository to be installed and enabled.
For air-gapped environments, or environments where remote network traffic is blocked or filtered,
the artifact repository must be manually deployed somewhere accessible by the Kibana deployment.
Copy link
Member

Choose a reason for hiding this comment

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

What you had was fine, this feels slightly less repetitive

Suggested change
the artifact repository must be manually deployed somewhere accessible by the Kibana deployment.
the artifact repository must be manually deployed somewhere accessible by the {kib} installation.

docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ai-assistant-settings.asciidoc Outdated Show resolved Hide resolved
@@ -669,3 +669,4 @@ include::{kibana-root}/docs/settings/spaces-settings.asciidoc[]
include::{kibana-root}/docs/settings/task-manager-settings.asciidoc[]
include::{kibana-root}/docs/settings/telemetry-settings.asciidoc[]
include::{kibana-root}/docs/settings/url-drilldown-settings.asciidoc[]
include::{kibana-root}/docs/settings/ai-assistant-settings.asciidoc[]
Copy link
Member

Choose a reason for hiding this comment

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

This list appears to be sorted alphabetically. Should this be moved up to the top?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have no idea, but I assume you're right, so moved!

@pgayvallet pgayvallet requested a review from a team as a code owner December 5, 2024 14:16
@pgayvallet pgayvallet requested a review from legrego December 5, 2024 14:18
Copy link
Member

@legrego legrego left a comment

Choose a reason for hiding this comment

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

LGTM!

@pgayvallet
Copy link
Contributor Author

@elasticmachine merge upstream

@pgayvallet pgayvallet enabled auto-merge (squash) December 6, 2024 15:33
@pgayvallet pgayvallet merged commit e3bc923 into elastic:main Dec 6, 2024
8 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.17, 8.x

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

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 6, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.

(cherry picked from commit e3bc923)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 6, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.

(cherry picked from commit e3bc923)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.17
8.x

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 Dec 6, 2024
…ion (#202912) (#203301)

# Backport

This will backport the following commits from `main` to `8.17`:
- [Add documentation for airgap install of the product documentation
(#202912)](#202912)

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

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

<!--BACKPORT [{"author":{"name":"Pierre
Gayvallet","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-06T16:55:59Z","message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","backport:version","Team:AI
Infra","v8.17.0","v8.18.0"],"title":"Add documentation for airgap
install of the product
documentation","number":202912,"url":"https://github.com/elastic/kibana/pull/202912","mergeCommit":{"message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2"}},"sourceBranch":"main","suggestedTargetBranches":["8.17","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202912","number":202912,"mergeCommit":{"message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2"}},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Pierre Gayvallet <[email protected]>
kibanamachine added a commit that referenced this pull request Dec 6, 2024
…on (#202912) (#203302)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Add documentation for airgap install of the product documentation
(#202912)](#202912)

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

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

<!--BACKPORT [{"author":{"name":"Pierre
Gayvallet","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-06T16:55:59Z","message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","backport:version","Team:AI
Infra","v8.17.0","v8.18.0"],"title":"Add documentation for airgap
install of the product
documentation","number":202912,"url":"https://github.com/elastic/kibana/pull/202912","mergeCommit":{"message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2"}},"sourceBranch":"main","suggestedTargetBranches":["8.17","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202912","number":202912,"mergeCommit":{"message":"Add
documentation for airgap install of the product documentation
(#202912)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/kibana/issues/199999\r\n\r\nAdd documentation
regarding how to install the AI Assistant product\r\ndocumentation on
air-gap
environments.","sha":"e3bc923b9a414b31c944ce856e91d2664631edf2"}},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Pierre Gayvallet <[email protected]>
markov00 pushed a commit to markov00/kibana that referenced this pull request Dec 7, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Dec 9, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Dec 9, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 9, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
Samiul-TheSoccerFan pushed a commit to Samiul-TheSoccerFan/kibana that referenced this pull request Dec 10, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
mykolaharmash pushed a commit to mykolaharmash/kibana that referenced this pull request Dec 11, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 12, 2024
…astic#202912)

## Summary

Part of elastic#199999

Add documentation regarding how to install the AI Assistant product
documentation on air-gap environments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:AI Infra AppEx AI Infrastructure Team v8.17.0 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants