From 98d9a68bc771caf348bc232c56b5e76c2c7b0adf Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Mon, 22 Sep 2025 16:42:37 -0400 Subject: [PATCH] OLS-2088: Document how to hide OLS icon --- ...-lightspeed-custom-resource-file-using-cli.adoc | 14 ++++++++++++-- ...eed-custom-resource-file-using-web-console.adoc | 10 ++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc b/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc index 5a605b12aadf..d41e3dc91aee 100644 --- a/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc +++ b/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc @@ -38,9 +38,11 @@ spec: models: - name: ols: + hideIcon: true <1> defaultModel: defaultProvider: myOpenai ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{rhelai} CR file [source,yaml,subs="attributes,verbatim"] @@ -60,13 +62,15 @@ spec: type: rhelai_vllm url: <2> ols: + hideIcon: true <3> defaultProvider: rhelai defaultModel: models/ additionalCAConfigMapRef: name: openshift-service-ca.crt ---- <1> By default, the {rhelai} API key requires a token as part of the request. If your {rhelai} configuration does not require a token, you must set the token value to any valid string for the request to authenticate. -<2> The URL endpoint must end with `v1` to be valid. For example, `\https://http://3.23.103.8:8000/v1`. +<2> The URL endpoint must end with `v1` to be valid. For example, `\https://http://3.23.103.8:8000/v1`. +<3> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{rhoai} CR file [source,yaml,subs="attributes,verbatim"] @@ -86,11 +90,13 @@ spec: type: rhoai_vllm url: <2> ols: + hideIcon: true <3> defaultProvider: red_hat_openshift_ai defaultModel: ---- <1> By default, the {rhoai} API key requires a token as part of the request. If your {rhoai} configuration does not require a token, you must set the token value to any valid string for the request to authenticate. -<2> The URL endpoint must end with `v1` to be valid. For example, `\https://..com:443/v1`. +<2> The URL endpoint must end with `v1` to be valid. For example, `\https://..com:443/v1`. +<3> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{azure-openai} CR file [source,yaml,subs="attributes,verbatim"] @@ -112,9 +118,11 @@ spec: type: azure_openai url: ols: + hideIcon: true <1> defaultModel: defaultProvider: myAzure ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{watsonx} CR file [source,yaml,subs="attributes,verbatim"] @@ -135,9 +143,11 @@ spec: models: - name: ibm/ ols: + hideIcon: true <1> defaultModel: ibm/ defaultProvider: myWatsonx ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. . Run the following command: + diff --git a/modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc b/modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc index d63ec4a1b17d..3e332d88acdc 100644 --- a/modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc +++ b/modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc @@ -40,9 +40,11 @@ spec: models: - name: ols: + hideIcon: true <1> defaultModel: defaultProvider: myOpenai ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{rhelai} CR file [source,yaml,subs="attributes,verbatim"] @@ -62,11 +64,13 @@ spec: type: rhelai_vllm url: <2> ols: + hideIcon: true <3> defaultProvider: rhelai defaultModel: models/ ---- <1> By default, the {rhelai} API key requires a token as part of the request. If your {rhelai} configuration does not require a token, you must set the token value to any valid string for the request to authenticate. <2> The URL endpoint must end with `v1` to be valid. For example, `\https://http://3.23.103.8:8000/v1`. +<3> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{rhoai} CR file [source,yaml,subs="attributes,verbatim"] @@ -86,11 +90,13 @@ spec: type: rhoai_vllm url: <2> ols: + hideIcon: true <3> defaultProvider: red_hat_openshift_ai defaultModel: ---- <1> By default, the {rhoai} API key requires a token as part of the request. If your {rhoai} configuration does not require a token, you must set the token value to any valid string for the request to authenticate. <2> The URL endpoint must end with `v1` to be valid. For example, `\https://..com:443/v1`. +<3> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{azure-openai} CR file [source,yaml,subs="attributes,verbatim"] @@ -112,9 +118,11 @@ spec: type: azure_openai url: ols: + hideIcon: true <1> defaultModel: defaultProvider: myAzure ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. + .{watsonx} CR file [source,yaml,subs="attributes,verbatim"] @@ -135,8 +143,10 @@ spec: models: - name: ibm/ ols: + hideIcon: true <1> defaultModel: ibm/ defaultProvider: myWatsonx ---- +<1> Specify whether to hide the {ols-long} icon in the {ocp-product-title} web console. The default setting is `false`, which does not hide the icon. Setting the `hideIcon` field to `true` hides the icon. For example, you can hide the icon from cluster users that do not have access to the {ols-long} API. . Click *Create*. \ No newline at end of file