Skip to main content
logoTetrate Istio Subscription PlusVersion: Latest

Onboarding a Cluster

This guide walks you through the process of onboarding your Kubernetes cluster to Tetrate Istio Subscription Plus (TIS Plus). Ensure you have completed all the prerequisites and pre-checks outlined in the previous sections before proceeding.

Prerequisites​

Before onboarding a Workload Cluster, verify that you have:

  • Access to TIS Plus UI
  • Kubernetes cluster with Istio running
  • Completed all pre-checks

Onboarding Steps​

Using TIS Plus UI

You can also follow step by step guide in TIS Plus UI to onboard your cluster.

  1. Register the Workload Cluster in TIS Plus​

    Use tctl to register your cluster with TIS Plus:

    • Create a cluster configuration file named cluster-1.yaml:

      cat <<EOF > cluster-1.yaml
      apiVersion: api.tsb.tetrate.io/v2
      kind: Cluster
      metadata:
          name: cluster-1
          organization: <organization-name>
      EOF
      Organization Name

      Note: Replace <your-organization-name> with your TIS Plus organization name.

    • Apply the configuration using tctl:

      tctl apply -f cluster-1.yaml

    • Verify the cluster registration:

      tctl get cluster

      Your cluster should be listed.

  2. Obtain the TIS Plus Cluster Configuration​

    Acquire the cluster configuration for your newly registered cluster:

    tctl x cluster-install-template cluster-1 > cluster-1-values.yaml

    This configuration contains the necessary keys, certificates, addresses, and ports for secure communication between your cluster and the TIS Plus Management Plane. Keep this file secure.

  3. Install the Control Plane on the Workload Cluster​

    Use Helm to install the TIS Plus Control Plane on your cluster:

    warning

    Following install command will automatically configure TIS Plus filters in proxies to send Access Log Service (ALS) data and tracing information to TIS Plus.

    If you prefer to manually configure your proxy integration to TIS Plus, you can disable automatic filters creation. Make sure to follow steps explained in Configuring Mesh config after installation completed to update your existing Istio mesh config.

    export HUB=registry.example.com
export VERSION=1.11.0
export PULL_SECRET=tis-plus-pull-secret

helm upgrade --install tis-plus-cp tetrate-tsb-helm/controlplane \
  --version $VERSION \
  --namespace tis-plus-system --create-namespace \
  -f "cluster-1-values.yaml" \
  --set image.registry=$HUB \
  --set spec.hub=$HUB \
  --set spec.mode="OBSERVE" \
  --set operator.controlPlaneMode="OBSERVE" \
  --set operator.deletionProtection="disabled" \
  --set spec.imagePullSecrets[0].name=$PULL_SECRET \
  --set operator.serviceAccount.imagePullSecrets[0]=$PULL_SECRET

  4. Verify Control Plane Installation​

    Check the status of the TIS Plus Control Plane pods

    kubectl get pods -n istio-system

    All pods should be in the Running state.

Troubleshooting​

If you encounter issues during the onboarding process:

  • Ensure your tctl version matches your TIS Plus version.
  • Verify that your cluster meets all the prerequisites and passed all pre-checks.
  • Check the logs of the TIS Plus Control Plane operator pods for any error messages: 
    kubectl logs -n tis-plus-system deployment/control-plane-operator
  • Ensure your cluster has the necessary resources (CPU, memory) to run the TIS Plus components.
  • Verify that your network allows communication between your cluster and the TIS Plus Management Plane.

If issues persist, consult the TIS Plus documentation or contact Tetrate support for assistance.

Next Steps​

After successfully onboarding your cluster, proceed to the Post-Installation Actions to ensure TIS Plus is properly configured and functioning correctly with your Istio deployment.