> [!CAUTION]
> You are currently viewing version 1.10 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.10 </button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/install-check-cluster.html)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/install-check-cluster.html)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/install-check-cluster.html)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-check-cluster.html)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-check-cluster.html)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/install-check-cluster.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-check-cluster.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-check-cluster.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/install-check-cluster.html)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-check-cluster.html)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-check-cluster.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/install-check-cluster.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/install-check-cluster.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/install-check-cluster.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/install-check-cluster.html)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-check-cluster.html)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/install-check-cluster.html)

> [!WARNING]
>
> **Preview
> --- Pre-install cluster check**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

## Check hybrid cluster readiness

Before applying your configuration and installing the hybrid runtime, you should check
that your Kubernetes cluster is ready for Apigee hybrid installation.

> [!NOTE]
> Note. This feature is in public preview. The scope of the checks is limited.


To check the readiness of your cluster, you will create a YAML file with a Kubernetes Job definition and apply that file with `kubectl` commands to check the cluster.
You then check the status of the
Kubernetes test job with a `kubectl get jobs` command.

1. Verify that `kubectl` is set to the correct context using the following command. The current context should be set to the cluster to which you are deploying Apigee hybrid.

   ```
   kubectl config current-context
   ```

   The result should include the name of the cluster you are deploying Apigee hybrid in. For
   example, on GKE, the context name is usually in the form
   `gke_project-id_cluster-location_cluster-name`, as
   in:

   ```
   gke_my-project_us-central1_my-cluster
   ```

   If the name cluster name in the context does not match, the following command will get the
   `gcloud` credentials of the cluster and set the `kubectl` context:

   ### Regional clusters

   ```
   gcloud container clusters get-credentials $CLUSTER_NAME \
   --region $CLUSTER_LOCATION \
   --project $PROJECT_ID
   ```

   ### Zonal clusters

   ```
   gcloud container clusters get-credentials $CLUSTER_NAME \
   --zone $CLUSTER_LOCATION \
   --project $PROJECT_ID
   ```
2. In your hybrid files directory, create a `cluster-check` directory:

   ```
   mkdir $HYBRID_FILES/cluster-check
   ```
3. In the `$HYBRID_FILES/cluster-check` directory, create a file named `apigee-k8s-cluster-ready-check.yaml` with the following contents:

   ```
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: apigee-k8s-cluster-ready-check
   ---
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: apigee-k8s-cluster-ready-check
   spec:
     template:
       spec:
         hostNetwork: true
         serviceAccountName: apigee-k8s-cluster-ready-check
         containers:
           - name: manager
             image: gcr.io/apigee-release/hybrid/apigee-operators:1.10.0
             command:
               - /manager
             args:
             - --k8s-cluster-ready-check
             env:
             - name: POD_IP
               valueFrom:
                 fieldRef:
                   fieldPath: status.podIP
             securityContext:
               runAsGroup: 998
               runAsNonRoot: true
               runAsUser: 999
         restartPolicy: Never
     backoffLimit: 1
   ```
4. Apply the `apigee-k8s-cluster-ready-check.yaml` with the following `kubectl` command. This will run the test:

   ```
   kubectl apply -f $HYBRID_FILES/cluster-check/apigee-k8s-cluster-ready-check.yaml
   ```
5. Check the status of the Kubernetes job with the following command:

   ```
   kubectl get jobs apigee-k8s-cluster-ready-check
   ```


   If your cluster is ready, the output should look something like:

   ```
   NAME                            COMPLETIONS   DURATION   AGE
   apigee-k8s-cluster-ready-check  1/1           8s         1h23m
   ```


   If the test failed and your cluster is not ready, the output should look something like:

   ```
   NAME                            COMPLETIONS   DURATION   AGE
   apigee-k8s-cluster-ready-check  0/1           44s         44s
   ```

   Look for the number of completions:
   - **1/1** Success, your cluster is ready for Apigee hybrid installation.
   - **0/1** The test failed. The cluster is not ready. Proceed to the following steps to troubleshoot the cluster.

     <br />

6. If the test did not succeed, check the logs with the following commands.
   1. Get the name of the pod for the cluster pre-check job:

      ```
      kubectl get pods | grep apigee-k8s-cluster-ready-check
      ```
   2. Get the Kubernetes logs for the pod:

      ```
      kubectl logs pod_name
      ```


      Where <var translate="no">pod_name</var> is the name of the apigee-k8s-cluster-ready-check pod.
7. Clean up before proceeding to the next step. Delete the Kubernetes job with the following command:

   ```
   kubectl delete -f $HYBRID_FILES/cluster-check/apigee-k8s-cluster-ready-check.yaml
   ```

> [!TIP]
> **Tip:** On some platforms, like Anthos on Bare Metal or GKE on-prem, you may see DNS resolution errors. If the DNS resolution is not working, try this workaround.
>
>
> Add a static host entry in `/etc/hosts` file of each cassandra worker node
> similar to the following:
>
> ```
> echo -e "\\n127.0.1.1 ${HOSTNAME}" >> "/etc/hosts"
> ```
>
>
> or
>
> ```
> "\\nWORKER-NODE-IP ${HOSTNAME}" >> "/etc/hosts"
> ```

You have now made sure your Apigee hybrid cluster is ready. Next, let's apply your
configuration to the hybrid runtime and complete your installation of Apigee hybrid.

## Troubleshooting

1. Cassandra DNS check: If you find error logs smiliar to `DNS resolution was successful but IP doesn't match POD IP`, `could not resolve hostname` or `error determining hostname` it means your cluster DNS is not configured correctly for a multi-region setup. You can ignore this error if you do not intend to setup multi-region.
2. Control Plane connectivity check: If you find error logs similar to `error creating TCP connection with host` then you need to resolve the connectivity from cluster to apigee.googleapis.com and re-run the job.

[1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-create-cluster.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-cert-manager.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-apigeectl.md.txt) [4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-service-accounts.md.txt) [5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-create-tls-certificates.md.txt) [6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-configure-cluster.md.txt) [7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-enable-synchronizer-access.md.txt) [8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-check-cluster.md.txt) [(NEXT) Step 9: Install the hybrid runtime](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-hybrid-runtime.md.txt) [10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-expose-apigee-ingress.md.txt) [11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-deploy-proxy.md.txt)

<br />