Skip to content

Commit d13baaf

Browse files
authored
Merge pull request #46423 from opayne1/OSDOCS-2478--2
OSDOCS-2478: Multicluster console
2 parents 8193928 + 6535cfe commit d13baaf

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/web-console.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="enable-multi-cluster-console_{context}"]
7+
= Enabling multicluster in the web console
8+
9+
:FeatureName: Multicluster console
10+
include::snippets/technology-preview.adoc[leveloffset=+1]
11+
//
12+
13+
.Prerequisites
14+
* Your cluster must be using the latest version of {product-title}.
15+
* You must have link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.5/html/install/index[Red Hat Advanced Cluster Management (ACM) for Kubernetes 2.5] or the link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.5/html/multicluster_engine_operator/index[multiculster engine (MCE) Operator] installed.
16+
* You must have administrator privileges.
17+
18+
[WARNING]
19+
====
20+
Do not set this feature gate on production clusters. You will not be able to upgrade your cluster after applying the feature gate, and it cannot be undone.
21+
====
22+
23+
.Procedure
24+
25+
. Log in to the {product-title} web console using your credentials.
26+
27+
. Enable ACM in the administrator perspective by navigating from *Administration* -> *Cluster Settings* -> *Configuration* -> *Console* `console.operator.openshift.io` -> *Console Plugins* and click *Enable* for `acm`.
28+
29+
. A pop-up window will appear notifying you that updating the enablement of this console plug-in will prompt for the console to be refreshed once it has been updated. Select `Enable` and click *Save*.
30+
31+
. Repeat the previous two steps for the `mce` console plug-in immediately after enabling `acm`.
32+
33+
. A pop-up window that states that a web console update is available will appear a few moments after you enable. Click *Refresh the web console* in the pop-up window to update.
34+
+
35+
[Note]
36+
====
37+
You might see the pop-up window to refresh the web console twice if the second redeployment has not occurred by the time you click *Refresh the web console*.
38+
====
39+
40+
** *local-cluster* and *All Clusters* is now visible above the perspectives in the navigation section.
41+
42+
. Enable the feature gate by navigating from *Administration* -> *Cluster Settings* -> *Configuration* -> *FeatureGate*, and edit the YAML template as follows:
43+
+
44+
[source,yaml]
45+
46+
----
47+
spec:
48+
featureSet: TechPreviewNoUpgrade
49+
----
50+
51+
. Click *Save* to enable the multicluster console for all clusters.
52+
+
53+
[IMPORTANT]
54+
====
55+
After you save, this feature is enabled and cannot be undone.
56+
====

modules/multi-cluster-about.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/web-console.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="multi-cluster-about_{context}"]
7+
= Multicluster console
8+
9+
The multicluster console provides a single interface with consistent design for the hybrid cloud console. If you enable the feature, you can switch between Advanced Cluster Management (ACM) and the cluster console in the same browser tab. It provides a simplified and consistent design that allows for shared components.

web_console/web-console.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ Platform 4.x Tested Integrations] page before you create the supporting
2121
infrastructure for your cluster.
2222

2323
include::modules/web-console-overview.adoc[leveloffset=+1]
24+
include::modules/multi-cluster-about.adoc[leveloffset=+1]
25+
include::modules/enabling-multi-cluster-console.adoc[leveloffset=+2]
26+
27+
[role="_additional-resources"]
28+
.Additional resources
29+
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc[Enabling feature sets using the web console]

0 commit comments

Comments
 (0)