feat: Customizing OpenShift Eclipse Che ConsoleLink

Signed-off-by: Anatolii Bazko <[email protected]>

modules/administration-guide/pages/configuring-dashboard.adoc

@@ -8,3 +8,6 @@
 = Configuring dashboard
 
 * xref:configuring-getting-started-samples.adoc[]
+
+* xref:customizing-openshift-che-consolelink.adoc[]
+

modules/administration-guide/pages/customizing-openshift-che-consolelink.adoc

@@ -0,0 +1,41 @@
+:_content-type: PROCEDURE
+:description: Customizing OpenShift Eclipse Che ConsoleLink
+:keywords: administration guide, customizing, consolelink
+:navtitle: Customizing OpenShift Eclipse Che ConsoleLink
+:page-aliases: installation-guide:customizing-openshift-che-consolelink.adoc
+
+[id="customizing-openshift-che-consolelink"]
+= Customizing {ocp} {prod} ConsoleLink
+
+This procedure describes how to customize {prod} ConsoleLink.
+
+.Prerequisites
+
+* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.
+
+.Procedure
+
+. Create a Secret:
++
+[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>
+type: Opaque
+EOF
+----
+<1> Base64 encoding with disabled line wrapping.
+
+. Wait until the rollout of {prod-deployment}-dashboard finishes.

modules/administration-guide/pages/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc

@@ -26,5 +26,7 @@ The mounting process uses the standard {platforms-name} mounting mechanism, but
 
 include::partial$proc_mounting-a-secret-or-a-configmap-as-a-file-into-a-container.adoc[leveloffset=+1]
 
+include::partial$proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc[leveloffset=+1]
+
 include::partial$proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc[leveloffset=+1]
 

modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc

@@ -0,0 +1,100 @@
+// Module included in the following assemblies:
+//
+// mounting-a-secret-or-a-configmap-as-a-file-or-an-environment-variable-into-a-container
+
+
+[id="mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container"]
+= Mounting a Secret or a ConfigMap as a subPath into a {prod-short} container
+
+
+.Prerequisites
+
+* A running instance of {prod}.
+
+.Procedure
+
+include::partial$snip_mounting-a-secret-or-a-configmap-into-a-container.adoc[leveloffset=+1]
+
+Annotations must indicate that the given object is mounted as a subPath.
+
+. Configure the annotation values:
++
+* `che.eclipse.org/mount-as: subpath` - To indicate that an object is mounted as a subPath.
+* `che.eclipse.org/mount-path: _<TARGET_PATH>_` - To provide a required mount path.
+
+.Example:
+====
+[source,yaml]
+----
+apiVersion: v1
+kind: Secret
+metadata:
+  name: custom-data
+  annotations:
+    che.eclipse.org/mount-as: subpath
+    che.eclipse.org/mount-path: /data
+  labels:
+...
+----
+or
+[source,yaml]
+----
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: custom-data
+  annotations:
+    che.eclipse.org/mount-as: subpath
+    che.eclipse.org/mount-path: /data
+  labels:
+...
+----
+====
+
+The {orch-name} object can contain several items whose names must match the desired file name mounted into the container.
+
+.Example:
+====
+[source,yaml,subs="+quotes,attributes"]
+----
+apiVersion: v1
+kind: Secret
+metadata:
+  name: custom-data
+  labels:
+    app.kubernetes.io/part-of: che.eclipse.org
+    app.kubernetes.io/component: {prod-deployment}-secret
+  annotations:
+    che.eclipse.org/mount-as: subpath
+    che.eclipse.org/mount-path: /data
+data:
+  ca.crt: __<base64 encoded data content here>__
+----
+or
+[source,yaml,subs="+quotes,attributes"]
+----
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: custom-data
+  labels:
+    app.kubernetes.io/part-of: che.eclipse.org
+    app.kubernetes.io/component: {prod-deployment}-configmap
+  annotations:
+    che.eclipse.org/mount-as: subpath
+    che.eclipse.org/mount-path: /data
+data:
+  ca.crt: __<data content here>__
+----
+====
+
+This results in a file named `ca.crt` being mounted at the `/data` path of {prod-short} container.
+
+IMPORTANT: To make the changes in a {prod-short} container visible, recreate the object entirely.
+
+.Additional resources
+
+* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
+
+* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
+

modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc

@@ -15,7 +15,7 @@
 
 include::partial$snip_mounting-a-secret-or-a-configmap-into-a-container.adoc[leveloffset=+1]
 
-Annotations must indicate that the given object is mounted as a environment variable.
+Annotations must indicate that the given object is mounted as an environment variable.
 
 . Configure the annotation values:
 +

modules/administration-guide/partials/snip_mounting-a-secret-or-a-configmap-into-a-container.adoc

@@ -13,7 +13,7 @@
 +
 * The `<DEPLOYMENT_NAME>` corresponds to the one following deployments:
 
-** `keycloak`
+** `{prod-deployment}-dashboard`
 ** `devfile-registry`
 ** `plugin-registry`
 ** `{prod-deployment}`