Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions modules/adding-custom-notification-banners.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
+
Expand All @@ -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.
8 changes: 4 additions & 4 deletions modules/adding-yaml-examples-to-kube-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
+
Expand Down Expand Up @@ -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*.
12 changes: 7 additions & 5 deletions modules/creating-custom-links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
+
Expand All @@ -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:
+
Expand Down
4 changes: 2 additions & 2 deletions modules/customizing-cli-downloads.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
55 changes: 55 additions & 0 deletions modules/customizing-the-console-route.adoc
Original file line number Diff line number Diff line change
@@ -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: <custom_hostname>
servingCertKeyPairSecret:
name: <secret_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.
====
55 changes: 55 additions & 0 deletions modules/customizing-the-download-route.adoc
Original file line number Diff line number Diff line change
@@ -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: <custom_hostname>
servingCertKeyPairSecret:
name: <secret_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.
====
9 changes: 4 additions & 5 deletions modules/customizing-the-login-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
105 changes: 4 additions & 101 deletions modules/customizing-the-web-console-URL.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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: <custom_hostname> <1>
servingCertKeyPairSecret:
name: <secret_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: <custom_hostname> <1>
servingCertKeyPairSecret:
name: <secret_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.
8 changes: 3 additions & 5 deletions modules/defining-template-for-external-log-link.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,16 @@
[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

* You must have administrator privileges.

.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:
+
Expand Down
2 changes: 2 additions & 0 deletions web_console/customizing-the-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down