diff --git a/.claude/skills/jtbd-map/jtbd-toc-mapping.tsv b/.claude/skills/jtbd-map/jtbd-toc-mapping.tsv index 5c1193277d22..c29dba96cfa6 100644 --- a/.claude/skills/jtbd-map/jtbd-toc-mapping.tsv +++ b/.claude/skills/jtbd-map/jtbd-toc-mapping.tsv @@ -1,207 +1,205 @@ Category (L1) Level 2 (Jobs) Level 3 (Jobs or Topics) Level 4 (Jobs or Topics) Topic (H2) H3 Full .adoc file path Is a job? Navtitle What's new FALSE - Release notes for OpenShift Lightspeed release_notes/ols-release-notes.adoc TRUE Release notes for OpenShift Lightspeed - OpenShift Lightspeed 1.1.2 modules/ols-1-1-2-release-notes.adoc FALSE OpenShift Lightspeed 1.1.2 - OpenShift Lightspeed 1.1.1 modules/ols-1-1-1-release-notes.adoc FALSE OpenShift Lightspeed 1.1.1 - Fixed security issues modules/ols-fixed-security-issues.adoc FALSE Fixed security issues - OpenShift Lightspeed 1.1 modules/ols-1-1-release-notes.adoc FALSE OpenShift Lightspeed 1.1 - OpenShift Lightspeed 1.0 modules/ols-1-0-release-notes.adoc FALSE OpenShift Lightspeed 1.0 - Known issues modules/ols-1-0-known-issues.adoc FALSE Known issues + Release notes for OpenShift Lightspeed release_notes/ols-release-notes.adoc TRUE Release notes + OpenShift Lightspeed 1.1.2 modules/ols-1-1-2-release-notes.adoc FALSE + OpenShift Lightspeed 1.1.1 modules/ols-1-1-1-release-notes.adoc FALSE + Fixed security issues modules/ols-fixed-security-issues.adoc FALSE + OpenShift Lightspeed 1.1 modules/ols-1-1-release-notes.adoc FALSE Discover FALSE - Evaluate OpenShift Lightspeed capabilities discover/ols-evaluate-openshift-lightspeed-capabilities.adoc TRUE Evaluate OpenShift Lightspeed capabilities - Gain AI assistance with cluster management modules/ols-openshift-lightspeed-overview.adoc FALSE Gain AI assistance with cluster management - How you can interact with the assistant modules/ols-con-supported-interfaces.adoc FALSE How you can interact with the assistant - What product and documentation OpenShift Lightspeed covers modules/ols-about-product-coverage.adoc FALSE What product and documentation OpenShift Lightspeed covers - What OpenShift Lightspeed does not cover modules/ols-about-product-coverage.adoc FALSE What OpenShift Lightspeed does not cover - Evaluate data privacy and compliance posture discover/ols-evaluate-data-privacy-compliance.adoc TRUE Evaluate data privacy and compliance posture - How your data is used and protected modules/ols-about-data-use.adoc FALSE How your data is used and protected - What data, telemetry, and transcripts are collected modules/ols-about-data-telemetry-transcript-and-feedback-collection.adoc FALSE What data, telemetry, and transcripts are collected - How system health data is collected and reported modules/ols-remote-health-monitoring-overview.adoc FALSE How system health data is collected and reported - How chat transcripts are collected modules/ols-transcript-collection-overview.adoc FALSE How chat transcripts are collected - How user feedback is collected modules/ols-feedback-collection-overview.adoc FALSE How user feedback is collected + Evaluate OpenShift Lightspeed capabilities discover/ols-evaluate-openshift-lightspeed-capabilities.adoc TRUE Evaluate capabilities + Gain assistance with cluster management modules/ols-openshift-lightspeed-overview.adoc FALSE AI-assisted cluster management + How you can interact with the assistant modules/ols-con-supported-interfaces.adoc FALSE + What product and documentation OpenShift Lightspeed covers modules/ols-about-product-coverage.adoc FALSE + What OpenShift Lightspeed does not cover modules/ols-about-product-coverage.adoc FALSE + Evaluate data privacy and compliance posture discover/ols-evaluate-data-privacy-compliance.adoc TRUE Data privacy and compliance + How your data is used and protected modules/ols-about-data-use.adoc FALSE Data use and protection + What data, telemetry, and transcripts are collected modules/ols-about-data-telemetry-transcript-and-feedback-collection.adoc FALSE Data and telemetry + How system health data is collected and reported modules/ols-remote-health-monitoring-overview.adoc FALSE System health reporting + How chat transcripts are collected modules/ols-transcript-collection-overview.adoc FALSE Chat transcripts + How user feedback is collected modules/ols-feedback-collection-overview.adoc FALSE User feedback FALSE - Additional resources modules/additional-resources.adoc FALSE Additional resources + Additional resources modules/additional-resources.adoc FALSE Plan FALSE Plan the OpenShift Lightspeed deployment architecture plan/ols-plan-deployment-architecture.adoc TRUE Plan the deployment architecture - Verify version compatibility for OpenShift Lightspeed https://access.redhat.com/support/policy/updates/openshift_operators FALSE Verify version compatibility - What your OpenShift cluster requires modules/ols-openshift-requirements.adoc FALSE What your OpenShift cluster requires - How to size cluster resources for capacity planning modules/ols-minimum-cluster-resource-requirements.adoc FALSE How to size cluster resources for capacity planning - What subscriptions you need before installing modules/ols-about-subscription-requirements.adoc FALSE What subscriptions you need before installing - How FIPS compliance is supported in secure environments modules/ols-openshift-lightspeed-fips-support.adoc FALSE How FIPS compliance is supported in secure environments - Which CPU architectures are supported modules/ols-supported-platforms.adoc FALSE Which CPU architectures are supported - How to run on restricted networks without external access modules/ols-about-running-openshift-lightspeed-in-disconnected-mode.adoc FALSE How to run on restricted networks without external access + What your OpenShift cluster requires modules/ols-openshift-requirements.adoc FALSE Cluster requirements + + How to size cluster resources for capacity planning modules/ols-minimum-cluster-resource-requirements.adoc FALSE Size cluster resources + Supported product subscriptions modules/ols-about-subscription-requirements.adoc FALSE + How FIPS compliance is supported in secure environments modules/ols-openshift-lightspeed-fips-support.adoc FALSE FIPS compliance + Supported CPU architectures modules/ols-supported-platforms.adoc FALSE + How to run on restricted networks without external access modules/ols-about-running-openshift-lightspeed-in-disconnected-mode.adoc FALSE Disconnected environments Install FALSE - Install OpenShift Lightspeed on OpenShift Container Platform install/ols-installing-openshift-lightspeed.adoc TRUE Install on OpenShift Container Platform - FALSE - Install the OpenShift Lightspeed Operator from the OperatorHub modules/ols-installing-operator-from-operatorhub.adoc FALSE Install the Operator from the OperatorHub - Install the OpenShift Lightspeed Operator from the software catalog modules/ols-installing-operator-from-software-catalog.adoc FALSE Install the Operator from the software catalog + Install OpenShift Lightspeed on OpenShift Container Platform install/ols-installing-openshift-lightspeed.adoc TRUE Installation + Install the OpenShift Lightspeed Operator from the OperatorHub modules/ols-installing-operator-from-operatorhub.adoc FALSE Install from OperatorHub + Install the OpenShift Lightspeed Operator from the software catalog modules/ols-installing-operator-from-software-catalog.adoc FALSE Install from software catalog Integrate FALSE Integrate OpenShift Lightspeed with LLMs integrate/ols-integrate-with-llms.adoc TRUE Integrate with LLMs Integrate OpenShift Lightspeed with IBM watsonx integrate/ols-integrate-ibm-watsonx.adoc FALSE Integrate with IBM watsonx - What IBM watsonx requires for integration modules/ols-large-language-model-requirements.adoc FALSE What IBM watsonx requires for integration - Prepare your IBM watsonx environment modules/ols-large-language-model-overview.adoc FALSE Prepare your IBM watsonx environment - Create the IBM watsonx credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the IBM watsonx credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for IBM watsonx modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for IBM watsonx - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + What IBM watsonx requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-watsonx.adoc FALSE + Prepare your IBM watsonx environment jtbd-aem-conversion/integrate/ols-large-language-model-overview-watsonx.adoc FALSE + Create the IBM watsonx credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-watsonx.adoc FALSE + Create the IBM watsonx credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-watsonx.adoc FALSE + Create the custom resource for IBM watsonx jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-watsonx.adoc FALSE + Create the custom resource for IBM watsonx jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-watsonx.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-watsonx.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-watsonx.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-watsonx.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-watsonx.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with OpenAI integrate/ols-integrate-openai.adoc FALSE Integrate with OpenAI - What OpenAI requires for integration modules/ols-large-language-model-requirements.adoc FALSE What OpenAI requires for integration - Prepare your OpenAI environment modules/ols-large-language-model-overview.adoc FALSE Prepare your OpenAI environment - Create an OpenAI API key modules/ols-configuring-openai-using-an-api-key.adoc FALSE Create an OpenAI API key - Create the OpenAI credentials secret (API key) modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the OpenAI credentials secret (API key) - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - How OpenShift AI vLLm serving runtime works modules/ols-about-openshift-ai-vllm.adoc FALSE How OpenShift AI vLLm serving runtime works - Create the OpenAI credentials secret (Projects) modules/ols-configuring-openai-using-projects.adoc FALSE Create the OpenAI credentials secret (Projects) - Create the custom resource for OpenAI modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for OpenAI - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + What OpenAI requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openai.adoc FALSE + Prepare your OpenAI environment jtbd-aem-conversion/integrate/ols-large-language-model-overview-openai.adoc FALSE + Prepare your OpenAI environment modules/ols-configuring-openai-using-an-api-key.adoc FALSE + Create the OpenAI credentials secret (API key) jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openai.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openai.adoc FALSE + How OpenShift AI vLLm serving runtime works modules/ols-about-openshift-ai-vllm.adoc FALSE + Create the OpenAI credentials secret (Projects) modules/ols-configuring-openai-using-projects.adoc FALSE + Create the custom resource for OpenAI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openai.adoc FALSE + Create the custom resource for OpenAI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openai.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openai.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openai.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openai.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openai.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with Microsoft Azure OpenAI integrate/ols-integrate-microsoft-azure-openai.adoc FALSE Integrate with Microsoft Azure OpenAI - What Microsoft Azure OpenAI requires for integration modules/ols-large-language-model-requirements.adoc FALSE What Microsoft Azure OpenAI requires for integration - Prepare your Microsoft Azure OpenAI environment modules/ols-large-language-model-overview.adoc FALSE Prepare your Microsoft Azure OpenAI environment - Create the Microsoft Azure OpenAI credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the Microsoft Azure OpenAI credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for Microsoft Azure OpenAI modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for Microsoft Azure OpenAI - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + What Microsoft Azure OpenAI requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-azure-openai.adoc FALSE + Prepare your Microsoft Azure OpenAI environment jtbd-aem-conversion/integrate/ols-large-language-model-overview-azure-openai.adoc FALSE + Create the Microsoft Azure OpenAI credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-azure-openai.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-azure-openai.adoc FALSE + Create the custom resource for Microsoft Azure OpenAI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-azure-openai.adoc FALSE + Create the custom resource for Microsoft Azure OpenAI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-azure-openai.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-azure-openai.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-azure-openai.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-azure-openai.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-azure-openai.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with Red Hat Enterprise Linux AI integrate/ols-integrate-rhelai.adoc FALSE Integrate with Red Hat Enterprise Linux AI - What Red Hat Enterprise Linux AI requires for integration modules/ols-large-language-model-requirements.adoc FALSE What Red Hat Enterprise Linux AI requires for integration - Prepare your Red Hat Enterprise Linux AI environment modules/ols-large-language-model-overview.adoc FALSE Prepare your Red Hat Enterprise Linux AI environment - Create the RHELAI credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the RHELAI credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for Red Hat Enterprise Linux AI modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for Red Hat Enterprise Linux AI - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + What Red Hat Enterprise Linux AI requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-rhelai.adoc FALSE + Prepare your Red Hat Enterprise Linux AI environment jtbd-aem-conversion/integrate/ols-large-language-model-overview-rhelai.adoc FALSE + Create the RHELAI credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-rhelai.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-rhelai.adoc FALSE + Create the custom resource for Red Hat Enterprise Linux AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-rhelai.adoc FALSE + Create the custom resource for Red Hat Enterprise Linux AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-rhelai.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-rhelai.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-rhelai.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-rhelai.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-rhelai.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with Red Hat OpenShift AI integrate/ols-integrate-openshift-ai.adoc FALSE Integrate with Red Hat OpenShift AI - What Red Hat OpenShift AI requires for integration modules/ols-large-language-model-requirements.adoc FALSE What Red Hat OpenShift AI requires for integration - Prepare your Red Hat OpenShift AI environment modules/ols-large-language-model-overview.adoc FALSE Prepare your Red Hat OpenShift AI environment - Create the OpenShift AI credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the OpenShift AI credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for Red Hat OpenShift AI modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for Red Hat OpenShift AI - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + What Red Hat OpenShift AI requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openshift-ai.adoc FALSE + Prepare your Red Hat OpenShift AI environment jtbd-aem-conversion/integrate/ols-large-language-model-overview-openshift-ai.adoc FALSE + Create the OpenShift AI credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openshift-ai.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openshift-ai.adoc FALSE + Create the custom resource for Red Hat OpenShift AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openshift-ai.adoc FALSE + Create the custom resource for Red Hat OpenShift AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openshift-ai.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openshift-ai.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openshift-ai.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openshift-ai.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openshift-ai.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with Google Vertex AI integrate/ols-integrate-google-vertex-ai.adoc FALSE Integrate with Google Vertex AI - Which Google Vertex AI provider types are supported modules/ols-configuring-ref-google-vertex-ai-provider-types.adoc FALSE Which Google Vertex AI provider types are supported - Prepare and configure your Google Vertex AI environment modules/ols-configuring-proc-configuring-google-vertex-ai.adoc FALSE Prepare and configure your Google Vertex AI environment - Create the Google Vertex AI credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the Google Vertex AI credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for Google Vertex AI modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for Google Vertex AI - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - How the OLSConfig custom resource is structured for Google Vertex AI modules/ols-configuring-ref-olsconfig-google-vertex-fields.adoc FALSE How the OLSConfig custom resource is structured for Google Vertex AI - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment + Which Google Vertex AI provider types are supported modules/ols-configuring-ref-google-vertex-ai-provider-types.adoc FALSE + Prepare and configure your Google Vertex AI environment modules/ols-configuring-proc-configuring-google-vertex-ai.adoc FALSE + Create the Google Vertex AI credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-google-vertex-ai.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-google-vertex-ai.adoc FALSE + Create the custom resource for Google Vertex AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-google-vertex-ai.adoc FALSE + Create the custom resource for Google Vertex AI jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-google-vertex-ai.adoc FALSE + How the OLSConfig custom resource is structured for Google Vertex AI modules/ols-configuring-ref-olsconfig-google-vertex-fields.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-google-vertex-ai.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-google-vertex-ai.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-google-vertex-ai.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-google-vertex-ai.adoc FALSE Verify the deployment Integrate OpenShift Lightspeed with AWS Bedrock integrate/ols-integrate-aws-bedrock.adoc FALSE Integrate with AWS Bedrock - What AWS Bedrock requires for integration modules/ols-large-language-model-requirements.adoc FALSE What AWS Bedrock requires for integration - Which AWS Bedrock authentication methods are supported modules/ols-con-aws-bedrock-authentication-types.adoc FALSE Which AWS Bedrock authentication methods are supported - Prepare and configure your AWS Bedrock environment modules/ols-proc-configuring-aws-bedrock.adoc FALSE Prepare and configure your AWS Bedrock environment - Create the AWS Bedrock credentials secret modules/ols-creating-the-credentials-secret-using-web-console.adoc FALSE Create the AWS Bedrock credentials secret - Create the credentials secret by using the CLI modules/ols-creating-the-credentials-secret-using-cli.adoc FALSE Create the credentials secret by using the CLI - Create the custom resource for AWS Bedrock modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc FALSE Create the custom resource for AWS Bedrock - Create the custom resource file by using the CLI modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc FALSE Create the custom resource file by using the CLI - How the OLSConfig custom resource is structured for AWS Bedrock modules/ols-ref-olsconfig-aws-bedrock-fields.adoc FALSE How the OLSConfig custom resource is structured for AWS Bedrock - Configure custom TLS certificates modules/ols-configuring-custom-tls-certificates.adoc FALSE Configure custom TLS certificates - Configure trusted-ca certificates for LLM providers modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc FALSE Configure trusted-ca certificates for LLM providers - Configure a trusted CA certificate for the LLM modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc FALSE Configure a trusted CA certificate for the LLM - Verify the OpenShift Lightspeed deployment modules/ols-verifying-openshift-lightspeed-deployment.adoc FALSE Verify the OpenShift Lightspeed deployment - Extend the Service with live cluster data and external tools integrate/ols-extend-ai-with-cluster-data.adoc TRUE Extend the Service with live cluster data and external tools - How OpenShift Lightspeed accesses live cluster state modules/ols-about-cluster-interaction.adoc FALSE How the AI accesses live cluster state - Disable cluster interaction modules/ols-disabling-cluster-interaction.adoc FALSE Disable cluster interaction - Enable a custom MCP server modules/ols-enabling-custom-mcp-server.adoc FALSE Enable a custom MCP server - How authentication works for cluster introspection modules/ols-con-authentication-flow-for-cluster-introspection.adoc FALSE How authentication works for cluster introspection - Govern with operations OpenShift Lightspeed performs autonomously integrate/ols-govern-ai-operations.adoc TRUE Govern autonomous OpenShift Lightspeed operations - How OpenShift Lightspeed selects which tools to invoke modules/ols-about-query-based-tool-filtering.adoc FALSE How the AI selects which tools to invoke - Enable query-based tool filtering modules/ols-enabling-query-based-tool-filtering.adoc FALSE Enable query-based tool filtering - How manual approval gates protect critical operations modules/ols-about-operation-approvals.adoc FALSE How manual approval gates protect critical operations - Configure tool execution approval policies modules/ols-ref-tools-approval-configuration.adoc FALSE Configure tool execution approval policies + What AWS Bedrock requires for integration jtbd-aem-conversion/integrate/ols-large-language-model-requirements-aws-bedrock.adoc FALSE + Which AWS Bedrock authentication methods are supported modules/ols-con-aws-bedrock-authentication-types.adoc FALSE + Prepare and configure your AWS Bedrock environment modules/ols-proc-configuring-aws-bedrock.adoc FALSE + Create the AWS Bedrock credentials secret jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-aws-bedrock.adoc FALSE + jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-aws-bedrock.adoc FALSE + Create the custom resource for AWS Bedrock jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-aws-bedrock.adoc FALSE + Create the custom resource for AWS Bedrock jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-aws-bedrock.adoc FALSE + How the OLSConfig custom resource is structured for AWS Bedrock modules/ols-ref-olsconfig-aws-bedrock-fields.adoc FALSE + Configure custom TLS certificates jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-aws-bedrock.adoc FALSE + Configure trusted-ca certificates for LLM providers jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-aws-bedrock.adoc FALSE + Configure a trusted CA certificate for the LLM jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-aws-bedrock.adoc FALSE + Verify the OpenShift Lightspeed deployment jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-aws-bedrock.adoc FALSE Verify the deployment + Extend the Service with live cluster data and external tools integrate/ols-extend-ai-with-cluster-data.adoc TRUE Cluster data and external tools + How OpenShift Lightspeed accesses live cluster state modules/ols-about-cluster-interaction.adoc FALSE Live cluster access + Disable cluster interaction modules/ols-disabling-cluster-interaction.adoc FALSE + Enable a custom MCP server modules/ols-enabling-custom-mcp-server.adoc FALSE + How authentication works for cluster introspection modules/ols-con-authentication-flow-for-cluster-introspection.adoc FALSE + Govern autonomous cluster operations integrate/ols-govern-ai-operations.adoc TRUE Autonomous operations governance + How OpenShift Lightspeed selects which tools to select modules/ols-about-query-based-tool-filtering.adoc FALSE Tools to select + Enable query-based tool filtering modules/ols-enabling-query-based-tool-filtering.adoc FALSE + How manual approval gates protect critical operations modules/ols-about-operation-approvals.adoc FALSE + Configure tool execution approval policies modules/ols-ref-tools-approval-configuration.adoc FALSE Get Started FALSE Interact with OpenShift Lightspeed get_started/ols-interact-with-ai-assistant.adoc TRUE Interact with OpenShift Lightspeed - Ask your first question in the chat window modules/ols-initiating-chat-using-chat-window.adoc FALSE Ask your first question in the chat window - How conversations and context history work modules/ols-about-lightspeed-conversations.adoc FALSE How conversations and context history work + Ask your first question in the chat window modules/ols-initiating-chat-using-chat-window.adoc FALSE First question + How conversations and context history work modules/ols-about-lightspeed-conversations.adoc FALSE Conversations and context history Sample conversations modules/ols-sample-dialogs-overview.adoc FALSE - Find OpenShift product documentation by using OpenShift Lightspeed modules/ols-asking-general-information.adoc FALSE Find OpenShift product documentation - Refine answers with follow-up questions modules/ols-asking-related-questions.adoc FALSE Refine answers with follow-up questions - Improve OpenShift Lightspeed accuracy by submitting response feedback get_started/ols-improve-ai-accuracy-with-feedback.adoc TRUE Improve accuracy with feedback - Submit chat response quality feedback modules/ols-providing-feedback-for-conversation.adoc FALSE Submit chat response quality feedback - Start a new chat conversation modules/ols-starting-a-new-chat.adoc FALSE Start a new chat conversation + Gets answers from OpenShift Lightspeed product documentation modules/ols-asking-general-information.adoc FALSE Find answers from product documentation + Refine answers with follow-up questions modules/ols-asking-related-questions.adoc FALSE Refine answers + Improve response accuracy with feedback get_started/ols-improve-ai-accuracy-with-feedback.adoc TRUE Response feedback + Submit chat response quality feedback modules/ols-providing-feedback-for-conversation.adoc FALSE Submit feedback + Start a new chat conversation modules/ols-starting-a-new-chat.adoc FALSE New conversation Troubleshoot cluster issues using OpenShift Lightspeed get_started/ols-troubleshoot-cluster-issues.adoc TRUE Troubleshoot cluster issues Provide operational context by attaching cluster resource objects modules/ols-attaching-a-resource-object-to-your-query.adoc FALSE Attach cluster resource objects Analyze and remediate active cluster alerts modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc FALSE Analyze and remediate active cluster alerts Configure FALSE - Enable external access to the OpenShift Lightspeed Service configure/ols-enable-external-access-to-the-service.adoc TRUE Enable external access to the Service - Use a route to enable the OpenShift Lightspeed Service modules/ols-proc-expose-the-ols-service-by-using-a-route.adoc FALSE Expose the Service using a route - Maintain conversation consistency configure/ols-configure-persistent-cache-storage.adoc TRUE Configure persistent cache storage - How conversation history is retained across sessions modules/ols-about-postgresql-persistence.adoc FALSE How conversation history is retained across sessions - Enable PostgreSQL persistence modules/ols-enabling-postgresql-persistence.adoc FALSE Enable PostgreSQL persistence - Override default Persistent Volume Claim (PVC) specifications modules/ols-overriding-default-persistent-volume-claim-specifications.adoc FALSE Override default PVC specifications - Enhance responses with your documentation configure/ols-enhance-ai-responses-with-custom-knowledge.adoc TRUE Enhance responses with your documentation - How the Offline Knowledge portal retrieves documentation modules/ols-about-the-offline-knowledge-portal.adoc FALSE How the Offline Knowledge Portal retrieves documentation - How custom documentation extends AI answers modules/ols-about-the-byo-knowledge-tool.adoc FALSE How custom documentation extends AI answers - How document titles and URLs appear in AI responses modules/ols-about-document-title-and-url.adoc FALSE How document titles and URLs appear in AI responses + Enable external access to the OpenShift Lightspeed Service configure/ols-enable-external-access-to-the-service.adoc TRUE External access + Use a route to enable the OpenShift Lightspeed Service modules/ols-proc-expose-the-ols-service-by-using-a-route.adoc FALSE Use a route to enable the Service + Maintain conversation consistency configure/ols-configure-persistent-cache-storage.adoc TRUE Conversation persistence + How conversation history is retained across sessions modules/ols-about-postgresql-persistence.adoc FALSE + Enable PostgreSQL persistence modules/ols-enabling-postgresql-persistence.adoc FALSE + Override default Persistent Volume Claim (PVC) specifications modules/ols-overriding-default-persistent-volume-claim-specifications.adoc FALSE Override default PVC specifications + Enhance responses with your documentation configure/ols-enhance-ai-responses-with-custom-knowledge.adoc TRUE Custom documentation + How the Offline Knowledge portal retrieves documentation modules/ols-about-the-offline-knowledge-portal.adoc FALSE + How custom documentation extends OpenShift Lightspeed answers modules/ols-about-the-byo-knowledge-tool.adoc FALSE How custom documentation extends answers + How document titles and URLs appear in OpenShift Lightspeed responses modules/ols-about-document-title-and-url.adoc FALSE How document titles and URLs appear in responses Provide custom knowledge to the LLM modules/ols-providing-custom-knowledge-to-the-llm.adoc FALSE Provide custom knowledge to the LLM Disable the default documentation retrieval database modules/ols-disabling-ocp-documentation-rag-database.adoc FALSE Disable the default documentation retrieval database Control infrastructure costs using token quotas configure/ols-control-costs-with-token-quotas.adoc TRUE Control costs with token quotas - How resource consumption is managed and capped modules/ols-tokens-and-token-quota-limits.adoc FALSE How resource consumption is managed and capped - Activate token quota limits modules/ols-activating-token-quota-limits.adoc FALSE Activate token quota limits - Configure audit logging and distributed tracing configure/ols-configure-audit-logging-tracing.adoc TRUE Configure audit logging and tracing - How the OpenTelemetry Collector handles audit and trace data modules/ols-about-the-opentelemetry-collector.adoc FALSE How the OpenTelemetry Collector handles audit and trace data - modules/ols-configure-audit-logging-tracing.adoc FALSE + How resource consumption is managed and capped modules/ols-tokens-and-token-quota-limits.adoc FALSE Resource consumption + Activate token quota limits modules/ols-activating-token-quota-limits.adoc FALSE + Configure audit logging and distributed tracing configure/ols-configure-audit-logging-tracing.adoc TRUE Audit logging and tracing + How the OpenTelemetry Collector handles audit and trace data modules/ols-about-the-opentelemetry-collector.adoc FALSE + modules/ols-configure-audit-logging-tracing.adoc FALSE Secure FALSE - Protect user privacy by filtering sensitive data secure/ols-protect-user-privacy.adoc TRUE Protect user privacy + Protect user privacy by filtering sensitive data secure/ols-protect-user-privacy.adoc TRUE Privacy and data filtering Filter and redact sensitive information modules/ols-filtering-and-redacting-information.adoc FALSE Filter and redact sensitive information - Disable data collection for the OpenShift Lightspeed Service modules/ols-disabling-data-collection-operator.adoc FALSE Disable data collection for the Service - Configure authentication and access control secure/ols-configure-authentication-access-control.adoc TRUE Configure authentication and access control + Disable data collection for the OpenShift Lightspeed Service modules/ols-disabling-data-collection-operator.adoc FALSE Disable data collection +Administer FALSE + Configure authentication and access control secure/ols-configure-authentication-access-control.adoc TRUE Authentication and access control Role-based access control (RBAC) framework for OpenShift Lightspeed modules/ols-about-lightspeed-and-role-based-access-control.adoc FALSE RBAC framework for OpenShift Lightspeed - Grant user access using the CLI modules/ols-granting-a-user-access-by-using-the-cli.adoc FALSE Grant user access using the CLI + Grant user access using the CLI modules/ols-granting-a-user-access-by-using-the-cli.adoc FALSE Grant user access using a YAML configuration file modules/ols-granting-a-user-access-by-using-yaml-configuration-file.adoc FALSE Grant user access using YAML - Grant user group access using the CLI modules/ols-granting-user-group-access-by-using-cli.adoc FALSE Grant user group access using the CLI + Grant user group access using the CLI modules/ols-granting-user-group-access-by-using-cli.adoc FALSE Grant user group access using a YAML configuration file modules/ols-granting-user-group-access-by-using-configuration-file.adoc FALSE Grant user group access using YAML - Grant access to an individual user modules/ols-granting-access-to-individual-users.adoc FALSE Grant access to an individual user + Grant access to an individual user modules/ols-granting-access-to-individual-users.adoc FALSE Obtain an authentication token for the OpenShift Lightspeed API modules/ols-obtain-lightspeed-authentication-token.adoc FALSE Obtain an authentication token - REST API authentication modules configure/olsconfigure-rest-api-authentication-configuration.adoc FALSE REST API authentication modules - Configure REST API authentication modules modules/ols-ref-rest-api-authentication-configurations.adoc FALSE Configure REST API authentication modules + Define how authentication is enforced configure/olsconfigure-rest-api-authentication-configuration.adoc FALSE Authentication enforcement + Configure REST API authentication modules modules/ols-ref-rest-api-authentication-configurations.adoc FALSE Develop FALSE Build API integrations with OpenShift Lightspeed develop/ols-build-api-integrations.adoc TRUE Build API integrations - Authenticate programmatic API requests modules/ols-authenticate-api-requests.adoc FALSE Authenticate programmatic API requests - Authenticate proxy calls for MCP servers modules/ols-provide-authentication-mcp-server.adoc FALSE Authenticate proxy calls for MCP servers - Connect external automation tools to the REST API modules/ols-proc-access-the-rest-api-directly.adoc FALSE Connect external automation tools to the REST API - Generate and validate authorization tokens modules/ols-proc-authenticate-with-the-api.adoc FALSE Generate and validate authorization tokens - Test and verify API endpoints with the Swagger UI modules/ols-proc-explore-the-rest-api-by-using-the-swagger-ui.adoc FALSE Test and verify API endpoints with Swagger UI + Authenticate programmatic API requests modules/ols-authenticate-api-requests.adoc FALSE + Authenticate proxy calls for MCP servers modules/ols-provide-authentication-mcp-server.adoc FALSE + Connect external automation tools to the REST API modules/ols-proc-access-the-rest-api-directly.adoc FALSE + Generate and validate authorization tokens modules/ols-proc-authenticate-with-the-api.adoc FALSE + Test and verify API endpoints with the Swagger UI modules/ols-proc-explore-the-rest-api-by-using-the-swagger-ui.adoc FALSE Update the OpenAPI schema to prevent documentation drift modules/ols-proc-regenerate-the-openapi-schema.adoc FALSE Update the OpenAPI schema - Look up API specifications and troubleshoot integration errors develop/ols-look-up-api-specifications.adoc TRUE Look up API specifications - OLSConfig API schema reference configure/olsconfigure-api.adoc FALSE OLSConfig API schema reference - OLSConfig API specifications modules/ols-olsconfig-api-specifications.adoc FALSE OLSConfig API specifications - OLSConfig field reference for Google Vertex AI modules/ols-configuring-ref-olsconfig-google-vertex-fields.adoc FALSE OLSConfig field reference for Google Vertex AI - OLSConfig field reference for AWS Bedrock modules/ols-ref-olsconfig-aws-bedrock-fields.adoc FALSE OLSConfig field reference for AWS Bedrock - Authentication requirements by API endpoint modules/ols-api-authentication-matrix.adoc FALSE Authentication requirements by API endpoint - Supported REST API endpoints and methods modules/ols-ref-api-endpoints-reference.adoc FALSE Supported REST API endpoints and methods - Schema formats for query payloads modules/ols-ref-supported-attachement-formats.adoc FALSE Schema formats for query payloads - REST API HTTP status codes and error causes modules/ols-ref-api-error-handling.adoc FALSE REST API HTTP status codes and error causes - OpenAPI specifications and local documentation endpoints modules/ols-con-openshift-lightspeed-rest-api-specifications.adoc FALSE OpenAPI specifications and local documentation endpoints + Look up API specifications and troubleshoot integration errors develop/ols-look-up-api-specifications.adoc TRUE API specifications and errors + OLSConfig API schema reference configure/olsconfigure-api.adoc FALSE + OLSConfig API specifications modules/ols-olsconfig-api-specifications.adoc FALSE + OLSConfig field reference for Google Vertex AI modules/ols-configuring-ref-olsconfig-google-vertex-fields.adoc FALSE + OLSConfig field reference for AWS Bedrock modules/ols-ref-olsconfig-aws-bedrock-fields.adoc FALSE + Authentication requirements by API endpoint modules/ols-api-authentication-matrix.adoc FALSE + Supported REST API endpoints and methods modules/ols-ref-api-endpoints-reference.adoc FALSE + Schema formats for query payloads modules/ols-ref-supported-attachement-formats.adoc FALSE + REST API HTTP status codes and error causes modules/ols-ref-api-error-handling.adoc FALSE + OpenAPI specifications and local documentation endpoints modules/ols-con-openshift-lightspeed-rest-api-specifications.adoc FALSE Troubleshoot FALSE - Troubleshoot platform installation and access troubleshoot/ols-troubleshoot-installation-access.adoc TRUE Troubleshoot installation and access + Troubleshoot platform installation and access troubleshoot/ols-troubleshoot-installation-access.adoc TRUE Installation and access issues Resolve 502 Bad Gateway errors in the interface modules/ols-502-bad-gateway-errors.adoc FALSE Resolve 502 Bad Gateway errors - Troubleshoot missing Operator in the OperatorHub modules/ols-operator-missing-from-operatorhub-list.adoc FALSE Troubleshoot missing Operator in OperatorHub - Troubleshoot API authentication failures modules/ols-troubleshoot-api-authentication-failures.adoc FALSE Troubleshoot API authentication failures - Troubleshoot rejected Google Vertex AI configurations modules/ols-ref-google-vertex-ai-configuration-resource-is-rejected.adoc FALSE Troubleshoot rejected Google Vertex AI configurations - Troubleshoot AI model responses and token limits troubleshoot/ols-troubleshoot-model-responses.adoc TRUE Troubleshoot model responses and token limits - Suppress reasoning model delineator tags modules/ols-reasoning-model-generates-delineator-prompt.adoc FALSE Suppress reasoning model delineator tags - Resolve prompt is too long errors modules/ols-proc-error-prompt-is-too-long.adoc FALSE Resolve prompt is too long errors - Resolve truncated model responses modules/ols-proc-resolving-truncated-responses.adoc FALSE Resolve truncated model responses - Resolve conversation history truncation modules/ols-proc-resolving-issues-with-conversation-history.adoc FALSE Resolve conversation history truncation + Troubleshoot missing Operator in the OperatorHub modules/ols-operator-missing-from-operatorhub-list.adoc FALSE + Troubleshoot API authentication failures modules/ols-troubleshoot-api-authentication-failures.adoc FALSE + Troubleshoot rejected Google Vertex AI configurations modules/ols-ref-google-vertex-ai-configuration-resource-is-rejected.adoc FALSE + Troubleshoot model responses and token limits troubleshoot/ols-troubleshoot-model-responses.adoc TRUE Model response issues + Suppress reasoning model delineator tags modules/ols-reasoning-model-generates-delineator-prompt.adoc FALSE + Resolve prompt is too long errors modules/ols-proc-error-prompt-is-too-long.adoc FALSE + Resolve truncated model responses modules/ols-proc-resolving-truncated-responses.adoc FALSE + Resolve conversation history truncation modules/ols-proc-resolving-issues-with-conversation-history.adoc FALSE diff --git a/jtbd-aem-conversion/get_started/con-improve-ai-accuracy-with-feedback.adoc b/jtbd-aem-conversion/get_started/con-improve-ai-accuracy-with-feedback.adoc index c238910386be..309c6328df26 100644 --- a/jtbd-aem-conversion/get_started/con-improve-ai-accuracy-with-feedback.adoc +++ b/jtbd-aem-conversion/get_started/con-improve-ai-accuracy-with-feedback.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="con-improve-ai-accuracy-with-feedback"] -= Improve OpenShift Lightspeed accuracy by submitting response feedback += Improve response accuracy with feedback [role="_abstract"] Help improve the quality of {ols-official} responses by submitting feedback on the accuracy and usefulness of AI-generated answers. Your feedback is used to refine the model's performance over time. diff --git a/jtbd-aem-conversion/integrate/con-govern-ai-operations.adoc b/jtbd-aem-conversion/integrate/con-govern-ai-operations.adoc index 806432b80644..2eb39cfad4f7 100644 --- a/jtbd-aem-conversion/integrate/con-govern-ai-operations.adoc +++ b/jtbd-aem-conversion/integrate/con-govern-ai-operations.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="con-govern-ai-operations"] -= Govern with operations OpenShift Lightspeed performs autonomously += Govern autonomous cluster operations [role="_abstract"] Control the tools and operations that {ols-official} can invoke autonomously. Configure query-based tool filtering to restrict which tools the AI can select, and set up manual approval gates to require human confirmation before critical operations execute. diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-aws-bedrock.adoc new file mode 100644 index 000000000000..5e2e06ee62e6 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-configuring-custom-tls-certificates.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-azure-openai.adoc new file mode 100644 index 000000000000..c32fc1d53ce9 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-azure-openai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-azure-openai"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-google-vertex-ai.adoc new file mode 100644 index 000000000000..a31d6b75ad69 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-google-vertex-ai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-google-vertex-ai"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openai.adoc new file mode 100644 index 000000000000..6f5aed01545b --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-openai"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openshift-ai.adoc new file mode 100644 index 000000000000..7d02506ccef2 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-openshift-ai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-openshift-ai"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-rhelai.adoc new file mode 100644 index 000000000000..1f3ad4009714 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-rhelai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-rhelai"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-watsonx.adoc new file mode 100644 index 000000000000..5bd933459948 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-custom-tls-certificates-watsonx.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-custom-tls-certificates-watsonx"] + += Configuring custom TLS certificates + +[role="_abstract"] +Use the {ocp-product-title} web console to configure custom TLS certificates for secure communication between {ols-long} and your service endpoints. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create or edit the `OLSConfig` custom resource (CR). + +* You have a large language model (LLM) provider. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSconfig` CR. + +.Procedure + +. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. + +. Select *All Projects* in the *Project* dropdown at the top of the screen. + +. Click {ols-long} Operator. + +. Click *OLSConfig*, then click the `cluster` configuration instance in the list. + +. Click the *YAML* tab. + +. Update the `OLSconfig` CR to contain the file that has the TLS secret. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + tlsConfig: + keyCertSecretRef: + name: +--- +apiVersion: v1 +data: + tls.crt: LS0tLS1CRUd... + tls.key: LS0tLS1CRUd... +kind: Secret +metadata: + name: + namespace: +---- ++ +* `spec.ols.tlsConfig.keyCertSecretRef.name` specifies the secret that has the `tls.crt` and `tls.key` file. ++ +* `apiVersion.data.tls` specifies that the name of the certificate must be `tls.crt` and the name of the key must be `tls.key`. + +. Click *Save*. + +.Verification + +. Verify that a new pod exists in the `lightspeed-app-server` deployment by running the following command: ++ +[source,terminal] +---- +$ oc get pod -n openshift-lightspeed +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-aws-bedrock.adoc new file mode 100644 index 000000000000..124751b778a4 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-azure-openai.adoc new file mode 100644 index 000000000000..3f5b91a5e025 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-azure-openai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-azure-openai"] + += Configuring {ols-long} with a trusted CA certificate for {azure-openai} + +[role="_abstract"] +Use the {ocp-product-title} web console to configure a trusted CA certificate for secure communication between {ols-long} and {azure-openai}. + +[NOTE] +==== +If the LLM provider you are using requires a trusted-ca certificate to authenticate the {ols-long} Service you must perform this procedure. If the LLM provider does not require a trusted-ca certificate to authenticate the Service, you should skip this procedure. +==== + +.Procedure + +. Copy the contents of the certificate file and paste it into a file called `caCertFileName`. + +. Create a `ConfigMap` object called `trusted-certs` by running the following command: ++ +[source,terminal] +---- +$ oc create configmap trusted-certs --from-file=caCertFileName --namespace openshift-lightspeed +---- ++ +This command returns an output similar to the following example: ++ +[source,terminal] +---- +kind: ConfigMap +apiVersion: v1 +metadata: + name: trusted-certs + namespace: openshift-lightspeed +data: + caCertFileName: | + -----BEGIN CERTIFICATE----- + . + . + . + -----END CERTIFICATE----- +---- ++ +* `data.caCertFileName` specifies the CA certificates required to connect to your LLM provider. You can include one or more certificates within this block to ensure secure communication. + +. Update the `OLSConfig` custom resource (CR) file to include the name of the `ConfigMap` object you just created. The following example uses {azure-openai} as the LLM provider. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + defaultProvider: myAzure + defaultModel: + additionalCAConfigMapRef: + name: trusted-certs +---- ++ +* `spec.ols.additionalCAConfigMapRef.name` specifies the name of `ConfigMap` object. + +. Create the custom CR by running the following command: ++ +[source,terminal] +---- +$ oc apply -f +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-google-vertex-ai.adoc new file mode 100644 index 000000000000..2efccec761f0 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-google-vertex-ai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-google-vertex-ai"] + += Configuring {ols-long} with a trusted CA certificate for Google Vertex AI + +[role="_abstract"] +Use the {ocp-product-title} web console to configure a trusted CA certificate for secure communication between {ols-long} and Google Vertex AI. + +[NOTE] +==== +If the LLM provider you are using requires a trusted-ca certificate to authenticate the {ols-long} Service you must perform this procedure. If the LLM provider does not require a trusted-ca certificate to authenticate the Service, you should skip this procedure. +==== + +.Procedure + +. Copy the contents of the certificate file and paste it into a file called `caCertFileName`. + +. Create a `ConfigMap` object called `trusted-certs` by running the following command: ++ +[source,terminal] +---- +$ oc create configmap trusted-certs --from-file=caCertFileName --namespace openshift-lightspeed +---- ++ +This command returns an output similar to the following example: ++ +[source,terminal] +---- +kind: ConfigMap +apiVersion: v1 +metadata: + name: trusted-certs + namespace: openshift-lightspeed +data: + caCertFileName: | + -----BEGIN CERTIFICATE----- + . + . + . + -----END CERTIFICATE----- +---- ++ +* `data.caCertFileName` specifies the CA certificates required to connect to your LLM provider. You can include one or more certificates within this block to ensure secure communication. + +. Update the `OLSConfig` custom resource (CR) file to include the name of the `ConfigMap` object you just created. The following example uses Google Vertex AI as the LLM provider. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + defaultProvider: google + defaultModel: gemini-2.5-flash-lite + additionalCAConfigMapRef: + name: trusted-certs +---- ++ +* `spec.ols.additionalCAConfigMapRef.name` specifies the name of `ConfigMap` object. + +. Create the custom CR by running the following command: ++ +[source,terminal] +---- +$ oc apply -f +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openai.adoc new file mode 100644 index 000000000000..903a12542c56 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openai"] + += Configuring {ols-long} with a trusted CA certificate for {openai} + +[role="_abstract"] +Use the {ocp-product-title} web console to configure a trusted CA certificate for secure communication between {ols-long} and {openai}. + +[NOTE] +==== +If the LLM provider you are using requires a trusted-ca certificate to authenticate the {ols-long} Service you must perform this procedure. If the LLM provider does not require a trusted-ca certificate to authenticate the Service, you should skip this procedure. +==== + +.Procedure + +. Copy the contents of the certificate file and paste it into a file called `caCertFileName`. + +. Create a `ConfigMap` object called `trusted-certs` by running the following command: ++ +[source,terminal] +---- +$ oc create configmap trusted-certs --from-file=caCertFileName --namespace openshift-lightspeed +---- ++ +This command returns an output similar to the following example: ++ +[source,terminal] +---- +kind: ConfigMap +apiVersion: v1 +metadata: + name: trusted-certs + namespace: openshift-lightspeed +data: + caCertFileName: | + -----BEGIN CERTIFICATE----- + . + . + . + -----END CERTIFICATE----- +---- ++ +* `data.caCertFileName` specifies the CA certificates required to connect to your LLM provider. You can include one or more certificates within this block to ensure secure communication. + +. Update the `OLSConfig` custom resource (CR) file to include the name of the `ConfigMap` object you just created. The following example uses {openai} as the LLM provider. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + defaultProvider: myOpenai + defaultModel: + additionalCAConfigMapRef: + name: trusted-certs +---- ++ +* `spec.ols.additionalCAConfigMapRef.name` specifies the name of `ConfigMap` object. + +. Create the custom CR by running the following command: ++ +[source,terminal] +---- +$ oc apply -f +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openshift-ai.adoc new file mode 100644 index 000000000000..712b4df551b9 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openshift-ai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-openshift-ai"] + += Configuring {ols-long} with a trusted CA certificate for {rhoai} + +[role="_abstract"] +Use the {ocp-product-title} web console to configure a trusted CA certificate for secure communication between {ols-long} and {rhoai}. + +[NOTE] +==== +If the LLM provider you are using requires a trusted-ca certificate to authenticate the {ols-long} Service you must perform this procedure. If the LLM provider does not require a trusted-ca certificate to authenticate the Service, you should skip this procedure. +==== + +.Procedure + +. Copy the contents of the certificate file and paste it into a file called `caCertFileName`. + +. Create a `ConfigMap` object called `trusted-certs` by running the following command: ++ +[source,terminal] +---- +$ oc create configmap trusted-certs --from-file=caCertFileName --namespace openshift-lightspeed +---- ++ +This command returns an output similar to the following example: ++ +[source,terminal] +---- +kind: ConfigMap +apiVersion: v1 +metadata: + name: trusted-certs + namespace: openshift-lightspeed +data: + caCertFileName: | + -----BEGIN CERTIFICATE----- + . + . + . + -----END CERTIFICATE----- +---- ++ +* `data.caCertFileName` specifies the CA certificates required to connect to your LLM provider. You can include one or more certificates within this block to ensure secure communication. + +. Update the `OLSConfig` custom resource (CR) file to include the name of the `ConfigMap` object you just created. The following example uses {rhoai} as the LLM provider. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + defaultProvider: red_hat_openshift_ai + defaultModel: + additionalCAConfigMapRef: + name: trusted-certs +---- ++ +* `spec.ols.additionalCAConfigMapRef.name` specifies the name of `ConfigMap` object. + +. Create the custom CR by running the following command: ++ +[source,terminal] +---- +$ oc apply -f +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-rhelai.adoc new file mode 100644 index 000000000000..e68e9e15a2a4 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-rhelai.adoc @@ -0,0 +1,68 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-rhelai"] + += Configuring {ols-long} with a trusted CA certificate for {rhelai} + +[role="_abstract"] +Use the {ocp-product-title} web console to configure a trusted CA certificate for secure communication between {ols-long} and {rhelai}. + +[NOTE] +==== +If the LLM provider you are using requires a trusted-ca certificate to authenticate the {ols-long} Service you must perform this procedure. If the LLM provider does not require a trusted-ca certificate to authenticate the Service, you should skip this procedure. +==== + +.Procedure + +. Copy the contents of the certificate file and paste it into a file called `caCertFileName`. + +. Create a `ConfigMap` object called `trusted-certs` by running the following command: ++ +[source,terminal] +---- +$ oc create configmap trusted-certs --from-file=caCertFileName --namespace openshift-lightspeed +---- ++ +This command returns an output similar to the following example: ++ +[source,terminal] +---- +kind: ConfigMap +apiVersion: v1 +metadata: + name: trusted-certs + namespace: openshift-lightspeed +data: + caCertFileName: | + -----BEGIN CERTIFICATE----- + . + . + . + -----END CERTIFICATE----- +---- ++ +* `data.caCertFileName` specifies the CA certificates required to connect to your LLM provider. You can include one or more certificates within this block to ensure secure communication. + +. Update the `OLSConfig` custom resource (CR) file to include the name of the `ConfigMap` object you just created. The following example uses {rhelai} as the LLM provider. ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + ols: + defaultProvider: rhelai + defaultModel: models/ + additionalCAConfigMapRef: + name: trusted-certs +---- ++ +* `spec.ols.additionalCAConfigMapRef.name` specifies the name of `ConfigMap` object. + +. Create the custom CR by running the following command: ++ +[source,terminal] +---- +$ oc apply -f +---- diff --git a/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-watsonx.adoc new file mode 100644 index 000000000000..c901f0ea453f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-watsonx.adoc @@ -0,0 +1,12 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-configuring-lightspeed-with-a-trusted-ca-certificate-for-the-llm-watsonx"] + += Configuring {ols-long} with a trusted CA certificate for {watsonx} + +[role="_abstract"] +Information about trusted CA certificate support for {watsonx}. + +[NOTE] +==== +{watsonx} does not support custom certificates. This procedure does not apply to {watsonx} deployments. +==== diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-aws-bedrock.adoc new file mode 100644 index 000000000000..bcb3f111bb85 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-azure-openai.adoc new file mode 100644 index 000000000000..b91576a8248d --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-azure-openai.adoc @@ -0,0 +1,51 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-azure-openai"] + += Creating the {ols-long} custom resource file for {azure-openai} by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your {azure-openai} provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have an {azure-openai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create an `OLSConfig` file that has the YAML content for your {azure-openai} provider. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {azure-openai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: azure-api-keys + apiVersion: + deploymentName: + models: + - name: + name: myAzure + type: azure_openai + url: + ols: + defaultModel: + defaultProvider: myAzure +---- + +. Run the following command so that the Operator deploys {ols-long} using the information in the YAML configuration file. ++ +[source,terminal] +---- +$ oc create -f /path/to/config-cr.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-google-vertex-ai.adoc new file mode 100644 index 000000000000..fcc85b658c7b --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-google-vertex-ai.adoc @@ -0,0 +1,91 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-google-vertex-ai"] + += Creating the {ols-long} custom resource file for Google Vertex AI by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your Google Vertex AI provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a Google Vertex AI provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +* The Vertex AI API must be enabled in your Google Cloud project. + +.Procedure + +. Create an `OLSConfig` CR file named `olsconfig.yaml` using one of the following examples: ++ +* Example configuration for Gemini (`google_vertex`): ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: google + type: google_vertex + credentialsSecretRef: + name: llmcreds + credentialKey: gcp-service-account.json + googleVertexConfig: + projectID: my-gcp-project-123 + location: us-central1 + models: + - name: gemini-2.5-flash-lite + ols: + defaultModel: gemini-2.5-flash-lite + defaultProvider: google +---- ++ +* Example configuration for Claude (`google_vertex_anthropic`): ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: google-anthropic + type: google_vertex_anthropic + credentialsSecretRef: + name: llmcreds + credentialKey: gcp-service-account.json + googleVertexAnthropicConfig: + projectID: my-gcp-project-123 + location: us-east4 + models: + - name: claude-3-sonnet + ols: + defaultModel: claude-3-sonnet + defaultProvider: google-anthropic +---- + +. Apply the configuration file to your cluster: ++ +[source,bash] +---- +oc apply -f olsconfig.yaml +---- + +.Verification + +. Verify that the Operator has completed reconciliation: ++ +[source,bash] +---- +oc get olsconfig cluster -o jsonpath='{.status.overallStatus}' +---- ++ +Expected output: `Ready` diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openai.adoc new file mode 100644 index 000000000000..14c0728bd91f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openai.adoc @@ -0,0 +1,49 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-openai"] + += Creating the {ols-long} custom resource file for OpenAI by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your {openai} provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have an {openai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create an `OLSConfig` file that has the YAML content for your {openai} provider. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your OpenAI provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: myOpenai + type: openai + credentialsSecretRef: + name: credentials + url: https://api.openai.com/v1 + models: + - name: + ols: + defaultModel: + defaultProvider: myOpenai +---- + +. Run the following command so that the Operator deploys {ols-long} using the information in the YAML configuration file. ++ +[source,terminal] +---- +$ oc create -f /path/to/config-cr.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openshift-ai.adoc new file mode 100644 index 000000000000..1fa8e8146c6a --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-openshift-ai.adoc @@ -0,0 +1,53 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-openshift-ai"] + += Creating the {ols-long} custom resource file for {rhoai} by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your {rhoai} provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {rhoai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create an `OLSConfig` file that has the YAML content for your {rhoai} provider. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {rhoai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: rhoai-api-keys + models: + - name: + name: red_hat_openshift_ai + type: rhoai_vllm + url: + ols: + defaultProvider: red_hat_openshift_ai + defaultModel: +---- ++ +* `spec.llm.providers.credentialsSecretRef.name` specifies the name of the Secret that has the API key for the provider. By default, the {rhoai} API key requires a token as part of the request. If your {rhoai} endpoint does not require a token, you must still set the token value to any valid string for the request to authenticate. ++ +* `spec.llm.providers.url` specifies the URL endpoint for the provider. The URL must end with `v1` to be valid. For example, `\https://..com:443/v1`. + +. Run the following command so that the Operator deploys {ols-long} using the information in the YAML configuration file. ++ +[source,terminal] +---- +$ oc create -f /path/to/config-cr.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-rhelai.adoc new file mode 100644 index 000000000000..bb0a99977fa7 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-rhelai.adoc @@ -0,0 +1,53 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-rhelai"] + += Creating the {ols-long} custom resource file for {rhelai} by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your {rhelai} provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {rhelai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create an `OLSConfig` file that has the YAML content for your {rhelai} provider. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {rhelai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: rhelai-api-keys + models: + - name: models/ + name: rhelai + type: rhelai_vllm + url: + ols: + defaultProvider: rhelai + defaultModel: models/ +---- ++ +* `spec.llm.providers.credentialsSecretRef.name` specifies the name of the Secret that has the API key for the provider. By default, the {rhelai} API key requires a token as part of the request. If your {rhelai} endpoint does not require a token, you must still set the token value to any valid string for the request to authenticate. ++ +* `spec.llm.providers.url` specifies the URL endpoint for the provider. The URL must end with `v1` to be valid. For example, https://3.23.103.8:8000/v1. + +. Run the following command so that the Operator deploys {ols-long} using the information in the YAML configuration file. ++ +[source,terminal] +---- +$ oc create -f /path/to/config-cr.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-watsonx.adoc new file mode 100644 index 000000000000..5728c71988e5 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-cli-watsonx.adoc @@ -0,0 +1,50 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-cli-watsonx"] + += Creating the {ols-long} custom resource file for {watsonx} by using the CLI + +[role="_abstract"] +Use the command line interface to create the custom resource (CR) file required to deploy {ols-long} with your {watsonx} provider. + +.Prerequisites + +* You have access to the {oc-first} and have logged in as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {watsonx} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create an `OLSConfig` file that has the YAML content for your {watsonx} provider. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {watsonx} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: myWatsonx + type: watsonx + credentialsSecretRef: + name: watsonx-api-keys + url: + projectID: + models: + - name: ibm/ + ols: + defaultModel: ibm/ + defaultProvider: myWatsonx +---- + +. Run the following command so that the Operator deploys {ols-long} using the information in the YAML configuration file. ++ +[source,terminal] +---- +$ oc create -f /path/to/config-cr.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-aws-bedrock.adoc new file mode 100644 index 000000000000..4977266714a8 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-azure-openai.adoc new file mode 100644 index 000000000000..814998976031 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-azure-openai.adoc @@ -0,0 +1,48 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-azure-openai"] + += Creating the {ols-long} custom resource file for {azure-openai} by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your {azure-openai} provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have an {azure-openai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {azure-openai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: azure-api-keys + apiVersion: + deploymentName: + models: + - name: + name: myAzure + type: azure_openai + url: + ols: + defaultModel: + defaultProvider: myAzure +---- + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-google-vertex-ai.adoc new file mode 100644 index 000000000000..b925ed1a798c --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-google-vertex-ai.adoc @@ -0,0 +1,77 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-google-vertex-ai"] + += Creating the {ols-long} custom resource file for Google Vertex AI by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your Google Vertex AI provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a Google Vertex AI provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +* The Vertex AI API must be enabled in your Google Cloud project. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste one of the following YAML examples into the text area of the web console. ++ +* Example configuration for Gemini (`google_vertex`): ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: google + type: google_vertex + credentialsSecretRef: + name: llmcreds + credentialKey: gcp-service-account.json + googleVertexConfig: + projectID: my-gcp-project-123 + location: us-central1 + models: + - name: gemini-2.5-flash-lite + ols: + defaultModel: gemini-2.5-flash-lite + defaultProvider: google +---- ++ +* Example configuration for Claude (`google_vertex_anthropic`): ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: google-anthropic + type: google_vertex_anthropic + credentialsSecretRef: + name: llmcreds + credentialKey: gcp-service-account.json + googleVertexAnthropicConfig: + projectID: my-gcp-project-123 + location: us-east4 + models: + - name: claude-3-sonnet + ols: + defaultModel: claude-3-sonnet + defaultProvider: google-anthropic +---- + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openai.adoc new file mode 100644 index 000000000000..427ae248a619 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openai.adoc @@ -0,0 +1,46 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-openai"] + += Creating the {ols-long} custom resource file for OpenAI by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your {openai} provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have an {openai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your OpenAI provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: myOpenai + type: openai + credentialsSecretRef: + name: credentials + url: https://api.openai.com/v1 + models: + - name: + ols: + defaultModel: + defaultProvider: myOpenai +---- + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openshift-ai.adoc new file mode 100644 index 000000000000..c95ad0c6a280 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-openshift-ai.adoc @@ -0,0 +1,50 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-openshift-ai"] + += Creating the {ols-long} custom resource file for {rhoai} by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your {rhoai} provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {rhoai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {rhoai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: rhoai-api-keys + models: + - name: + name: red_hat_openshift_ai + type: rhoai_vllm + url: + ols: + defaultProvider: red_hat_openshift_ai + defaultModel: +---- ++ +* `spec.llm.providers.credentialsSecretRef.name` specifies the name of the Secret that has the API key for the provider. If your provider configuration does not require a token, you must still provide a Secret containing a valid string for the request to authenticate. ++ +* `spec.llm.providers.url` specifies the URL endpoint for the provider. The URL must end with `v1` to be valid. For example, `\https://..com:443/v1`. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-rhelai.adoc new file mode 100644 index 000000000000..e9d11ead29ba --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-rhelai.adoc @@ -0,0 +1,50 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-rhelai"] + += Creating the {ols-long} custom resource file for {rhelai} by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your {rhelai} provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {rhelai} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {rhelai} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - credentialsSecretRef: + name: rhelai-api-keys + models: + - name: models/ + name: rhelai + type: rhelai_vllm + url: + ols: + defaultProvider: rhelai + defaultModel: models/ +---- ++ +* `spec.llm.providers.credentialsSecretRef.name` specifies the name of the Secret that has the API key for the provider. By default, the {rhelai} API key requires a token as part of the request. If your {rhelai} endpoint does not require a token, you must still set the token value to any valid string for the request to authenticate. ++ +* `spec.llm.providers.url` specifies the URL endpoint for the provider. The URL must end with `v1` to be valid. For example, https://3.23.103.8:8000/v1. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-watsonx.adoc new file mode 100644 index 000000000000..dc2b18fac726 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-lightspeed-custom-resource-file-using-web-console-watsonx.adoc @@ -0,0 +1,47 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-lightspeed-custom-resource-file-using-web-console-watsonx"] + += Creating the {ols-long} custom resource file for {watsonx} by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to create the custom resource (CR) file required to deploy {ols-long} with your {watsonx} provider. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you have logged in to a user account that has permission to create a cluster-scoped CR file. + +* You have a {watsonx} provider available for use with the {ols-long} Service. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +Use the following example to create the `OLSConfig` CR to configure {ols-long} with your {watsonx} provider: ++ +[source,yaml] +---- +apiVersion: ols.openshift.io/v1alpha1 +kind: OLSConfig +metadata: + name: cluster +spec: + llm: + providers: + - name: myWatsonx + type: watsonx + credentialsSecretRef: + name: watsonx-api-keys + url: + projectID: + models: + - name: ibm/ + ols: + defaultModel: ibm/ + defaultProvider: myWatsonx +---- + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-aws-bedrock.adoc new file mode 100644 index 000000000000..7e88253738ad --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-creating-the-credentials-secret-using-cli.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-azure-openai.adoc new file mode 100644 index 000000000000..ed76e89658d4 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-azure-openai.adoc @@ -0,0 +1,65 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-azure-openai"] + += Creating the {azure-openai} credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the API token that {ols-long} uses to authenticate with {azure-openai}. + +{azure-official} also supports authentication using {entra-id}. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create a YAML file that has the credential secret for {azure-openai}. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +Use the following example to create the Secret to provide {ols-long} with the {azure-official} {openai} key. ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: azure-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Optional: As another option with {azure-openai} you can use {entra-id} to authenticate your LLM provider. {entra-id} users must configure the required roles for their {azure-openai} resource. For more information, see the official Microsoft link:https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/role-based-access-control#cognitive-services-openai-contributor[Cognitive Services OpenAI Contributor](Microsoft Azure OpenAI Service documentation). Use the following example to authenticate by using {entra-id}. ++ +[source,yaml] +---- +apiVersion: v1 +data: + client_id: + client_secret: + tenant_id: +kind: Secret +metadata: + name: azure-api-keys + namespace: openshift-lightspeed +type: Opaque +---- ++ +* `data.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Create the Secret by running the following command: ++ +[source,terminal] +---- +$ oc create -f /path/to/secret.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-google-vertex-ai.adoc new file mode 100644 index 000000000000..dd9819a70118 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-google-vertex-ai.adoc @@ -0,0 +1,35 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-google-vertex-ai"] + += Creating the Google Vertex AI credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the GCP service account credentials that {ols-long} uses to authenticate with Google Vertex AI. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +* You must possess a valid GCP service account JSON key file. + +* The Vertex AI API must be enabled in your Google Cloud project. + +* Your GCP service account must have appropriate Vertex AI permissions. + +.Procedure + +. Create the credentials Secret in the operator namespace by running the following command: ++ +[source,bash] +---- +oc create secret generic llmcreds \ + --from-file=gcp-service-account.json=/path/to/service-account-key.json \ + -n openshift-lightspeed +---- ++ +[NOTE] +==== +The Operator looks for a key named `apitoken` by default if you omit the `credentialKey` field later. +==== diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openai.adoc new file mode 100644 index 000000000000..1a1b2b9e25de --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-openai"] + += Creating the OpenAI credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the API token that {ols-long} uses to authenticate with {openai}. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create a YAML file that has the credential secret for {openai}. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +Use the following example to create the Secret to provide {ols-long} with the OpenAI API key. ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: openai + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Create the Secret by running the following command: ++ +[source,terminal] +---- +$ oc create -f /path/to/secret.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openshift-ai.adoc new file mode 100644 index 000000000000..f5df86b92fde --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-openshift-ai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-openshift-ai"] + += Creating the {rhoai} credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the API token that {ols-long} uses to authenticate with {rhoai}. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create a YAML file that has the credential secret for {rhoai}. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +Use the following example to create the Secret to provide {ols-long} with the {rhoai} key. ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: rhoai-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Create the Secret by running the following command: ++ +[source,terminal] +---- +$ oc create -f /path/to/secret.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-rhelai.adoc new file mode 100644 index 000000000000..4561c9647444 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-rhelai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-rhelai"] + += Creating the {rhelai} credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the API token that {ols-long} uses to authenticate with {rhelai}. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create a YAML file that has the credential secret for {rhelai}. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +Use the following example to create the Secret to provide {ols-long} with the {rhelai} key. ++ +[source,yaml] +---- +apiVersion: v1 +stringData: + apitoken: +kind: Secret +metadata: + name: rhelai-api-keys + namespace: openshift-lightspeed +type: Opaque +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Create the Secret by running the following command: ++ +[source,terminal] +---- +$ oc create -f /path/to/secret.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-watsonx.adoc new file mode 100644 index 000000000000..75c7e6463100 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-cli-watsonx.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-cli-watsonx"] + += Creating the {watsonx} credentials secret by using the CLI + +[role="_abstract"] +Use the command line interface to store the API token that {ols-long} uses to authenticate with {watsonx}. + +.Prerequisites + +* You have access to the {oc-first} as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Create a YAML file that has the credential secret for {watsonx}. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +Use the following example to create the Secret to provide {ols-long} with the {watsonx} key. ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: watsonx-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Create the Secret by running the following command: ++ +[source,terminal] +---- +$ oc create -f /path/to/secret.yaml +---- diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-aws-bedrock.adoc new file mode 100644 index 000000000000..934c535b12b8 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-creating-the-credentials-secret-using-web-console.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-azure-openai.adoc new file mode 100644 index 000000000000..66630658bc3f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-azure-openai.adoc @@ -0,0 +1,60 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-azure-openai"] + += Creating the {azure-openai} credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the API token that {ols-long} uses to authenticate with {azure-openai}. + +As another option, {azure-official} also supports authentication by using {entra-id}. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: azure-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token, and is not `base64` encoded. + +. Optional: As another option with {azure-openai} you can use {entra-id} to authenticate your LLM provider. {entra-id} users must configure the required roles for their {azure-openai} resource. For more information, see the official Microsoft link:https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/role-based-access-control#cognitive-services-openai-contributor[Cognitive Services OpenAI Contributor](Microsoft Azure OpenAI Service documentation). Use the following example to authenticate by using {entra-id}. ++ +[source,yaml] +---- +apiVersion: v1 +data: + client_id: + client_secret: + tenant_id: +kind: Secret +metadata: + name: azure-api-keys + namespace: openshift-lightspeed +type: Opaque +---- ++ +* `data.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-google-vertex-ai.adoc new file mode 100644 index 000000000000..bb03db68405f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-google-vertex-ai.adoc @@ -0,0 +1,44 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-google-vertex-ai"] + += Creating the Google Vertex AI credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the GCP service account credentials that {ols-long} uses to authenticate with Google Vertex AI. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +* You must possess a valid GCP service account JSON key file. + +* The Vertex AI API must be enabled in your Google Cloud project. + +* Your GCP service account must have appropriate Vertex AI permissions. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: llmcreds + namespace: openshift-lightspeed +type: Opaque +stringData: + gcp-service-account.json: +---- ++ +[NOTE] +==== +The Operator looks for a key named `apitoken` by default if you omit the `credentialKey` field later. +==== + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openai.adoc new file mode 100644 index 000000000000..6ae5bbc19cdf --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openai.adoc @@ -0,0 +1,40 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-openai"] + += Creating the OpenAI credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the API token that {ols-long} uses to authenticate with {openai}. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: openai + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token, and is not `base64` encoded. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openshift-ai.adoc new file mode 100644 index 000000000000..e3b8fcadce31 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-openshift-ai.adoc @@ -0,0 +1,40 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-openshift-ai"] + += Creating the {rhoai} credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the API token that {ols-long} uses to authenticate with {rhoai}. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: rhoai-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-rhelai.adoc new file mode 100644 index 000000000000..f4c96895104d --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-rhelai.adoc @@ -0,0 +1,40 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-rhelai"] + += Creating the {rhelai} credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the API token that {ols-long} uses to authenticate with {rhelai}. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +[source,yaml] +---- +apiVersion: v1 +stringData: + apitoken: +kind: Secret +metadata: + name: rhelai-api-keys + namespace: openshift-lightspeed +type: Opaque +---- ++ +* `stringData.apitoken` represents the API token. The token must be `base64` encoded when stored in a secret. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-watsonx.adoc new file mode 100644 index 000000000000..ded8785f296f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-creating-the-credentials-secret-using-web-console-watsonx.adoc @@ -0,0 +1,40 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-creating-the-credentials-secret-using-web-console-watsonx"] + += Creating the {watsonx} credentials secret by using the web console + +[role="_abstract"] +Use the {ocp-product-title} web console to store the API token that {ols-long} uses to authenticate with {watsonx}. + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. As another option, you can log in to a user account that has permission to create a secret to store the Provider tokens. + +* You have installed the {ols-long} Operator. + +.Procedure + +. Click the *Quick create* (image:fa-plus-circle.png[title="Quick create menu"]) menu in the upper-right corner of the {ocp-short-name} web console and select *Import YAML*. + +. Paste the following YAML content into the text area of the web console. ++ +[NOTE] +==== +The YAML parameter is always `apitoken` regardless of what the LLM provider calls the access details. +==== ++ +[source,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + name: watsonx-api-keys + namespace: openshift-lightspeed +type: Opaque +stringData: + apitoken: +---- ++ +* `stringData.apitoken` represents the API token, and is not `base64` encoded. + +. Click *Create*. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-overview-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-azure-openai.adoc new file mode 100644 index 000000000000..e6722b9ba287 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-azure-openai.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-overview-azure-openai"] + += {azure-openai} with {ols-long} + +[role="_abstract"] +Learn how the {ols-long} Service uses large language models (LLMs) to generate intelligent, context-aware answers to your questions about {ocp-product-title}. + +You can connect the {ols-long} Service to {azure-openai} as a publicly available LLM provider. + +[NOTE] +==== +Installing the {ols-long} Operator does not install an LLM provider. You must have an LLM provider available for use before you install the {ols-long} Operator. +==== + +To configure {azure-openai} as the LLM provider, you need a {azure-openai} Service instance. You must have at least one model deployment in {azure-studio} for that instance. + +For more information, see the official {azure-openai} link:https://learn.microsoft.com/en-us/azure/ai-services/openai/[product documentation]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openai.adoc new file mode 100644 index 000000000000..9c7d2434130d --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openai.adoc @@ -0,0 +1,20 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-overview-openai"] + += {openai} with {ols-long} + +[role="_abstract"] +Learn how the {ols-long} Service uses large language models (LLMs) to generate intelligent, context-aware answers to your questions about {ocp-product-title}. + +You can connect the {ols-long} Service to {openai} as a publicly available LLM provider. + +[NOTE] +==== +Installing the {ols-long} Operator does not install an LLM provider. You must have an LLM provider available for use before you install the {ols-long} Operator. +==== + +To configure {openai} as the LLM provider with {ols-long}, you need either the {openai} API key or the {openai} project name during the configuration process. + +The {openai} Service has a feature for projects and service accounts. You can use a service account in a dedicated project so that you can precisely track {ols-long} usage. + +For more information, see the official {openai} link:https://platform.openai.com/docs/overview[product documentation]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openshift-ai.adoc new file mode 100644 index 000000000000..85f7cff37787 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-openshift-ai.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-overview-openshift-ai"] + += {rhoai} with {ols-long} + +[role="_abstract"] +Learn how the {ols-long} Service uses large language models (LLMs) to generate intelligent, context-aware answers to your questions about {ocp-product-title}. + +You can configure {rhoai} as the LLM provider for the {ols-long} Service. {rhoai} can use a server or inference service that processes inference queries. + +[NOTE] +==== +Installing the {ols-long} Operator does not install an LLM provider. You must have an LLM provider available for use before you install the {ols-long} Operator. +==== + +You can use {rhoai} to host an LLM. + +For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/configuring_your_model-serving_platform/configuring-your-model-serving-platform_rhoai-admin#about-model-serving_rhoai-admin[About model serving]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-overview-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-rhelai.adoc new file mode 100644 index 000000000000..bff523e875cd --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-rhelai.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-overview-rhelai"] + += {rhelai} with {ols-long} + +[role="_abstract"] +Learn how the {ols-long} Service uses large language models (LLMs) to generate intelligent, context-aware answers to your questions about {ocp-product-title}. + +You can configure {rhelai} as the LLM provider for the {ols-long} Service. {rhelai} can use a server or inference service that processes inference queries. + +[NOTE] +==== +Installing the {ols-long} Operator does not install an LLM provider. You must have an LLM provider available for use before you install the {ols-long} Operator. +==== + +You can use {rhelai} to host an LLM. + +For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_ai/1.5/html/generating_a_custom_llm_using_rhel_ai/index[Generating a custom LLM by using RHEL AI]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-overview-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-watsonx.adoc new file mode 100644 index 000000000000..80f8f9b06708 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-overview-watsonx.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-overview-watsonx"] + += {watsonx} with {ols-long} + +[role="_abstract"] +Learn how the {ols-long} Service uses large language models (LLMs) to generate intelligent, context-aware answers to your questions about {ocp-product-title}. + +You can connect the {ols-long} Service to {watsonx} as a publicly available LLM provider. + +[NOTE] +==== +Installing the {ols-long} Operator does not install an LLM provider. You must have an LLM provider available for use before you install the {ols-long} Operator. +==== + +To configure {watsonx} as the LLM provider, you need an {ibm-cloud-title} project with access to {watsonx}. You also need your {watsonx} API key. + +For more information, see the official {watsonx} link:https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html?context=wx&audience=wdp[product documentation]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-aws-bedrock.adoc new file mode 100644 index 000000000000..9948cf3c8518 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-large-language-model-requirements.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-azure-openai.adoc new file mode 100644 index 000000000000..2ddbd5700be9 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-azure-openai.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-requirements-azure-openai"] + += {azure-openai} requirements + +[role="_abstract"] +{ols-long} supports {azure-openai} as a Software as a Service (SaaS) large language model (LLM) provider. + +The {ols-long} Service does not provide the LLM for you, so you must configure the LLM before installing the {ols-long} Operator. + +[NOTE] +==== +Red{nbsp}Hat does not provide support for any specific models or make suggestions or support statements pertaining to models. +==== + +To use {azure-official} with {ols-official}, you need access to link:https://azure.microsoft.com/en-us/[{azure-openai}]. For more information, see the link:https://learn.microsoft.com/en-us/azure/ai-services/openai/[Azure OpenAI documentation]. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openai.adoc new file mode 100644 index 000000000000..603d905f9de6 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openai.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-requirements-openai"] + += {openai} requirements + +[role="_abstract"] +{ols-long} supports {openai} as a Software as a Service (SaaS) large language model (LLM) provider. + +The {ols-long} Service does not provide the LLM for you, so you must configure the LLM before installing the {ols-long} Operator. + +[NOTE] +==== +Red{nbsp}Hat does not provide support for any specific models or make suggestions or support statements pertaining to models. +==== + +To use {openai} with {ols-official}, you need access to the {openai} link:https://openai.com/api/[API platform]. For more information, see the link:https://platform.openai.com/docs/overview[OpenAI developer platform] documentation. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openshift-ai.adoc new file mode 100644 index 000000000000..22c7a03a22ed --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-openshift-ai.adoc @@ -0,0 +1,20 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-requirements-openshift-ai"] + += {rhoai} requirements + +[role="_abstract"] +{ols-long} supports {rhoai} as a self-hosted large language model (LLM) provider. + +The {ols-long} Service does not provide the LLM for you, so you must configure the LLM before installing the {ols-long} Operator. + +[NOTE] +==== +Red{nbsp}Hat does not provide support for any specific models or make suggestions or support statements pertaining to models. +==== + +{rhoai} is OpenAI API-compatible, and you configure {rhoai} largely the same as the OpenAI provider. + +You must deploy the LLM on the {rhoai} single-model serving platform that uses the virtual large language model (vLLM) runtime. If the model deployment runs in a different {ocp-short-name} environment than the {ols-long} deployment, include a route to expose the model deployment outside the cluster. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2-latest/html/serving_models/serving-large-models_serving-large-models#about-the-single-model-serving-platform_serving-large-models[About the single-model serving platform]. + +{ols-long} version 1.0 and later supports vLLM Server version 0.8.4 and later. When self-hosting the LLM with {rhoai}, you can use vLLM Server as the inference engine. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-rhelai.adoc new file mode 100644 index 000000000000..ea8f7c7dcb7f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-rhelai.adoc @@ -0,0 +1,22 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-requirements-rhelai"] + += {rhelai} requirements + +[role="_abstract"] +{ols-long} supports {rhelai} as a self-hosted large language model (LLM) provider. + +The {ols-long} Service does not provide the LLM for you, so you must configure the LLM before installing the {ols-long} Operator. + +[NOTE] +==== +Red{nbsp}Hat does not provide support for any specific models or make suggestions or support statements pertaining to models. +==== + +{rhelai} is OpenAI API-compatible, and you configure {rhelai} in a similar manner as the OpenAI provider. + +You can configure {rhelai} as the LLM provider. + +Because the {rhel} is in a different environment than the {ols-long} deployment, the model deployment must allow access by using a secure connection. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_ai/1.2/html-single/building_your_rhel_ai_environment/index#creating_secure_endpoint[Optional: Allowing access to a model from a secure endpoint]. + +{ols-long} version 1.0 and later supports vLLM Server version 0.8.4 and later. When self-hosting the LLM with {rhelai}, you can use vLLM Server as the inference engine. diff --git a/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-watsonx.adoc new file mode 100644 index 000000000000..824fbe8af23f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-large-language-model-requirements-watsonx.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-large-language-model-requirements-watsonx"] + += {watsonx} requirements + +[role="_abstract"] +{ols-long} supports {watsonx} as a Software as a Service (SaaS) large language model (LLM) provider. + +The {ols-long} Service does not provide the LLM for you, so you must configure the LLM before installing the {ols-long} Operator. + +[NOTE] +==== +Red{nbsp}Hat does not provide support for any specific models or make suggestions or support statements pertaining to models. +==== + +To use {watsonx} with {ols-official}, you need an account with link:https://www.ibm.com/products/watsonx-ai[{ibm-cloud-title} watsonx]. For more information, see the link:https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html?context=wx[Documentation for IBM watsonx as a Service]. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-aws-bedrock.adoc new file mode 100644 index 000000000000..33b3bef13f31 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-support-for-trusted-ca-certificates-and-llm-providers.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-azure-openai.adoc new file mode 100644 index 000000000000..ea977ddb0d87 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-azure-openai.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-azure-openai"] + += Configure support for trusted-ca certificates with {azure-openai} + +[role="_abstract"] +Configure custom TLS certificates to secure communication between {ols-long} and {azure-openai} service endpoints. + +The {ols-long} Service supports custom TLS certificates for secure communication with {azure-openai}. + +.Procedure + +. Create a `ConfigMap` object that contains the certificates. +. Add the name of the object in the `OLSConfig` custom resource (CR) file: ++ +[source,yaml] +---- +ols: + additionalCAConfigMapRef: + name: +---- ++ +where ++ +``:: Enter the name of your `ConfigMap` object. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-google-vertex-ai.adoc new file mode 100644 index 000000000000..4723b32c9c0f --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-google-vertex-ai.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-google-vertex-ai"] + += Configure support for trusted-ca certificates with Google Vertex AI + +[role="_abstract"] +Configure custom TLS certificates to secure communication between {ols-long} and Google Vertex AI service endpoints. + +The {ols-long} Service supports custom TLS certificates for secure communication with Google Vertex AI. + +.Procedure + +. Create a `ConfigMap` object that contains the certificates. +. Add the name of the object in the `OLSConfig` custom resource (CR) file: ++ +[source,yaml] +---- +ols: + additionalCAConfigMapRef: + name: +---- ++ +where ++ +``:: Enter the name of your `ConfigMap` object. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openai.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openai.adoc new file mode 100644 index 000000000000..6009e6667646 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openai.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-openai"] + += Configure support for trusted-ca certificates with {openai} + +[role="_abstract"] +Configure custom TLS certificates to secure communication between {ols-long} and {openai} service endpoints. + +The {ols-long} Service supports custom TLS certificates for secure communication with {openai}. + +.Procedure + +. Create a `ConfigMap` object that contains the certificates. +. Add the name of the object in the `OLSConfig` custom resource (CR) file: ++ +[source,yaml] +---- +ols: + additionalCAConfigMapRef: + name: +---- ++ +where ++ +``:: Enter the name of your `ConfigMap` object. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openshift-ai.adoc new file mode 100644 index 000000000000..ba6ed49bf3ef --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-openshift-ai.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-openshift-ai"] + += Configure support for trusted-ca certificates with {rhoai} + +[role="_abstract"] +Configure custom TLS certificates to secure communication between {ols-long} and {rhoai} vLLM service endpoints. + +The {ols-long} Service supports custom TLS certificates for secure communication with {rhoai} vLLM. + +.Procedure + +. Create a `ConfigMap` object that contains the certificates. +. Add the name of the object in the `OLSConfig` custom resource (CR) file: ++ +[source,yaml] +---- +ols: + additionalCAConfigMapRef: + name: +---- ++ +where ++ +``:: Enter the name of your `ConfigMap` object. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-rhelai.adoc new file mode 100644 index 000000000000..a2dcdb6803f0 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-rhelai.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-rhelai"] + += Configure support for trusted-ca certificates with {rhelai} + +[role="_abstract"] +Configure custom TLS certificates to secure communication between {ols-long} and {rhelai} vLLM service endpoints. + +The {ols-long} Service supports custom TLS certificates for secure communication with {rhelai} vLLM. + +.Procedure + +. Create a `ConfigMap` object that contains the certificates. +. Add the name of the object in the `OLSConfig` custom resource (CR) file: ++ +[source,yaml] +---- +ols: + additionalCAConfigMapRef: + name: +---- ++ +where ++ +``:: Enter the name of your `ConfigMap` object. diff --git a/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-watsonx.adoc new file mode 100644 index 000000000000..2ba6187593f8 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-support-for-trusted-ca-certificates-and-llm-providers-watsonx.adoc @@ -0,0 +1,12 @@ +:_mod-docs-content-type: CONCEPT +[id="ols-support-for-trusted-ca-certificates-and-llm-providers-watsonx"] + += Configure support for trusted-ca certificates with {watsonx} + +[role="_abstract"] +Custom TLS certificate configuration for communication between {ols-long} and {watsonx}. + +[NOTE] +==== +{watsonx} does not support custom certificates. +==== diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-aws-bedrock.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-aws-bedrock.adoc new file mode 100644 index 000000000000..74f2d7ff1f3b --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-aws-bedrock.adoc @@ -0,0 +1,2 @@ +// Placeholder: Provider-specific version of modules/ols-verifying-openshift-lightspeed-deployment.adoc +// Extract the AWS Bedrock-specific content from the shared module into this file. diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-azure-openai.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-azure-openai.adoc new file mode 100644 index 000000000000..d8896d57e734 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-azure-openai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-azure-openai"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-google-vertex-ai.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-google-vertex-ai.adoc new file mode 100644 index 000000000000..683ac9f44460 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-google-vertex-ai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-google-vertex-ai"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openai.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openai.adoc new file mode 100644 index 000000000000..5a2b5e6ff4e0 --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-openai"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openshift-ai.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openshift-ai.adoc new file mode 100644 index 000000000000..eda3b2d75dbe --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-openshift-ai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-openshift-ai"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-rhelai.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-rhelai.adoc new file mode 100644 index 000000000000..83af17ce7dbc --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-rhelai.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-rhelai"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-watsonx.adoc b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-watsonx.adoc new file mode 100644 index 000000000000..e68a4a6fc0ff --- /dev/null +++ b/jtbd-aem-conversion/integrate/ols-verifying-openshift-lightspeed-deployment-watsonx.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE +[id="ols-verifying-openshift-lightspeed-deployment-watsonx"] + += Verifying the {ols-long} deployment + +[role="_abstract"] +Use the {ocp-product-title} web console to verify that the {ols-long} Service is running and deployed. + +include::snippets/ols-unified-perspective-web-console.adoc[] + +.Prerequisites + +* You have logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. + +* You have access to the {oc-first}. + +* You have installed the {ols-long} Operator. + +* You have created the credentials secret and the `OLSConfig` Custom Resource configuration file. + +.Procedure + +. In the {ocp-product-title} web console, click the *Project* drop-down list. ++ +[NOTE] +==== +For {ocp-product-title} 4.18 and earlier, select the *Developer* perspective from the drop-down list at the top of the pane to access the *Project* drop-down list. +==== + +. Enable the toggle switch to show default projects. + +. Select *openshift-lightspeed* from the list. + +. Verify that the {ols-long} is ready by running the following command: ++ +[source,terminal] +---- +$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn +---- ++ +.Example output +[source,terminal] +---- +INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) +---- diff --git a/jtbd-aem-conversion/troubleshoot/con-troubleshoot-model-responses.adoc b/jtbd-aem-conversion/troubleshoot/con-troubleshoot-model-responses.adoc index 0a064d8afb2a..b27a2390044c 100644 --- a/jtbd-aem-conversion/troubleshoot/con-troubleshoot-model-responses.adoc +++ b/jtbd-aem-conversion/troubleshoot/con-troubleshoot-model-responses.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT [id="con-troubleshoot-model-responses"] -= Troubleshoot AI model responses and token limits += Troubleshoot model responses and token limits [role="_abstract"] Review solutions and workarounds for issues with AI model responses in {ols-long}, including reasoning model delineator tags, prompt length errors, truncated responses, and conversation history truncation.