diff --git a/modules/adding-custom-notification-banners.adoc b/modules/adding-custom-notification-banners.adoc index 917dbc0d51f4..dc1889136164 100644 --- a/modules/adding-custom-notification-banners.adoc +++ b/modules/adding-custom-notification-banners.adoc @@ -6,14 +6,16 @@ [id="creating-custom-notification-banners_{context}"] = Creating custom notification banners +[role="_abstract"] +You can create custom notification banners to display messages, alerts, or links to users in the {product-title} web console. + .Prerequisites * You must have administrator privileges. .Procedure -. From *Administration* -> *Custom Resource Definitions*, click on -*ConsoleNotification*. +. From *Administration* -> *Custom Resource Definitions*, click *ConsoleNotification*. . Select *Instances* tab . Click *Create Console Notification* and edit the file: + @@ -25,13 +27,14 @@ metadata: name: example spec: text: This is an example notification message with an optional link. - location: BannerTop <1> + location: BannerTop link: href: 'https://www.example.com' text: Optional link text color: '#fff' backgroundColor: '#0088ce' ---- -<1> Valid location settings are `BannerTop`, `BannerBottom`, and `BannerTopBottom`. ++ +The `location` field accepts `BannerTop`, `BannerBottom`, or `BannerTopBottom`. . Click *Create* to apply your changes. diff --git a/modules/adding-yaml-examples-to-kube-resources.adoc b/modules/adding-yaml-examples-to-kube-resources.adoc index 22dd14d5cfcd..c3ba83974a57 100644 --- a/modules/adding-yaml-examples-to-kube-resources.adoc +++ b/modules/adding-yaml-examples-to-kube-resources.adoc @@ -6,6 +6,7 @@ [id="adding-yaml-examples-to-kube-resources_{context}"] = Adding YAML examples to Kubernetes resources +[role="_abstract"] You can dynamically add YAML examples to any Kubernetes resources at any time. .Prerequisites @@ -14,7 +15,7 @@ You can dynamically add YAML examples to any Kubernetes resources at any time. .Procedure -. From *Administration* -> *Custom Resource Definitions*, click on *ConsoleYAMLSample*. +. From *Administration* -> *Custom Resource Definitions*, click *ConsoleYAMLSample*. . Click *YAML* and edit the file: + @@ -49,8 +50,7 @@ spec: - "for i in 9 8 7 6 5 4 3 2 1 ; do echo $i ; done" restartPolicy: Never ---- -Use `spec.snippet` to indicate that the YAML sample is not the full YAML resource -definition, but a fragment that can be inserted into the existing YAML document -at the user's cursor. ++ +Use `spec.snippet` to indicate that the YAML sample is not the full YAML resource definition, but a fragment that can be inserted into the existing YAML document at the user's cursor. . Click *Save*. diff --git a/modules/creating-custom-links.adoc b/modules/creating-custom-links.adoc index 4e1e219111f6..f0222ed94176 100644 --- a/modules/creating-custom-links.adoc +++ b/modules/creating-custom-links.adoc @@ -6,14 +6,16 @@ [id="creating-custom-links_{context}"] = Creating custom links in the web console +[role="_abstract"] +You can create custom links to display in the {product-title} web console, such as links to internal tools, documentation, or support resources. + .Prerequisites * You must have administrator privileges. .Procedure -. From *Administration* -> *Custom Resource Definitions*, click on -*ConsoleLink*. +. From *Administration* -> *Custom Resource Definitions*, click *ConsoleLink*. . Select *Instances* tab . Click *Create Console Link* and edit the file: + @@ -25,11 +27,11 @@ metadata: name: example spec: href: 'https://www.example.com' - location: HelpMenu <1> + location: HelpMenu text: Link 1 ---- -<1> Valid location settings are `HelpMenu`, `UserMenu`, `ApplicationMenu`, and -`NamespaceDashboard`. ++ +The `location` field accepts `HelpMenu`, `UserMenu`, `ApplicationMenu`, or `NamespaceDashboard`. + To make the custom link appear in all namespaces, follow this example: + diff --git a/modules/customizing-cli-downloads.adoc b/modules/customizing-cli-downloads.adoc index 2f568df248be..fab8e97d2d55 100644 --- a/modules/customizing-cli-downloads.adoc +++ b/modules/customizing-cli-downloads.adoc @@ -6,8 +6,8 @@ [id="creating-custom-CLI-downloads_{context}"] = Customizing CLI downloads -You can configure links for downloading the CLI with custom link text and URLs, -which can point directly to file packages or to an external page that provides +[role="_abstract"] +You can configure links for downloading the CLI with custom link text and URLs, which can point directly to file packages or to an external page that provides the packages. .Prerequisites diff --git a/modules/customizing-the-console-route.adoc b/modules/customizing-the-console-route.adoc new file mode 100644 index 000000000000..b340801e702c --- /dev/null +++ b/modules/customizing-the-console-route.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * web_console/customizing-the-web-console.adoc + +:_mod-docs-content-type: PROCEDURE +[id="customizing-the-console-route_{context}"] += Customizing the console route + +[role="_abstract"] +You can customize the console route by setting the custom hostname and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration. + +.Prerequisites + +* You have logged in to the cluster as a user with administrative privileges. +* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. ++ +[TIP] +==== +You can create a TLS secret by using the `oc create secret tls` command. +==== + +.Procedure + +. Edit the cluster `Ingress` configuration: ++ +[source,terminal] +---- +$ oc edit ingress.config.openshift.io cluster +---- + +. Set the custom hostname and optionally the serving certificate and key: ++ +[source,yaml] +---- +apiVersion: config.openshift.io/v1 +kind: Ingress +metadata: + name: cluster +spec: + componentRoutes: + - name: console + namespace: openshift-console + hostname: + servingCertKeyPairSecret: + name: +---- ++ +The `hostname` field specifies the custom hostname. The `servingCertKeyPairSecret.name` field references a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. + +. Save the file to apply the changes. ++ +[NOTE] +==== +Add a DNS record for the custom console route that points to the application ingress load balancer. +==== \ No newline at end of file diff --git a/modules/customizing-the-download-route.adoc b/modules/customizing-the-download-route.adoc new file mode 100644 index 000000000000..fa78da63d6b9 --- /dev/null +++ b/modules/customizing-the-download-route.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * web_console/customizing-the-web-console.adoc + +:_mod-docs-content-type: PROCEDURE +[id="customizing-the-download-route_{context}"] += Customizing the download route + +[role="_abstract"] +You can customize the download route by setting the custom hostname and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration. + +.Prerequisites + +* You have logged in to the cluster as a user with administrative privileges. +* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. ++ +[TIP] +==== +You can create a TLS secret by using the `oc create secret tls` command. +==== + +.Procedure + +. Edit the cluster `Ingress` configuration: ++ +[source,terminal] +---- +$ oc edit ingress.config.openshift.io cluster +---- + +. Set the custom hostname and optionally the serving certificate and key: ++ +[source,yaml] +---- +apiVersion: config.openshift.io/v1 +kind: Ingress +metadata: + name: cluster +spec: + componentRoutes: + - name: downloads + namespace: openshift-console + hostname: + servingCertKeyPairSecret: + name: +---- ++ +The `hostname` field specifies the custom hostname. The `servingCertKeyPairSecret.name` field references a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. + +. Save the file to apply the changes. ++ +[NOTE] +==== +Add a DNS record for the custom downloads route that points to the application ingress load balancer. +==== \ No newline at end of file diff --git a/modules/customizing-the-login-page.adoc b/modules/customizing-the-login-page.adoc index eeedf4983dfb..6816c5a8c52b 100644 --- a/modules/customizing-the-login-page.adoc +++ b/modules/customizing-the-login-page.adoc @@ -6,11 +6,10 @@ [id="customizing-the-login-page_{context}"] = Customizing the login page -Create Terms of Service information with custom login pages. Custom login pages -can also be helpful if you use a third-party login provider, such as GitHub or -Google, to show users a branded page that they trust and expect before being -redirected to the authentication provider. You can also render custom error -pages during the authentication process. +[role="_abstract"] +You can customize the login page to display Terms of Service information or apply custom branding for third-party login providers. + +Custom login pages can also be helpful if you use a third-party login provider, such as GitHub or Google, to show users a branded page that they trust and expect before being redirected to the authentication provider. You can also render custom error pages during the authentication process. [NOTE] ==== diff --git a/modules/customizing-the-web-console-URL.adoc b/modules/customizing-the-web-console-URL.adoc index 28572a486b3a..90a792336b80 100644 --- a/modules/customizing-the-web-console-URL.adoc +++ b/modules/customizing-the-web-console-URL.adoc @@ -2,108 +2,11 @@ // // * web_console/customizing-the-web-console.adoc -:_mod-docs-content-type: PROCEDURE +:_mod-docs-content-type: CONCEPT [id="customizing-the-web-console-url_{context}"] = Customizing console routes -For `console` and `downloads` routes, custom routes functionality uses the `ingress` config route configuration API. If the `console` custom route is set up in both the `ingress` config and `console-operator` config, then the new `ingress` config custom route configuration takes precedent. The route configuration with the `console-operator` config is deprecated. +[role="_abstract"] +For `console` and `downloads` routes, custom routes functionality uses the `ingress` config route configuration API. -[id="customizing-the-console-route_{context}"] -== Customizing the console route - -You can customize the console route by setting the custom hostname and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration. - -.Prerequisites - -* You have logged in to the cluster as a user with administrative privileges. -* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. -+ -[TIP] -==== -You can create a TLS secret by using the `oc create secret tls` command. -==== - -.Procedure - -. Edit the cluster `Ingress` configuration: -+ -[source,terminal] ----- -$ oc edit ingress.config.openshift.io cluster ----- - -. Set the custom hostname and optionally the serving certificate and key: -+ -[source,yaml] ----- -apiVersion: config.openshift.io/v1 -kind: Ingress -metadata: - name: cluster -spec: - componentRoutes: - - name: console - namespace: openshift-console - hostname: <1> - servingCertKeyPairSecret: - name: <2> ----- -<1> The custom hostname. -<2> Reference to a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. - -. Save the file to apply the changes. - -[NOTE] -==== -Add a DNS record for the custom console route that points to the application ingress load balancer. -==== - -[id="customizing-the-download-route_{context}"] -== Customizing the download route - -You can customize the download route by setting the custom hostname and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration. - -.Prerequisites - -* You have logged in to the cluster as a user with administrative privileges. -* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. -+ -[TIP] -==== -You can create a TLS secret by using the `oc create secret tls` command. -==== - -.Procedure - -. Edit the cluster `Ingress` configuration: -+ -[source,terminal] ----- -$ oc edit ingress.config.openshift.io cluster ----- - -. Set the custom hostname and optionally the serving certificate and key: -+ -[source,yaml] ----- -apiVersion: config.openshift.io/v1 -kind: Ingress -metadata: - name: cluster -spec: - componentRoutes: - - name: downloads - namespace: openshift-console - hostname: <1> - servingCertKeyPairSecret: - name: <2> ----- -<1> The custom hostname. -<2> Reference to a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom hostname suffix does not match the cluster domain suffix. The secret is optional if the suffix matches. - -. Save the file to apply the changes. - -[NOTE] -==== -Add a DNS record for the custom downloads route that points to the application ingress load balancer. -==== +If the `console` custom route is set up in both the `ingress` config and `console-operator` config, then the new `ingress` config custom route configuration takes precedent. The route configuration with the `console-operator` config is deprecated. diff --git a/modules/defining-template-for-external-log-link.adoc b/modules/defining-template-for-external-log-link.adoc index 5998e5bf1c76..faa26292e7fa 100644 --- a/modules/defining-template-for-external-log-link.adoc +++ b/modules/defining-template-for-external-log-link.adoc @@ -6,9 +6,8 @@ [id="defining-template-for-external-log-links_{context}"] = Defining a template for an external log link -If you are connected to a service that helps you browse your logs, but you need -to generate URLs in a particular way, then you can define a template for your -link. +[role="_abstract"] +If you are connected to a service that helps you browse your logs, but you need to generate URLs in a particular way, then you can define a template for your link. .Prerequisites @@ -16,8 +15,7 @@ link. .Procedure -. From *Administration* -> *Custom Resource Definitions*, click on -*ConsoleExternalLogLink*. +. From *Administration* -> *Custom Resource Definitions*, click *ConsoleExternalLogLink*. . Select *Instances* tab . Click *Create Console External Log Link* and edit the file: + diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index e3553116a148..99f5987e5485 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -33,6 +33,8 @@ include::modules/creating-custom-links.adoc[leveloffset=+1] // Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "ingresses" include::modules/customizing-the-web-console-URL.adoc[leveloffset=+1] +include::modules/customizing-the-console-route.adoc[leveloffset=+1] +include::modules/customizing-the-download-route.adoc[leveloffset=+1] endif::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[]