Jump To Close Expand all Collapse all Table of contents multicluster engine 1. Requirements and recommendations Expand section "1. Requirements and recommendations" Collapse section "1. Requirements and recommendations" 1.1. Supported operating systems and platforms for multicluster engine for Kubernetes clusters and managed clusters 1.2. Network configuration Expand section "1.2. Network configuration" Collapse section "1.2. Network configuration" 1.2.1. The multicluster engine for Kubernetes operator cluster networking requirements 1.2.2. Managed cluster networking requirements 1.2.3. Hosted control planes networking requirements (Technology Preview) 2. Getting started Expand section "2. Getting started" Collapse section "2. Getting started" 2.1. Introduction 2.2. Create and manage clusters 2.3. ManifestWork example 3. Installing while connected online Expand section "3. Installing while connected online" Collapse section "3. Installing while connected online" 3.1. Prerequisites 3.2. Confirm your OpenShift Container Platform installation 3.3. Installing from the OperatorHub web console interface 3.4. Installing from the OpenShift Container Platform CLI 3.5. Installing on infrastructure nodes Expand section "3.5. Installing on infrastructure nodes" Collapse section "3.5. Installing on infrastructure nodes" 3.5.1. Add infrastructure nodes to the OpenShift Container Platform cluster 3.5.2. Operator Lifecycle Manager Subscription additional configuration 3.5.3. MultiClusterEngine custom resource additional configuration 4. Install on disconnected networks Expand section "4. Install on disconnected networks" Collapse section "4. Install on disconnected networks" 4.1. Prerequisites 4.2. Confirm your OpenShift Container Platform installation 4.3. Installing in a disconnected environment 5. Console overview 6. Advanced configuration Expand section "6. Advanced configuration" Collapse section "6. Advanced configuration" 6.1. Custom image pull secret 6.2. Target namespace 6.3. availabilityConfig 6.4. nodeSelector 6.5. tolerations 6.6. ManagedServiceAccount add-on (Technology Preview) 6.7. Hypershift add-on (Technology Preview) 7. Enabling ManagedServiceAccount add-ons (Technology Preview) Expand section "7. Enabling ManagedServiceAccount add-ons (Technology Preview)" Collapse section "7. Enabling ManagedServiceAccount add-ons (Technology Preview)" 7.1. Prerequisites 7.2. Enabling ManagedServiceAccount 8. Creating a cluster Expand section "8. Creating a cluster" Collapse section "8. Creating a cluster" 8.1. Prerequisites 8.2. Create a cluster with ClusterDeployment 8.3. Create a cluster with ClusterPool 9. Importing a cluster Expand section "9. Importing a cluster" Collapse section "9. Importing a cluster" 9.1. Prerequisites 9.2. Prepare for import 9.3. Importing with the auto import secret 9.4. Importing with manual command 9.5. Detaching a managed cluster 10. Deploying workload with ManifestWork 11. APIs Expand section "11. APIs" Collapse section "11. APIs" 11.1. Clusters API Expand section "11.1. Clusters API" Collapse section "11.1. Clusters API" 11.1.1. Overview Expand section "11.1.1. Overview" Collapse section "11.1.1. Overview" 11.1.1.1. URI scheme 11.1.1.2. Tags 11.1.2. Paths Expand section "11.1.2. Paths" Collapse section "11.1.2. Paths" 11.1.2.1. Query all clusters Expand section "11.1.2.1. Query all clusters" Collapse section "11.1.2.1. Query all clusters" 11.1.2.1.1. Description 11.1.2.1.2. Parameters 11.1.2.1.3. Responses 11.1.2.1.4. Consumes 11.1.2.1.5. Tags 11.1.2.2. Create a cluster Expand section "11.1.2.2. Create a cluster" Collapse section "11.1.2.2. Create a cluster" 11.1.2.2.1. Description 11.1.2.2.2. Parameters 11.1.2.2.3. Responses 11.1.2.2.4. Consumes 11.1.2.2.5. Tags 11.1.2.2.6. Example HTTP request Expand section "11.1.2.2.6. Example HTTP request" Collapse section "11.1.2.2.6. Example HTTP request" 11.1.2.2.6.1. Request body 11.1.2.3. Query a single cluster Expand section "11.1.2.3. Query a single cluster" Collapse section "11.1.2.3. Query a single cluster" 11.1.2.3.1. Description 11.1.2.3.2. Parameters 11.1.2.3.3. Responses 11.1.2.3.4. Tags 11.1.2.4. Delete a cluster Expand section "11.1.2.4. Delete a cluster" Collapse section "11.1.2.4. Delete a cluster" 11.1.2.4.1. Description 11.1.2.4.2. Parameters 11.1.2.4.3. Responses 11.1.2.4.4. Tags 11.1.3. Definitions Expand section "11.1.3. Definitions" Collapse section "11.1.3. Definitions" 11.1.3.1. Cluster 11.2. Clustersets API (v1alpha1) Expand section "11.2. Clustersets API (v1alpha1)" Collapse section "11.2. Clustersets API (v1alpha1)" 11.2.1. Overview Expand section "11.2.1. Overview" Collapse section "11.2.1. Overview" 11.2.1.1. URI scheme 11.2.1.2. Tags 11.2.2. Paths Expand section "11.2.2. Paths" Collapse section "11.2.2. Paths" 11.2.2.1. Query all clustersets Expand section "11.2.2.1. Query all clustersets" Collapse section "11.2.2.1. Query all clustersets" 11.2.2.1.1. Description 11.2.2.1.2. Parameters 11.2.2.1.3. Responses 11.2.2.1.4. Consumes 11.2.2.1.5. Tags 11.2.2.2. Create a clusterset Expand section "11.2.2.2. Create a clusterset" Collapse section "11.2.2.2. Create a clusterset" 11.2.2.2.1. Description 11.2.2.2.2. Parameters 11.2.2.2.3. Responses 11.2.2.2.4. Consumes 11.2.2.2.5. Tags 11.2.2.2.6. Example HTTP request Expand section "11.2.2.2.6. Example HTTP request" Collapse section "11.2.2.2.6. Example HTTP request" 11.2.2.2.6.1. Request body 11.2.2.3. Query a single clusterset Expand section "11.2.2.3. Query a single clusterset" Collapse section "11.2.2.3. Query a single clusterset" 11.2.2.3.1. Description 11.2.2.3.2. Parameters 11.2.2.3.3. Responses 11.2.2.3.4. Tags 11.2.2.4. Delete a clusterset Expand section "11.2.2.4. Delete a clusterset" Collapse section "11.2.2.4. Delete a clusterset" 11.2.2.4.1. Description 11.2.2.4.2. Parameters 11.2.2.4.3. Responses 11.2.2.4.4. Tags 11.2.3. Definitions Expand section "11.2.3. Definitions" Collapse section "11.2.3. Definitions" 11.2.3.1. Clusterset 11.3. Clusterview API (v1alpha1) Expand section "11.3. Clusterview API (v1alpha1)" Collapse section "11.3. Clusterview API (v1alpha1)" 11.3.1. Overview Expand section "11.3.1. Overview" Collapse section "11.3.1. Overview" 11.3.1.1. URI scheme 11.3.1.2. Tags 11.3.2. Paths Expand section "11.3.2. Paths" Collapse section "11.3.2. Paths" 11.3.2.1. Get managed clusters Expand section "11.3.2.1. Get managed clusters" Collapse section "11.3.2.1. Get managed clusters" 11.3.2.1.1. Description 11.3.2.1.2. Parameters 11.3.2.1.3. Responses 11.3.2.1.4. Consumes 11.3.2.1.5. Tags 11.3.2.2. List managed clusters Expand section "11.3.2.2. List managed clusters" Collapse section "11.3.2.2. List managed clusters" 11.3.2.2.1. Description 11.3.2.2.2. Parameters 11.3.2.2.3. Responses 11.3.2.2.4. Consumes 11.3.2.2.5. Tags 11.3.2.2.6. Example HTTP request Expand section "11.3.2.2.6. Example HTTP request" Collapse section "11.3.2.2.6. Example HTTP request" 11.3.2.2.6.1. Request body 11.3.2.3. Watch the managed cluster sets Expand section "11.3.2.3. Watch the managed cluster sets" Collapse section "11.3.2.3. Watch the managed cluster sets" 11.3.2.3.1. Description 11.3.2.3.2. Parameters 11.3.2.3.3. Responses 11.3.2.4. List the managed cluster sets. Expand section "11.3.2.4. List the managed cluster sets." Collapse section "11.3.2.4. List the managed cluster sets." 11.3.2.4.1. Description 11.3.2.4.2. Parameters 11.3.2.4.3. Responses 11.3.2.5. List the managed cluster sets. Expand section "11.3.2.5. List the managed cluster sets." Collapse section "11.3.2.5. List the managed cluster sets." 11.3.2.5.1. Description 11.3.2.5.2. Parameters 11.3.2.5.3. Responses 11.3.2.6. Watch the managed cluster sets. Expand section "11.3.2.6. Watch the managed cluster sets." Collapse section "11.3.2.6. Watch the managed cluster sets." 11.3.2.6.1. Description 11.3.2.6.2. Parameters 11.3.2.6.3. Responses 11.4. Clustersetbindings API (v1alpha1) Expand section "11.4. Clustersetbindings API (v1alpha1)" Collapse section "11.4. Clustersetbindings API (v1alpha1)" 11.4.1. Overview Expand section "11.4.1. Overview" Collapse section "11.4.1. Overview" 11.4.1.1. URI scheme 11.4.1.2. Tags 11.4.2. Paths Expand section "11.4.2. Paths" Collapse section "11.4.2. Paths" 11.4.2.1. Query all clustersetbindings Expand section "11.4.2.1. Query all clustersetbindings" Collapse section "11.4.2.1. Query all clustersetbindings" 11.4.2.1.1. Description 11.4.2.1.2. Parameters 11.4.2.1.3. Responses 11.4.2.1.4. Consumes 11.4.2.1.5. Tags 11.4.2.2. Create a clustersetbinding Expand section "11.4.2.2. Create a clustersetbinding" Collapse section "11.4.2.2. Create a clustersetbinding" 11.4.2.2.1. Description 11.4.2.2.2. Parameters 11.4.2.2.3. Responses 11.4.2.2.4. Consumes 11.4.2.2.5. Tags 11.4.2.2.6. Example HTTP request Expand section "11.4.2.2.6. Example HTTP request" Collapse section "11.4.2.2.6. Example HTTP request" 11.4.2.2.6.1. Request body 11.4.2.3. Query a single clustersetbinding Expand section "11.4.2.3. Query a single clustersetbinding" Collapse section "11.4.2.3. Query a single clustersetbinding" 11.4.2.3.1. Description 11.4.2.3.2. Parameters 11.4.2.3.3. Responses 11.4.2.3.4. Tags 11.4.2.4. Delete a clustersetbinding Expand section "11.4.2.4. Delete a clustersetbinding" Collapse section "11.4.2.4. Delete a clustersetbinding" 11.4.2.4.1. Description 11.4.2.4.2. Parameters 11.4.2.4.3. Responses 11.4.2.4.4. Tags 11.4.3. Definitions Expand section "11.4.3. Definitions" Collapse section "11.4.3. Definitions" 11.4.3.1. Clustersetbinding 11.5. API Expand section "11.5. API" Collapse section "11.5. API" 11.5.1. Overview Expand section "11.5.1. Overview" Collapse section "11.5.1. Overview" 11.5.1.1. URI scheme 11.5.1.2. Tags 11.5.2. Paths Expand section "11.5.2. Paths" Collapse section "11.5.2. Paths" 11.5.2.1. Create a MultiClusterEngine Expand section "11.5.2.1. Create a MultiClusterEngine" Collapse section "11.5.2.1. Create a MultiClusterEngine" 11.5.2.1.1. Description 11.5.2.1.2. Parameters 11.5.2.1.3. Responses 11.5.2.1.4. Consumes 11.5.2.1.5. Tags Expand section "11.5.2.1.5. Tags" Collapse section "11.5.2.1.5. Tags" 11.5.2.1.5.1. Request body 11.5.2.2. Query all MultiClusterEngines Expand section "11.5.2.2. Query all MultiClusterEngines" Collapse section "11.5.2.2. Query all MultiClusterEngines" 11.5.2.2.1. Description 11.5.2.2.2. Parameters 11.5.2.2.3. Responses 11.5.2.2.4. Consumes 11.5.2.2.5. Tags 11.5.2.3. Delete a MultiClusterEngine operator Expand section "11.5.2.3. Delete a MultiClusterEngine operator" Collapse section "11.5.2.3. Delete a MultiClusterEngine operator" 11.5.2.3.1. Parameters 11.5.2.3.2. Responses 11.5.2.3.3. Tags 11.5.3. Definitions Expand section "11.5.3. Definitions" Collapse section "11.5.3. Definitions" 11.5.3.1. MultiClusterEngine 11.5.3.2. List of specs 11.6. Placements API (v1alpha1) Expand section "11.6. Placements API (v1alpha1)" Collapse section "11.6. Placements API (v1alpha1)" 11.6.1. Overview Expand section "11.6.1. Overview" Collapse section "11.6.1. Overview" 11.6.1.1. URI scheme 11.6.1.2. Tags 11.6.2. Paths Expand section "11.6.2. Paths" Collapse section "11.6.2. Paths" 11.6.2.1. Query all Placements Expand section "11.6.2.1. Query all Placements" Collapse section "11.6.2.1. Query all Placements" 11.6.2.1.1. Description 11.6.2.1.2. Parameters 11.6.2.1.3. Responses 11.6.2.1.4. Consumes 11.6.2.1.5. Tags 11.6.2.2. Create a Placement Expand section "11.6.2.2. Create a Placement" Collapse section "11.6.2.2. Create a Placement" 11.6.2.2.1. Description 11.6.2.2.2. Parameters 11.6.2.2.3. Responses 11.6.2.2.4. Consumes 11.6.2.2.5. Tags 11.6.2.2.6. Example HTTP request Expand section "11.6.2.2.6. Example HTTP request" Collapse section "11.6.2.2.6. Example HTTP request" 11.6.2.2.6.1. Request body 11.6.2.3. Query a single Placement Expand section "11.6.2.3. Query a single Placement" Collapse section "11.6.2.3. Query a single Placement" 11.6.2.3.1. Description 11.6.2.3.2. Parameters 11.6.2.3.3. Responses 11.6.2.3.4. Tags 11.6.2.4. Delete a Placement Expand section "11.6.2.4. Delete a Placement" Collapse section "11.6.2.4. Delete a Placement" 11.6.2.4.1. Description 11.6.2.4.2. Parameters 11.6.2.4.3. Responses 11.6.2.4.4. Tags 11.6.3. Definitions Expand section "11.6.3. Definitions" Collapse section "11.6.3. Definitions" 11.6.3.1. Placement 11.7. PlacementDecisions API (v1alpha1) Expand section "11.7. PlacementDecisions API (v1alpha1)" Collapse section "11.7. PlacementDecisions API (v1alpha1)" 11.7.1. Overview Expand section "11.7.1. Overview" Collapse section "11.7.1. Overview" 11.7.1.1. URI scheme 11.7.1.2. Tags 11.7.2. Paths Expand section "11.7.2. Paths" Collapse section "11.7.2. Paths" 11.7.2.1. Query all PlacementDecisions Expand section "11.7.2.1. Query all PlacementDecisions" Collapse section "11.7.2.1. Query all PlacementDecisions" 11.7.2.1.1. Description 11.7.2.1.2. Parameters 11.7.2.1.3. Responses 11.7.2.1.4. Consumes 11.7.2.1.5. Tags 11.7.2.2. Create a PlacementDecision Expand section "11.7.2.2. Create a PlacementDecision" Collapse section "11.7.2.2. Create a PlacementDecision" 11.7.2.2.1. Description 11.7.2.2.2. Parameters 11.7.2.2.3. Responses 11.7.2.2.4. Consumes 11.7.2.2.5. Tags 11.7.2.2.6. Example HTTP request Expand section "11.7.2.2.6. Example HTTP request" Collapse section "11.7.2.2.6. Example HTTP request" 11.7.2.2.6.1. Request body 11.7.2.3. Query a single PlacementDecision Expand section "11.7.2.3. Query a single PlacementDecision" Collapse section "11.7.2.3. Query a single PlacementDecision" 11.7.2.3.1. Description 11.7.2.3.2. Parameters 11.7.2.3.3. Responses 11.7.2.3.4. Tags 11.7.2.4. Delete a PlacementDecision Expand section "11.7.2.4. Delete a PlacementDecision" Collapse section "11.7.2.4. Delete a PlacementDecision" 11.7.2.4.1. Description 11.7.2.4.2. Parameters 11.7.2.4.3. Responses 11.7.2.4.4. Tags 11.7.3. Definitions Expand section "11.7.3. Definitions" Collapse section "11.7.3. Definitions" 11.7.3.1. PlacementDecision 11.8. Managed service account (Technology Preview) Expand section "11.8. Managed service account (Technology Preview)" Collapse section "11.8. Managed service account (Technology Preview)" 11.8.1. Overview Expand section "11.8.1. Overview" Collapse section "11.8.1. Overview" 11.8.1.1. URI scheme 11.8.1.2. Tags 11.8.2. Paths Expand section "11.8.2. Paths" Collapse section "11.8.2. Paths" 11.8.2.1. Create a ManagedServiceAccount Expand section "11.8.2.1. Create a ManagedServiceAccount" Collapse section "11.8.2.1. Create a ManagedServiceAccount" 11.8.2.1.1. Description 11.8.2.1.2. Parameters 11.8.2.1.3. Responses 11.8.2.1.4. Consumes 11.8.2.1.5. Tags Expand section "11.8.2.1.5. Tags" Collapse section "11.8.2.1.5. Tags" 11.8.2.1.5.1. Request body 11.8.2.2. Query a single ManagedServiceAccount Expand section "11.8.2.2. Query a single ManagedServiceAccount" Collapse section "11.8.2.2. Query a single ManagedServiceAccount" 11.8.2.2.1. Description 11.8.2.2.2. Parameters 11.8.2.2.3. Responses 11.8.2.2.4. Tags 11.8.2.3. Delete a ManagedServiceAccount Expand section "11.8.2.3. Delete a ManagedServiceAccount" Collapse section "11.8.2.3. Delete a ManagedServiceAccount" 11.8.2.3.1. Description 11.8.2.3.2. Parameters 11.8.2.3.3. Responses 11.8.2.3.4. Tags 11.8.3. Definitions Expand section "11.8.3. Definitions" Collapse section "11.8.3. Definitions" 11.8.3.1. ManagedServiceAccount 12. Uninstalling Expand section "12. Uninstalling" Collapse section "12. Uninstalling" 12.1. Prerequisite: Detach enabled services 12.2. Removing resources by using commands 12.3. Deleting the components by using the console 12.4. Troubleshooting Uninstall 13. Running the must-gather command to troubleshoot Expand section "13. Running the must-gather command to troubleshoot" Collapse section "13. Running the must-gather command to troubleshoot" 13.1. Must-gather scenarios 13.2. Must-gather procedure 13.3. Must-gather in a disconnected environment Legal Notice Settings Close Language: 简体中文 日本語 한국어 English Language: 简体中文 日本語 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 简体中文 日本語 한국어 English Language: 简体中文 日本語 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF multicluster engine Red Hat Advanced Cluster Management for Kubernetes 2.5Read more to learn how to use multicluster engine operator.Legal NoticeAbstract Read more to learn how to use multicluster engine. Next