diff --git a/deploy-manage/deploy/self-managed/air-gapped-install.md b/deploy-manage/deploy/self-managed/air-gapped-install.md index cb391a84f9..7cb08fde9d 100644 --- a/deploy-manage/deploy/self-managed/air-gapped-install.md +++ b/deploy-manage/deploy/self-managed/air-gapped-install.md @@ -454,12 +454,4 @@ Some {{ml}} features, like natural language processing (NLP), require you to dep ## {{kib}} Product documentation for AI Assistants [air-gapped-kibana-product-documentation] -Installing the AI Assistant knowledge base content (Elastic documentation and Security Labs) requires network access to the artifact repository at `https://kibana-knowledge-base-artifacts.elastic.co`. - -{applies_to}`stack: ga 9.4` In environments where outbound traffic must go through an HTTP proxy, you can configure {{kib}} to reach the artifact repository through the proxy by adding the following to `kibana.yml`: - -```yaml -xpack.productDocBase.artifactRepositoryProxyUrl: "https://my-proxy-host:port" -``` - -For fully air-gapped environments where no external network access is available, refer to the [{{kib}} AI Assistants settings documentation](kibana://reference/configuration-reference/ai-assistant-settings.md) for instructions on deploying a local artifact repository. +Installing the AI Assistant knowledge base content (Elastic documentation and Security Labs) requires network access to the artifact repository at `https://kibana-knowledge-base-artifacts.elastic.co/`. If you don't have access, which is common for deployments in air-gapped or restricted networks, you must deploy the knowledge base artifact repository manually. For details, refer to [Host a knowledge base artifact repo for AI assistants](../../../explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md). \ No newline at end of file diff --git a/explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md b/explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md new file mode 100644 index 0000000000..bd4d0fabd8 --- /dev/null +++ b/explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md @@ -0,0 +1,254 @@ +--- +navigation_title: "Knowledge base artifact repo for AI assistants" +applies_to: + self: ga +products: + - id: kibana + - id: security + - id: observability + - id: elasticsearch +description: Host AI assistant knowledge base artifacts using S3-compatible storage, CDN, or local paths when Kibana cannot reach Elastic’s public URL, then set the repository URL and install from the assistant UI. +--- + +# Host a knowledge base artifact repo for AI assistants [host-knowledge-base-artifact-repo-for-ai-assistants] + +When {{kib}} can't use Elastic’s [public artifact URL](https://kibana-knowledge-base-artifacts.elastic.co/), which is common for deployments in air-gapped or restricted networks, you must deploy the knowledge base artifact repository manually. You do that by mirroring Elastic’s versioned knowledge base artifact ZIP files to infrastructure that {{kib}} can reach. + +This page walks you through hosting those ZIP files, configuring the repository URL in {{kib}}, and installing knowledge base content from the AI assistant so assistants can use Elastic product documentation without reaching Elastic’s public artifact host. + +## Choose a hosting option [choose-a-hosting-option-for-knowledge-base-artifacts] + +Use this list to figure out the best deployment and hosting setup for your environment, then go to the [Deploy the repository](#deploy-the-knowledge-base-artifact-repository) section for detailed steps. + +* **S3-compatible bucket**: You store the artifact ZIP files in an S3-compatible bucket over HTTPS and the bucket exposes a normal object listing at the repository root, so {{kib}} can discover the ZIPs without you maintaining a separate listing XML file (unlike the CDN option). +* **CDN**: You serve the ZIP files through a CDN and publish S3-style listing XML yourself, served as the folder’s default document or directory index. +* **Local files on the {{kib}} host** {applies_to}`stack: ga 9.1+`: The ZIP files exist only on the {{kib}} host filesystem and you configure a `file://` repository URL. + +## Deploy the repository [deploy-the-knowledge-base-artifact-repository] + +Choose the tab that matches your deployment and hosting setup: + +:::::::{tab-set} + +::::::{tab-item} S3-compatible bucket + +:::::{stepper} + +::::{step} Get the product documentation ZIP files for your {{kib}} version + +:::{tip} +Check which stack version you’re running (for example, 9.0). The `{{versionMajor}}.{{versionMinor}}` segment in each file name must match that release. If it doesn’t match your {{kib}} release, or the file names differ from what Elastic publishes for that release, installation will fail. +::: + +Elastic publishes knowledge base artifact ZIP files for each minor version, one each for {{es}}, {{kib}}, {{observability}}, and {{elastic-sec}}. File names follow this pattern: + +```yaml +kb-product-doc-{{productName}}-{{versionMajor}}.{{versionMinor}}.zip +``` + +For example, when {{kib}} is 9.0, the ZIP files are: + +* `kb-product-doc-elasticsearch-9.0.zip` +* `kb-product-doc-kibana-9.0.zip` +* `kb-product-doc-observability-9.0.zip` +* `kb-product-doc-security-9.0.zip` + +Download the ZIP files from [kibana-knowledge-base-artifacts.elastic.co](https://kibana-knowledge-base-artifacts.elastic.co/) when you can reach that host, or copy them from another trusted source that already hosts the same ZIP files if you’re fully offline. + +:::: + +::::{step} Upload the ZIP files to your bucket + +Configure the bucket root so its listing matches `https://kibana-knowledge-base-artifacts.elastic.co/` and lists all ZIPs. Over HTTPS, use S3-style listing from a compatible bucket. + +:::{important} +For S3-compatible storage, a single HTTPS repository root must expose the bucket’s list response (the same S3-style listing {{kib}} would get from `ListObjects`-style APIs) and the object keys at that same root. **Do not** rely on a separate path for the ZIPs. Object key names must match the ZIP file names from the previous step so each listing entry resolves to a downloadable file. +::: + +:::: + +::::{step} Set the repository URL in {{kib}} + +In `kibana.yml`, set [`xpack.productDocBase.artifactRepositoryUrl`](kibana://reference/configuration-reference/ai-assistant-settings.md) to the bucket root’s HTTPS URL (the base that serves both the listing and the ZIPs). **Do not** point it at a subdirectory of that root. + +```yaml +# Replace with your bucket’s HTTPS base URL (repository root only) +xpack.productDocBase.artifactRepositoryUrl: "" +``` + +:::: + +::::{step} Restart {{kib}} + +[Stop and restart](/deploy-manage/maintenance/start-stop-services/start-stop-kibana.md) {{kib}}. The new `artifactRepositoryUrl` value isn’t applied until {{kib}} fully restarts. + +:::: + +::::{step} Install knowledge base content from the AI assistant UI + +The steps to install knowledge base content depend on the assistant that you use: + +* **AI Assistant for Security**: Refer to [Give AI Assistant access to Elastic’s product documentation](/solutions/security/ai/ai-assistant-knowledge-base.md#elastic-docs). +* **AI Assistant for Observability and Search**: Refer to [Add Elastic documentation](/solutions/observability/ai/observability-ai-assistant.md#obs-ai-product-documentation). + +:::: + +::::: + +:::::: + +::::::{tab-item} CDN + +:::::{stepper} + +::::{step} Get the product documentation ZIP files for your {{kib}} version + +:::{tip} +Check which stack version you’re running (for example, 9.0). The `{{versionMajor}}.{{versionMinor}}` segment in each file name must match that release. If it doesn’t match your {{kib}} release, or the file names differ from what Elastic publishes for that release, installation will fail. +::: + +Elastic publishes knowledge base artifact ZIP files for each minor version, one each for {{es}}, {{kib}}, {{observability}}, and {{elastic-sec}}. File names follow this pattern: + +```yaml +kb-product-doc-{{productName}}-{{versionMajor}}.{{versionMinor}}.zip +``` + +For example, when {{kib}} is 9.0, the ZIP files are: + +* `kb-product-doc-elasticsearch-9.0.zip` +* `kb-product-doc-kibana-9.0.zip` +* `kb-product-doc-observability-9.0.zip` +* `kb-product-doc-security-9.0.zip` + +Download the ZIP files from [kibana-knowledge-base-artifacts.elastic.co](https://kibana-knowledge-base-artifacts.elastic.co/) when you can reach that host, or copy them from another trusted source that already hosts the same ZIP files if you’re fully offline. + +:::: + +::::{step} Upload the ZIP files to the CDN + +Put all ZIP files in one folder on the CDN origin (or backing storage) so they share a single HTTPS base path. You add the listing XML in the next step and wire the CDN to serve it as that folder’s index. + +:::: + +::::{step} Create and upload the bucket listing + +Copy the template, set each `` to your real file names and minor version (for {{kib}} 9.1, replace `9.0` in the example with `9.1` everywhere in the keys). + +```xml + + kibana-ai-assistant-kb-artifacts + false + + kb-product-doc-elasticsearch-9.0.zip + + + kb-product-doc-kibana-9.0.zip + + + kb-product-doc-observability-9.0.zip + + + kb-product-doc-security-9.0.zip + + +``` + +Place the XML in the same folder as the ZIP files. Configure the CDN so a request to that folder’s base URL returns this XML (often as the index or default document). + +:::{important} +On a CDN, each `` must match a real ZIP file name in that origin folder, and the XML must be what clients get when they request the folder URL (default document or directory index). {{kib}} reads that listing from the same HTTPS base path it uses to download the ZIPs, so don’t split the listing and the ZIP files across different URLs or path roots. +::: + +:::: + +::::{step} Set the repository URL in {{kib}} + +Set [`xpack.productDocBase.artifactRepositoryUrl`](kibana://reference/configuration-reference/ai-assistant-settings.md) to that folder’s HTTPS base URL (the URL whose index serves the XML). Don’t append an extra path past that root. + +```yaml +# Replace with your CDN folder’s HTTPS base URL (repository root only) +xpack.productDocBase.artifactRepositoryUrl: "" +``` + +:::: + +::::{step} Restart {{kib}} + +[Stop and restart](/deploy-manage/maintenance/start-stop-services/start-stop-kibana.md) {{kib}}. + +:::: + +::::{step} Install knowledge base content from the AI assistant UI + +The steps to install knowledge base content depend on the assistant that you use: + +* **AI Assistant for Security**: Refer to [Give AI Assistant access to Elastic’s product documentation](/solutions/security/ai/ai-assistant-knowledge-base.md#elastic-docs). +* **AI Assistant for Observability and Search**: Refer to [Add Elastic documentation](/solutions/observability/ai/observability-ai-assistant.md#obs-ai-product-documentation). + +:::: + +::::: + +:::::: + +::::::{tab-item} Local files on the {{kib}} host + +```{applies_to} +self: ga 9.1+ +``` + +:::::{stepper} + +::::{step} Get the product documentation ZIP files for your {{kib}} version + +:::{tip} +Check which stack version you’re running (for example, 9.0). The `{{versionMajor}}.{{versionMinor}}` segment in each file name must match that release. If it doesn’t match your {{kib}} release, or the file names differ from what Elastic publishes for that release, installation will fail. +::: + +Put the version-matched ZIP files in one directory on the {{kib}} host. File names use this pattern: + +```yaml +kb-product-doc-{{productName}}-{{versionMajor}}.{{versionMinor}}.zip +``` + +For example, when {{kib}} is 9.0: + +* `kb-product-doc-elasticsearch-9.0.zip` +* `kb-product-doc-kibana-9.0.zip` +* `kb-product-doc-observability-9.0.zip` +* `kb-product-doc-security-9.0.zip` + +Download the ZIP files from [kibana-knowledge-base-artifacts.elastic.co](https://kibana-knowledge-base-artifacts.elastic.co/) when you can reach that host, or copy them from another trusted source that already hosts the same ZIP files if you’re fully offline. + +:::: + +::::{step} Set the repository URL in {{kib}} + +Set [`xpack.productDocBase.artifactRepositoryUrl`](kibana://reference/configuration-reference/ai-assistant-settings.md) to the `file://` URL of that directory. + +:::{important} +With a `file://` repository, the directory must sit on the {{kib}} host, or on storage mounted there. It must also be readable by the user that runs {{kib}}. Use the `file://` URL of the folder that directly contains the ZIPs. **Do not** point at a parent directory. File names must stay exactly as in the previous step, or {{kib}} won’t pick up the ZIP files. +::: + +:::: + +::::{step} Restart {{kib}} + +[Stop and restart](/deploy-manage/maintenance/start-stop-services/start-stop-kibana.md) {{kib}}. + +:::: + +::::{step} Install knowledge base content from the AI assistant UI + +The steps to install knowledge base content depend on the assistant that you use: + +* **AI Assistant for Security**: Refer to [Give AI Assistant access to Elastic’s product documentation](/solutions/security/ai/ai-assistant-knowledge-base.md#elastic-docs). +* **AI Assistant for Observability and Search**: Refer to [Add Elastic documentation](/solutions/observability/ai/observability-ai-assistant.md#obs-ai-product-documentation). + +:::: + +::::: + +:::::: + +::::::: diff --git a/explore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md b/explore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md index 2f78695629..8e4bc4b65c 100644 --- a/explore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md +++ b/explore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md @@ -154,4 +154,4 @@ While local (open-weight) LLMs offer greater privacy and control, they generally Local LLMs in air-gapped environments have specific installation and configuration instructions for deploying ELSER and configuring product documentation. Refer to the following links for more information: - [Deploy ELSER in an air-gapped environment](/explore-analyze/machine-learning/nlp/ml-nlp-elser.md#air-gapped-install) -- [Configure product documentation for air-gapped-environments](kibana://reference/configuration-reference/ai-assistant-settings.md#configuring-product-doc-for-airgap) \ No newline at end of file +- [Host a knowledge base artifact repo for AI assistants](/explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md) \ No newline at end of file diff --git a/explore-analyze/toc.yml b/explore-analyze/toc.yml index 97e613c244..b25c8162f4 100644 --- a/explore-analyze/toc.yml +++ b/explore-analyze/toc.yml @@ -231,6 +231,7 @@ toc: children: - file: ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md - file: ai-features/ai-chat-experiences/ai-assistant.md + - file: ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts.md - file: ai-features/manage-access-to-ai-assistant.md - file: ai-features/agent-skills.md - file: ai-features/llm-guides/llm-connectors.md diff --git a/solutions/observability/ai/observability-ai-assistant.md b/solutions/observability/ai/observability-ai-assistant.md index ff05046a63..3d0a277bd3 100644 --- a/solutions/observability/ai/observability-ai-assistant.md +++ b/solutions/observability/ai/observability-ai-assistant.md @@ -484,7 +484,7 @@ You can make the official Elastic documentation available to the AI Assistant, w Enable this feature from the **Settings** tab in AI Assistant Settings by using the "Install Elastic Documentation" action. ::::{important} -For air-gapped environments or environments where outbound traffic must go through an HTTP proxy, installing product documentation requires special configuration. Refer to the [{{kib}} AI Assistants settings documentation](kibana://reference/configuration-reference/ai-assistant-settings.md) for detailed instructions. +For air-gapped environments or environments where outbound traffic must go through an HTTP proxy, installing product documentation requires special configuration. Refer to the [Knowledge base artifact settings for AI Assistants](kibana://reference/configuration-reference/ai-assistant-settings.md) for detailed instructions. :::: ## Anonymization [obs-ai-anonymization] diff --git a/solutions/security/ai/ai-assistant-knowledge-base.md b/solutions/security/ai/ai-assistant-knowledge-base.md index c2fef52980..eb9646bee3 100644 --- a/solutions/security/ai/ai-assistant-knowledge-base.md +++ b/solutions/security/ai/ai-assistant-knowledge-base.md @@ -42,7 +42,7 @@ The `Elastic AI Assistant: All` role privilege allows you to use AI Assistant an When you enable Knowledge Base, AI Assistant automatically gains access to Elastic's product documentation. This improves its answers to questions related to Elastic products and features. -In air-gapped environments or environments where outbound traffic must go through an HTTP proxy, this requires additional configuration. Refer to the [{{kib}} AI Assistant settings documentation](kibana://reference/configuration-reference/ai-assistant-settings.md) for detailed instructions on configuring a proxy or deploying a local artifact repository. Once you complete the instructions on that page, AI Assistant will automatically gain access to Elastic's documentation as soon as you start a new conversation. +For air-gapped environments or environments where outbound traffic must go through an HTTP proxy, installing product documentation requires special configuration. Refer to the [Knowledge base artifact settings for AI Assistants](kibana://reference/configuration-reference/ai-assistant-settings.md) for detailed instructions. ## Enable Knowledge Base [enable-knowledge-base]