1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-15995 - Customizing branding in ROSA and OSD

This commit is contained in:
Olga Tikhomirova
2025-11-01 20:34:39 -07:00
committed by openshift-cherrypick-robot
parent 38359acb3a
commit 60870610be
5 changed files with 29 additions and 17 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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: <base64-encoded_logo> ... <1>
console-custom-logo.png: <base64-encoded_logo> ...
----
<1> Provide a valid base64-encoded logo.
Replace `<base64-encoded_logo>` 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:
+

View File

@@ -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[]