Connect a cluster

Connecting your clusters in the PDS platform:

• Allows for centralized management of multiple clusters from a single interface.
• Provides a holistic view of the entire infrastructure, including storage, nodes, volumes, pods, and alerts.
• Efficiently execute tasks across the infrastructure, such as deploying applications, managing storage, and handling node configurations.
• Facilitate effective resource allocation and scaling strategies.
• Facilitate efficient troubleshooting by providing centralized access to diagnostic information, logs, and configurations.
• Enables uniform user access and permissions across connected clusters.

You can connect a cluster using one of the following two methods:

• The default manifest provided by the PDS platform
• By generating a custom manifest

Connect a cluster using the default manifest

To connect your cluster to Portworx within the PDS platform:

1. In the Clusters page, select the Connect Cluster button.

2. In the Connect clusters page -> Install Portworx Agent section, select View Default Manifest.

3. In the Manifest page, copy the manifest file and save it in your system.

   This is a pre-defined, standard manifest file for the Portworx agent installation. This manifest file is a collection of Kubernetes definitions, which are part of a Helm chart for a service named px-bootstrapper. These definitions are used to create the resources in a Kubernetes cluster.

4. In the Manifest page, select Connect cluster to go back to the cluster connection page.

5. Copy the kubectl apply -f manifest.yaml command.

   This command includes the necessary parameters and the encrypted bearer token.

6. Access the terminal or CLI of the target cluster where you want to install the Portworx agent.

7. Paste the copied kubectl apply command, replace the <path/to/downloaded/manifest/file> with the path where you saved the manifest file, and then run the command.

   Your cluster is now connected to the PDS platform, and it will appear in the Clusters Overview page.

Connect a cluster using the custom manifest

Generating a custom manifest in the PDS platform allows you to tailor your cluster connection settings to meet specific requirements. This process is essential when you need to configure custom image registries, set up proxy configurations, or include security certificates. By generating a custom manifest, you can ensure your clusters are properly configured for optimal performance, security, and compatibility with their organization's infrastructure. This flexibility empowers you to manage your data services more efficiently and align your cluster configurations with your unique operational needs.

note

This is an optional procedure.

1. In the Connect clusters page -> Install Portworx Agent section, select Generate Custom Manifest.

2. In the Generate Custom Manifest (optional) window:

   • Cluster Name: Enter the name of your cluster.
   • If you need to configure a custom image registry, then fill in the following fields in the Custom Image Registry Configuration (Optional) section:
     • Registry URL: Enter the URL of your image registry.
     • Registry Namespace: Specify the namespace for the registry.
     • Username: Provide the username for accessing the registry.
     • Password: Enter the password associated with the username.
     • CA Certificate: If a CA certificate is required, paste it into the provided text area.
   • If your cluster requires a proxy configuration, then complete the following details in the Proxy Configuration (Optional) section:
     • Http URL: Enter the HTTP URL for the proxy.
     • Https URL: Enter the HTTPS URL for the proxy.
     • No Proxy: Specify any addresses that should bypass the proxy.
     • Username: Provide the username for proxy authentication.
     • Password: Input the password for the proxy.
     • CA Certificate: If a CA certificate is needed for the proxy, paste it into the provided text area.

3. Select the View Custom Manifest button to generate the manifest.

4. In the Manifest page, copy the manifest file and save it in your system.

5. In the Manifest page, select Connect cluster to go back to the cluster connection page.

6. Copy the kubectl apply -f manifest.yaml command.

7. Access the terminal or CLI of the target cluster where you want to install the Portworx agent.

8. Paste the copied kubectl apply command, replace the <path/to/downloaded/manifest/file> with the path where you saved the manifest file, and then run the command.

   Your cluster is now connected to the PDS platform, and it will appear in the Clusters Overview page.

note

After onboarding, navigate to the Clusters Overview page to verify whether the cluster is healthy or if it is in an error state. Ensure the cluster is in a healthy state before proceeding with deployments.