Skip to main content

Connect a Kubernetes cluster

info

To move on, you'll need a new or existing Kubernetes cluster to which you can connect your new Argo CD instance.

The Akuity Platform's unique, hybrid architecture works with local clusters managed by the likes of k3d or kind just as easily as it works with any other cluster.

After your new Argo CD instance is created successfully (Healthy status next to your new instance's name):

  1. Navigate to Argo CD → your instance → Clusters.

  2. Click + Connect a cluster to add a Kubernetes cluster.

  3. Input your Cluster Name.

  4. Optionally, expand the Advanced settings menu and:

    1. Use the Installation Namespace field to deploy the agent to a different namespace. The default namespace is akuity.

      note

      Operators can only configure this setting during the initial deployment of the agent.

    2. Toggle Disable Auto Upgrade to prevent the agent from automatically upgrading its components.

      Manual Updates to the Akuity Agent

      With auto upgrades disabled, users must apply the agent updates manually. To accomplish this, go to the Clusters menu for the Argo CD instance and click Install Agent on the desired cluster, then run the provided command with the kubectl context set for the corresponding cluster.

    3. Toggle Namespace Scoped to limit the agent to only deploying resources into its namespace.

      note

      Operators can only configure this setting during the initial deployment of the agent.

    4. The State Replication toggle allows disconnecting the cluster from the Akuity Platform without losing core Argo CD features.

      note

      Operators can only configure this setting during the initial deployment of the agent.

    5. Enter where to pull the agent image from using the Akuity Custom Image Registry field. The default registry is quay.io/akuityio.

    6. Enter where to pull the Argo CD images from using the Argoproj Custom Image Registry field. The default registry is quay.io/argoproj.

    7. In the Agent Size section, choose the size of your Akuity Agent. This selection only impacts the resources allocated to the Akuity Agent within your cluster and does not impact your billing in any way.

    8. Add applicable labels and annotations as key/value pairs in the Labels and Annotations sections of the Advanced settings menu.

      • Click + Add to add a key/value pair.

      • Click the trash bin icon next to a key/value pair to delete it.

  5. Click Connect Cluster.

  6. In the Install Akuity Agent pop-up screen, click Copy to Clipboard

    caution

    Before pasting the next command, make sure you're connected to the correct cluster.

  7. Paste the copied command into your terminal and run it to apply the agent manifest.

Alternatively, you can download the agent manifest and apply it manually inside your cluster.

After installing the agent into your Kubernetes cluster, you should see the cluster listed in the Akuity dashboard with a green heart icon next to the cluster name.

Now that your Argo CD instance is connected to a Kubernetes cluster, move on to the next section to learn about enabling remote access to your instance.