docs: update branding images customization guide #3069
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,5 +19,5 @@ | |
|
|
||
| * xref:concealing-editors.adoc[] | ||
|
|
||
| * xref:customizing-openshift-che-branding-images.adoc[] | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| :_content-type: PROCEDURE | ||
| :description: Customizing OpenShift Eclipse Che branding images | ||
| :keywords: administration guide, customizing, branding, images | ||
| :navtitle: Customizing OpenShift Eclipse Che branding images | ||
| :page-aliases: installation-guide:customizing-openshift-che-consolelink-icon.adoc, customizing-openshift-che-consolelink-icon.adoc | ||
|
|
||
| [id="customizing-openshift-che-branding-images"] | ||
| = Customizing {ocp} {prod} branding images | ||
|
|
||
| This procedure describes how to customize {prod} branding images, such as the logo displayed in the {prod} dashboard and the link:https://docs.openshift.com/container-platform/{ocp4-ver}/rest_api/console_apis/consolelink-console-openshift-io-v1.html[ConsoleLink] icon. | ||
|
|
||
| The branding images are located in the `assets/branding` directory. Supported image formats, in priority order: `jpg`, `jpeg`, `png`, `gif`, `webp`, `svg`. The `svg` format is used as the default fallback. | ||
|
gtrivedi88 marked this conversation as resolved.
Outdated
|
||
|
|
||
| .Prerequisites | ||
|
|
||
| * An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Create a Secret to override branding images: | ||
|
gtrivedi88 marked this conversation as resolved.
Outdated
|
||
| + | ||
| [source,shell,subs="+quotes,+attributes"] | ||
| ---- | ||
| {orch-cli} apply -f - <<EOF | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: {prod-deployment}-dashboard-customization | ||
| namespace: {prod-namespace} | ||
| annotations: | ||
| che.eclipse.org/mount-as: subpath | ||
| che.eclipse.org/mount-path: /public/dashboard/assets/branding | ||
| labels: | ||
| app.kubernetes.io/component: {prod-deployment}-dashboard-secret | ||
| app.kubernetes.io/part-of: che.eclipse.org | ||
| data: | ||
| loader.svg: __<Base64_encoded_content_of_the_image>__ <1> | ||
|
gtrivedi88 marked this conversation as resolved.
Outdated
|
||
| favicon.ico: __<Base64_encoded_content_of_the_image>__ <2> | ||
| type: Opaque | ||
| EOF | ||
| ---- | ||
| <1> The loader image file name and Base64-encoded content with disabled line wrapping. You can use any supported format (`jpg`, `jpeg`, `png`, `gif`, `webp`, `svg`). For example, `loader.png` with its Base64-encoded content. | ||
|
gtrivedi88 marked this conversation as resolved.
Outdated
|
||
| <2> The favicon file name and Base64-encoded content with disabled line wrapping. | ||
| + | ||
| NOTE: You can override one or all images from the `/public/dashboard/assets/branding` directory. Only the images specified in the Secret `data` section are overridden; unspecified images remain unchanged. | ||
|
Contributor
There was a problem hiding this comment. not clear where |
||
|
|
||
| . Wait until the rollout of {prod-deployment}-dashboard finishes. | ||
|
gtrivedi88 marked this conversation as resolved.
Outdated
|
||
|
|
||
| .Additional resources | ||
|
|
||
| * link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/customizing-the-web-console.html#creating-custom-links_customizing-web-console[Creating custom links in the web console] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have fixed it.