From 60870610be2eb6cce11d833d004baa756ba600ad Mon Sep 17 00:00:00 2001 From: Olga Tikhomirova <85509260+missmesss@users.noreply.github.com> Date: Sat, 1 Nov 2025 20:34:39 -0700 Subject: [PATCH] OSDOCS-15995 - Customizing branding in ROSA and OSD --- _topic_maps/_topic_map_osd.yml | 4 +-- _topic_maps/_topic_map_rosa.yml | 4 +-- _topic_maps/_topic_map_rosa_hcp.yml | 2 ++ modules/adding-a-custom-logo.adoc | 7 +++-- web_console/customizing-the-web-console.adoc | 29 +++++++++++++------- 5 files changed, 29 insertions(+), 17 deletions(-) diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index 3d79cb0d04..b11adf8970 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -243,8 +243,8 @@ Topics: #- Name: Configuring the web console # File: configuring-web-console # Distros: openshift-dedicated -#- Name: Customizing the web console -# File: customizing-the-web-console +- Name: Customizing the web console + File: customizing-the-web-console # Distros: openshift-dedicated - Name: Dynamic plugins Dir: dynamic-plugin diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 5abdd706b0..bdac360d29 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -416,8 +416,8 @@ Topics: #- Name: Configuring the web console # File: configuring-web-console # Distros: openshift-rosa -#- Name: Customizing the web console -# File: customizing-the-web-console +- Name: Customizing the web console + File: customizing-the-web-console # Distros: openshift-rosa - Name: Dynamic plugins Dir: dynamic-plugin diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 28ed11e1cb..06f14da41e 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -219,6 +219,8 @@ Topics: File: using-dashboard-to-get-cluster-information - Name: Adding user preferences File: adding-user-preferences +- Name: Customizing the web console + File: customizing-the-web-console - Name: Dynamic plugins Dir: dynamic-plugin Distros: openshift-rosa-hcp diff --git a/modules/adding-a-custom-logo.adoc b/modules/adding-a-custom-logo.adoc index 0af1b66141..9401248ed4 100644 --- a/modules/adding-a-custom-logo.adoc +++ b/modules/adding-a-custom-logo.adoc @@ -6,6 +6,7 @@ [id="adding-a-custom-logo_{context}"] = Adding a custom logo and product name +[role="_abstract"] You can create custom branding by adding a custom logo or custom product name. You can set both or one without the other, as these settings are independent of each other. .Prerequisites @@ -34,9 +35,9 @@ metadata: name: console-custom-logo namespace: openshift-config binaryData: - console-custom-logo.png: ... <1> + console-custom-logo.png: ... ---- -<1> Provide a valid base64-encoded logo. +Replace `` with a base64-encoded string of the logo. ==== . Edit the web console's Operator configuration to include `customLogoFile` and `customProductName`: @@ -62,7 +63,7 @@ spec: + Once the Operator configuration is updated, it will sync the custom logo config map into the console namespace, mount it to the console pod, and redeploy. -. Check for success. If there are any issues, the console cluster Operator will report a `Degraded` status, and the console Operator configuration will also report a `CustomLogoDegraded` status, but with reasons like `KeyOrFilenameInvalid` or `NoImageProvided`. +. Check for success. If there are any issues, the console cluster Operator will report a `Degraded` status, and the console Operator configuration will also report a `CustomLogoDegraded` status, but with reasons such as `KeyOrFilenameInvalid` or `NoImageProvided`. + To check the `clusteroperator`, run: + diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index 8c0642c797..3e385659d0 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -1,23 +1,32 @@ :_mod-docs-content-type: ASSEMBLY [id="customizing-web-console"] = Customizing the web console in {product-title} + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: customizing-web-console toc::[] -You can customize the {product-title} web console to set a custom logo, -product name, links, notifications, and command-line downloads. This is -especially helpful if you need to tailor the web console to meet specific -corporate or government requirements. +[role="_abstract"] +You can customize the +ifndef::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +web console to set +ifndef::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +a custom logo, product name, links, notifications, and command-line downloads. +endif::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +a custom logo and product name. +endif::openshift-rosa-hcp,openshift-rosa,openshift-dedicated[] +This is especially helpful if you need to tailor the web console to meet specific corporate or government requirements. -// Hiding in ROSA/OSD, as Hive overwrites changes to console config -ifndef::openshift-rosa,openshift-dedicated[] include::modules/adding-a-custom-logo.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] - // Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consolelinks" ifndef::openshift-rosa,openshift-dedicated[] include::modules/creating-custom-links.adoc[leveloffset=+1] @@ -42,7 +51,7 @@ include::modules/adding-custom-notification-banners.adoc[leveloffset=+1] // Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "customresourcedefinitions" include::modules/customizing-cli-downloads.adoc[leveloffset=+1] -// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "customresourcedefinitions" +// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "customresourcedefinitions" include::modules/adding-yaml-examples-to-kube-resources.adoc[leveloffset=+1] // Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consoles" @@ -72,7 +81,7 @@ endif::openshift-rosa,openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc[leveloffset=+2] -// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "consoles" +// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "consoles" include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3] endif::openshift-rosa,openshift-dedicated[]