[Product docs] Add new update_all endpoint for product docs management (elastic#231884)

## Summary

This PR fixes elastic#231450. It adds a
check upon Kibana start to get previously installed product docs and
their Inference IDs, then perform upgrade task for each. This means upon
Kibana start:
- If previous version has ELSER installed → ELSER product docs are
updated
- If previous version has E5 installed → E5 product docs are updated

This PR also exposes out a new API that will allow users to update
product_docs on command.

### To update

Passing `forceUpdate: true` will uninstall and install the product docs
to the latest compatible version, even if docs for the same Kibana
version are already installed. This is helpful if we need to repair
installation or simply upgrade/update docs to the newest possible
version even for the same Kibana major-minor version.

Because the operation is expensive, by default, `forceUpdate` is set to
false unless user explicitly wants to do that with the API.

To force update all previously installed Inference IDs:
```
POST kbn://internal/product_doc_base/update_all
{
  # Will force update to latest compatible, even for same Kibana version
  "forceUpdate": true
}
```

Optionally, you can specify specific Inference IDs to update:
```
POST kbn://internal/product_doc_base/update_all
{
   # Will only update to latest compatible only if Kibana version is different
  "forceUpdate": false,
  "inferenceIds": [
    ".multilingual-e5-small-elasticsearch",
  ]
}
```
Omit `inferenceIds` if you want to update all previously installed docs,
regardless of which Inference ID.
- If ELSER was installed, but not E5 → ELSER docs will be updated
- If E5 was installed, but not ELSER → E5 docs will be updated
- If ELSER was installed, E5 was installed → ELSER & E5 docs will be
updated

### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [ ] 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)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [ ] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Author: 3 people

docs/extend/plugin-list.md

@@ -188,7 +188,7 @@ mapped_pages:
 | [onechat](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/onechat/README.md) | Home of the workchat framework. |
 | [osquery](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/osquery/README.md) | This plugin adds extended support to Security Solution Fleet Osquery integration |
 | [painlessLab](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/private/painless_lab/README.md) | This plugin helps users learn how to use the Painless scripting language. |
-| [productDocBase](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/ai_infra/product_doc_base/README.md) | This plugin contains the product documentation base service. |
+| [productDocBase](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/ai_infra/product_doc_base/README.md) | We expose several APIs to install, update, and uninstall product docs artifacts. Currently, for every Kibana version, we support product docs for 2 Inference IDs: .multilingual-e5-small-elasticsearch \| .elser-2-elasticsearch. |
 | [productIntercept](https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/private/product_intercept/README.md) | This is a standalone plugin that leverages the intercept plugin to display product intercept used to gather information that is turn used to compute CSAT about user's experience of Kibana. |
 | [profiling](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/profiling/README.md) | Universal Profiling provides fleet-wide, whole-system, continuous profiling with zero instrumentation. Get a comprehensive understanding of what lines of code are consuming compute resources throughout your entire fleet by visualizing your data in Kibana using the flamegraph, stacktraces, and top functions views. |
 | [profilingDataAccess](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/profiling_data_access) | WARNING: Missing or empty README. |

packages/kbn-optimizer/limits.yml

@@ -121,7 +121,7 @@ pageLoadAssetSize:
   painlessLab: 6299
   presentationPanel: 11484
   presentationUtil: 9000
-  productDocBase: 3074
+  productDocBase: 3083
   productIntercept: 9860
   profiling: 20716
   reindexService: 3601

x-pack/platform/plugins/shared/ai_infra/product_doc_base/README.md

@@ -1,3 +1,63 @@
 # Product documentation base plugin
 
-This plugin contains the product documentation base service.
+
+## Kibana API
+We expose several APIs to install, update, and uninstall product docs artifacts. Currently, for every Kibana version, we support product docs for 2 Inference IDs: .multilingual-e5-small-elasticsearch | .elser-2-elasticsearch.
+
+### To install
+```
+POST kbn://internal/product_doc_base/install
+{
+  "inferenceId": ".multilingual-e5-small-elasticsearch"
+}
+```
+### To update
+
+ Passing `forceUpdate: true` will uninstall and install the product docs to the latest compatible version, even if docs for the same Kibana version are already installed. This is helpful if we need to repair installation or simply upgrade/update docs to the newest possible version even for the same Kibana major-minor version.
+
+Because the operation is expensive, by default, `forceUpdate` is set to false unless user explicitly wants to do that with the API.
+
+To force update all previously installed Inference IDs:
+```
+POST kbn://internal/product_doc_base/update_all
+{
+  # Will force update to latest compatible, even for same Kibana version
+  "forceUpdate": true
+}
+```
+
+Optionally, you can specify specific Inference IDs to update:
+```
+POST kbn://internal/product_doc_base/update_all
+{
+   # Will only update to latest compatible only if Kibana version is different
+  "forceUpdate": false,
+  "inferenceIds": [
+    ".multilingual-e5-small-elasticsearch",
+  ]
+}
+```
+Omit `inferenceIds` if you want to update all previously installed docs, regardless of which Inference ID.
+- If ELSER was installed, but not E5 → ELSER docs will be updated
+- If E5 was installed, but not ELSER → E5 docs will be updated
+- If ELSER was installed, E5 was installed → ELSER & E5 docs will be updated
+
+### To uninstall
+```
+POST kbn://internal/product_doc_base/uninstall
+{
+  "inferenceId": ".elser-2-elasticsearch"
+}
+```
+
+
+## Run tests
+
+Set up test server
+```
+node scripts/functional_tests_server.js --config x-pack/platform/test/functional_gen_ai/inference/config.ts
+```
+Run tests on different terminal
+```
+node scripts/functional_tests_server.js --config x-pack/platform/test/functional_gen_ai/inference/config.ts --grep='product docs base'
+```

x-pack/platform/plugins/shared/ai_infra/product_doc_base/common/http_api/installation.ts

@@ -11,6 +11,7 @@ import type { ProductInstallState, InstallationStatus } from '../install_status'
 export const INSTALLATION_STATUS_API_PATH = '/internal/product_doc_base/status';
 export const INSTALL_ALL_API_PATH = '/internal/product_doc_base/install';
 export const UNINSTALL_ALL_API_PATH = '/internal/product_doc_base/uninstall';
+export const UPDATE_ALL_API_PATH = '/internal/product_doc_base/update_all';
 
 export interface InstallationStatusResponse {
   inferenceId: string;
@@ -23,6 +24,11 @@ export interface PerformInstallResponse {
   failureReason?: string;
 }
 
+export interface PerformUpdateResponse {
+  installed: boolean;
+  failureReason?: string;
+}
+
 export interface UninstallResponse {
   success: boolean;
 }

x-pack/platform/plugins/shared/ai_infra/product_doc_base/public/services/installation/installation_service.test.ts

@@ -11,6 +11,7 @@ import {
   INSTALLATION_STATUS_API_PATH,
   INSTALL_ALL_API_PATH,
   UNINSTALL_ALL_API_PATH,
+  UPDATE_ALL_API_PATH,
 } from '../../../common/http_api/installation';
 import { defaultInferenceEndpoints } from '@kbn/inference-common';
 
@@ -95,6 +96,55 @@ describe('InstallationService', () => {
       );
     });
   });
