Skip to main content
Version: 3.12-dev

Add Cluster

This page provides comprehensive instructions on how to integrate an external cluster into the KubeRocketCI workloads. By doing so, it creates an opportunity for users to employ multi-cluster deployment, thereby facilitating the segregation of different environments across various clusters.

Prerequisites​

Before moving ahead, ensure you have already performed the guidelines outlined in the Argo CD Integration page. Besides, user needs to have a cluster admin role to add clusters.

Integrate External Cluster​

To deploy an application to a remote cluster, follow the steps below:

  1. Navigate to Configuration -> Deployment -> Clusters and click the + Add cluster button:

    Clusters menu

  2. In the Add cluster window, choose the credentials type and specify the required fields. Click the Save button to add the cluster:

    • Cluster Name: a unique and descriptive name for the external cluster;
    • Cluster Host: the cluster’s endpoint URL (e.g., example-cluster-domain.com);
    • Cluster Token: a Kubernetes token with permissions to access the cluster. This token is required for proper authorization;
    • Skip TLS verification: allows connect to cluster without cluster certificate verification;
    • Cluster Certificate: a Kubernetes certificate essential for authentication. Obtain this certificate from the configuration file of the user account you intend to use for accessing the cluster.
    note

    The Cluster Certificate field is hidden if the skip TLS verification option is enabled.

    Add cluster

  3. As soon as the cluster is added, switch the KubeRocketCI portal to the Kubernetes mode:

    Switch to K8s

  4. In the Configuration section, select Config maps:

    Config maps

  5. In the Config maps list, enter the krci-config config map:

    Edp config

  6. In the krci-config config map, click the pencil icon in the top right corner of the screen:

    Edit config map

  7. In the YAML file, add the available_clusters parameter, insert the cluster name, and click Save & apply:

    edp-config.yaml
    data:
      available_clusters: <cluster-name>

    Add new parameter

  8. Ensure the available_clusters parameter is added into the config map:

    Check added parameter

Integrate ArgoCD with External Cluster​

apiVersion: v1
kind: Secret
metadata:
  name: <cluster-name>-cluster
  namespace: argocd
  labels:
    argocd.argoproj.io/secret-type: cluster
stringData:
  config: |
  {
    "tlsClientConfig": {
      "insecure": false,
      "caData": ""
    },
    "bearerToken": ""
  }
  name: "<cluster-name>"
  server: "https://EXAMPLED539D4633E53DE1B71EXAMPLE.gr7.<AWS_REGION>.eks.amazonaws.com"

After applying the configuration, you can verify the cluster connection ArgoCD -> Settings -> Clusters -> <cluster-name>:

ArgoCD cluster IRSA status

Deploy application on new cluster​

Create Deployment Flow​

To create a deployment flow, follow the steps below:

  1. Navigate to the Deployment Flows tab and click the + Create Deployment Flow button.

  2. The Enter name tab of the Create Deployment Flow:

Create deployment flow

  1. Enter the deployment flow name that will be displayed in the Deployment Flows list. Enter at least two characters, use the lower-case letters, numbers, and dashes.

  2. Click the Next button to move onto the Add applications tab.

note

The namespace created by the environment has the following pattern combination: [KubeRocketCI namespace]-[environment name]-[stage name]. Please be aware that the namespace length should not exceed 63 symbols.

  1. The Component tab of the Environments menu is presented below:

Create deployment flow

  1. Click the Create button to finish deployment flow configuration and proceed with configuring environment.

  2. On the Environments menu, click the Create Environment button.

  3. The Configure Stage tab of the Create Stage menu is presented below:

Create environment

Set the proper cluster options:

  • Cluster - Choose the <cluster-name> to deploy the stage in;
  • Stage name - Enter the stage name;
  • Description - Enter the description for this stage;

  1. Click the Next button to move onto the Add quality gates tab.

  2. Click the Create button to start the provisioning of the pipeline. cluster-irsa-krci-deployed-application.png

Environment overview