第 8 章 Importing a target managed cluster to the hub cluster
You can import clusters from different Kubernetes cloud providers. After you import, the targeted cluster becomes a managed cluster for the Red Hat Advanced Cluster Management for Kubernetes hub cluster. Unless otherwise specified, complete the import tasks anywhere where you can access the hub cluster and the targeted managed cluster.
A hub cluster cannot manage any other hub cluster; you must import an existing cluster.
Choose from the following instructions to set up your managed cluster, either from the console or from the CLI:
Required user type or access level: Cluster administrator
8.1. Importing an existing cluster with the console
After you install Red Hat Advanced Cluster Management for Kubernetes, you are ready to import a cluster to manage. You can import from both the console and the CLI. Follow this procedure to import from the console. You need your terminal for authentication during this procedure.
8.1.1. Prerequisites
- You need a Red Hat Advanced Cluster Management for Kubernetes hub cluster that is deployed. If you are importing bare metal clusters, you must have the hub cluster installed on Red Hat OpenShift Container Platform version 4.4, or later.
- You need a cluster that you want to manage and Internet connectivity.
-
Install
kubectl
. To installkubectl
, see Install and Set Up kubectl in the Kubernetes documentation.
-
You need the
base64
command line tool.
Required user type or access level: Cluster administrator
8.1.2. Importing a cluster
You can import existing clusters from the Red Hat Advanced Cluster Management for Kubernetes console for each of the available cloud providers.
A hub cluster cannot manage any other hub cluster; you must import an existing cluster.
- From the navigation menu, hover over Automate infrastructure and click Clusters.
- Click Add cluster.
- Click Import an existing cluster.
- Provide a cluster name. By default, the namespace is set to the same value as your cluster name. Best practice: Leave the namespace value and do not edit.
Optional: Click to expand Edit cluster import YAML file and modify the endpoint configuration.
See Table 1. YAML file parameters and descriptions for details about each parameter.
- Optional: After you import, you can add labels by clicking Configure advanced parameters and use these labels to search.
Optional: Configure the
MANAGED CLUSTER URLS
. By configuring theMANAGED CLUSTER URLS
, the URLs display in the table when you run theoc get managedcluster
command.-
If it is not already on, turn on the
YAML
content using the switch in the web console so you can view the content. Add the
manageClusterClientConfigs
section to theManagedCluster
spec in theimport.yaml
file, as shown in the following example:apiVersion: cluster.open-cluster-management.io/v1 kind: ManagedCluster metadata: labels: cloud: auto-detect vendor: auto-detect name: cluster-test name: cluster-test spec: hubAcceptsClient: true managedClusterClientConfigs: - url: https://multicloud-console.apps.new-managed.dev.redhat.com --- apiVersion: agent.open-cluster-management.io/v1 ...
Replace the URL value is the external access URL address of the managed cluster.
-
If it is not already on, turn on the
-
Click Generate Command to retrieve the command to deploy the
open-cluster-management-agent-addon
. - From the Import an existing cluster window, hover and click the Copy command icon to copy the import command and the token that you are provided. You must click the Copy icon to receive the accurate copy. Important: The command contains pull secret information that is copied to each of the imported clusters. Anyone who can access the imported clusters can also view the pull secret information. Consider creating a secondary pull secret at https://cloud.redhat.com/ or by creating a service account so your personal credentials are not compromised. See Using image pull secrets or Understanding and creating service accounts for more information.
From your terminal, authenticate to your managed cluster. Configure your
kubectl
for your targeted managed cluster.See Supported clouds to learn how to configure your
kubectl
.-
To deploy the
open-cluster-management-agent-addon
to the managed cluster, run the command that you generated and copied from step 8. - Click View cluster to view the Overview page and a summary of your cluster.
Note You can continue to import more clusters. Click Import another to repeat the process.
8.1.2.1. YAML parameters and descriptions
Table 1: The following table lists the parameters and descriptions that are available in the YAML file:
Parameter | Description | Default value |
---|---|---|
clusterLabels | Provide cluster labels; you can add labels to your file | none |
clusterLabels.cloud | The provider label for your cluster | auto-detect |
clusterLabels.vendor | The Kubernetes vendor label for your cluster | auto-detect |
clusterLabels.environment | The environment label for your cluster | none |
clusterLabels.region | The region where your cluster is set up | none |
applicationManager.enabled | Enables multicluster manager application deployment, deploys subscription controller and deployable controller | true |
searchCollector.enabled | Enables search collection and indexing | true |
policyController.enabled | Enable the Governance and risk dashboard policy feature | true, updateInterval: 15 |
certPolicyController.enabled | Monitors certificate expiration based on distributed policies | true |
iamPolicyController | Monitors identity controls based on distributed policies | true |
serviceRegistry.enabled | Service registry that is used to discover services that are deployed by Application Deployable among managed clusters. | false |
serviceRegistry.dnsSuffix | The suffix of the registry DNS name, which is added to the end of the target clusters dns domain name. | mcm.svc |
serviceRegistry.plugins |
Comma-separated list of enabled plugins. Supported plugins: | kube-service |
version |
Version of | 2.0 |
8.1.3. Removing an imported cluster
Complete the following procedure to remove an imported cluster and the open-cluster-management-agent-addon
that was created on the managed cluster.
- From the Clusters page, find your imported cluster in the table.
- Click Options > Detach cluster to remove your cluster from management.