+  describe('#updateAll', () => {
+    it('calls the endpoint with the forceUpdate as false by default', async () => {
+      await service.updateAll();
+      expect(http.post).toHaveBeenCalledTimes(1);
+      expect(http.post).toHaveBeenCalledWith(UPDATE_ALL_API_PATH, {
+        body: JSON.stringify({
+          forceUpdate: false,
+        }),
+      });
+    });
+    it('calls the endpoint with the forceUpdate ', async () => {
+      await service.updateAll({ forceUpdate: true });
+      expect(http.post).toHaveBeenCalledTimes(1);
+      expect(http.post).toHaveBeenCalledWith(UPDATE_ALL_API_PATH, {
+        body: JSON.stringify({
+          forceUpdate: true,
+        }),
+      });
+    });
+    it('calls the endpoint with the forceUpdate and Inference Ids if provided', async () => {
+      await service.updateAll({
+        forceUpdate: false,
+        inferenceIds: [defaultInferenceEndpoints.ELSER],
+      });
+      expect(http.post).toHaveBeenCalledTimes(1);
+      expect(http.post).toHaveBeenCalledWith(UPDATE_ALL_API_PATH, {
+        body: JSON.stringify({
+          forceUpdate: false,
+          inferenceIds: [defaultInferenceEndpoints.ELSER],
+        }),
+      });
+    });
+
+    it('returns the value from the server', async () => {
+      const expected = {
+        '.elser-2-elasticsearch': {
+          installing: true,
+        },
+        '.multilingual-e5-small-elasticsearch': {
+          installing: true,
+        },
+      };
+      http.post.mockResolvedValue(expected);
+
+      const response = await service.updateAll();
+      expect(response).toEqual(expected);
+    });
+  });
+
   describe('#uninstall', () => {
     it('calls the endpoint with the right parameters', async () => {
       await service.uninstall({ inferenceId });

x-pack/platform/plugins/shared/ai_infra/product_doc_base/public/services/installation/installation_service.ts

@@ -10,12 +10,14 @@ import { defaultInferenceEndpoints } from '@kbn/inference-common';
 import type {
   InstallationStatusResponse,
   PerformInstallResponse,
+  PerformUpdateResponse,
   UninstallResponse,
 } from '../../../common/http_api/installation';
 import {
   INSTALLATION_STATUS_API_PATH,
   INSTALL_ALL_API_PATH,
   UNINSTALL_ALL_API_PATH,
+  UPDATE_ALL_API_PATH,
 } from '../../../common/http_api/installation';
 
 export class InstallationService {
@@ -44,7 +46,7 @@ export class InstallationService {
       body: JSON.stringify({ inferenceId }),
     });
 
-    if (!response.installed) {
+    if (!response?.installed) {
       throw new Error(
         `Installation did not complete successfully.${
           response.failureReason ? `\n${response.failureReason}` : ''
@@ -63,4 +65,24 @@ export class InstallationService {
 
     return response;
   }
+
+  /**
+   * Update all product documentation to the latest version.
+   *
+   * @param forceUpdate - If true, the docs with the same version majorMinor version will be forced to updated regardless
+   * @param inferenceIds - If provided, only the product docs for the given inference IDs will be updated. If not, all previously installed inference IDs will be updated.
+   * @returns
+   */
+  async updateAll(params?: {
+    forceUpdate?: boolean;
+    inferenceIds?: string[];
+  }): Promise<PerformUpdateResponse> {
+    const forceUpdate = params?.forceUpdate ?? false;
+    const inferenceIds = params?.inferenceIds ?? [];
+    const response = await this.http.post<PerformUpdateResponse>(UPDATE_ALL_API_PATH, {
+      body: JSON.stringify({ forceUpdate, ...(inferenceIds.length > 0 ? { inferenceIds } : {}) }),
+    });
+
+    return response;
+  }
 }

x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.test.ts

@@ -50,6 +50,7 @@ describe('ProductDocBasePlugin', () => {
       update: jest.fn().mockResolvedValue({}),
       uninstall: jest.fn().mockResolvedValue({}),
       getStatus: jest.fn().mockResolvedValue({}),
+      getStatuses: jest.fn().mockResolvedValue({}),
       updateAll: jest.fn().mockResolvedValue({}),
     });
   });
@@ -89,6 +90,7 @@ describe('ProductDocBasePlugin', () => {
       expect(startContract).toEqual({
         management: {
           getStatus: expect.any(Function),
+          getStatuses: expect.any(Function),
           install: expect.any(Function),
           uninstall: expect.any(Function),
           update: expect.any(Function),

x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.ts

@@ -112,7 +112,6 @@ export class ProductDocBasePlugin
       licensing,
       taskManager,
     };
-
     documentationManager.updateAll().catch((err) => {
       this.logger.error(`Error scheduling product documentation updateAll task: ${err.message}`);
     });
@@ -123,6 +122,7 @@ export class ProductDocBasePlugin
         updateAll: documentationManager.updateAll.bind(documentationManager),
         uninstall: documentationManager.uninstall.bind(documentationManager),
         getStatus: documentationManager.getStatus.bind(documentationManager),
+        getStatuses: documentationManager.getStatuses.bind(documentationManager),
       },
       search: searchService.search.bind(searchService),
     };

x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/routes/installation.ts

@@ -12,15 +12,16 @@ import { defaultInferenceEndpoints } from '@kbn/inference-common';
 import type {
   InstallationStatusResponse,
   PerformInstallResponse,
+  PerformUpdateResponse,
   UninstallResponse,
 } from '../../common/http_api/installation';
 import {
   INSTALLATION_STATUS_API_PATH,
   INSTALL_ALL_API_PATH,
   UNINSTALL_ALL_API_PATH,
+  UPDATE_ALL_API_PATH,
 } from '../../common/http_api/installation';
 import type { InternalServices } from '../types';
-import type { ProductInstallState } from '../../common/install_status';
 
 export const registerInstallationRoutes = ({
   router,
@@ -104,10 +105,8 @@ export const registerInstallationRoutes = ({
       let failureReason = null;
       if (status === 'error' && installStatus) {
         failureReason = Object.values(installStatus)
-          .filter(
-            (product: ProductInstallState) => product.status === 'error' && product.failureReason
-          )
-          .map((product: ProductInstallState) => product.failureReason)
+          .filter((product) => product.status === 'error' && product.failureReason)
+          .map((product) => product.failureReason)
           .join('\n');
       }
       return res.ok<PerformInstallResponse>({
@@ -119,6 +118,46 @@ export const registerInstallationRoutes = ({
     }
   );
 
+  router.post(
+    {
+      path: UPDATE_ALL_API_PATH,
+      validate: {
+        body: schema.object({
+          forceUpdate: schema.boolean({ defaultValue: false }),
+          inferenceIds: schema.maybe(schema.arrayOf(schema.string())),
+        }),
+      },
+      options: {
+        access: 'internal',
+        timeout: { idleSocket: 20 * 60 * 1000 }, // install can take time.
+      },
+      security: {
+        authz: {
+          requiredPrivileges: [ApiPrivileges.manage('llm_product_doc')],
+        },
+      },
+    },
+    async (ctx, req, res) => {
+      const { forceUpdate } = req.body ?? {};
+
+      const { documentationManager } = getServices();
+
+      const updated = await documentationManager.updateAll({
+        request: req,
+        forceUpdate,
+        // If inferenceIds is provided, use it, otherwise use all previously installed inference IDs
+        inferenceIds: req.body.inferenceIds ?? [],
+      });
+
+      // check status after installation in case of failure
+      const statuses: Record<string, PerformUpdateResponse> =
+        await documentationManager.getStatuses({ inferenceIds: updated.inferenceIds });
+      return res.ok<Record<string, PerformUpdateResponse>>({
+        body: statuses,
+      });
+    }
+  );
+
   router.post(
     {
       path: UNINSTALL_ALL_API_PATH,

x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/doc_manager.test.ts

@@ -212,6 +212,35 @@ describe('DocumentationManager', () => {
     });
   });
 
+  describe('#updateAll', () => {
+    beforeEach(() => {
+      getTaskStatusMock.mockResolvedValue('not_scheduled');
+
+      docInstallClient.getInstallationStatus.mockResolvedValue({
+        kibana: { status: 'uninstalled' },
+      } as Awaited<ReturnType<ProductDocInstallClient['getInstallationStatus']>>);
+    });
+
+    it('calls `scheduleEnsureUpToDateTask` for each inferenceId', async () => {
+      await docManager.updateAll();
+
+      expect(scheduleEnsureUpToDateTaskMock).toHaveBeenCalledTimes(2);
+      expect(scheduleEnsureUpToDateTaskMock).toHaveBeenCalledWith({
+        taskManager,
+        logger,
+        inferenceId: defaultInferenceEndpoints.MULTILINGUAL_E5_SMALL,
+      });
+
+      expect(scheduleEnsureUpToDateTaskMock).toHaveBeenCalledWith({
+        taskManager,
+        logger,
+        inferenceId: defaultInferenceEndpoints.ELSER,
+      });
+
+      expect(waitUntilTaskCompletedMock).not.toHaveBeenCalled();
+    });
+  });
+
   describe('#uninstall', () => {
     beforeEach(() => {
       getTaskStatusMock.mockResolvedValue('not_scheduled');