Search documentation
Dashboard
Infrastructure Layer

Install Gremlin on Kubernetes Manually

This section describes how to install the Gremlin Agent (gremlin) as well as the Gremlin Kubernetes Agent (chao) into Kubernetes, using only YAML files downloaded from k8s.gremlin.com. Gremlin recommends using this method only if any of the other recommended methods are not suitable for your use case.

Create a Kubernetes secret from Gremlin certificates

(Skip this step if you are using secret-based authentication)

  • download your Gremlin certificate key-pair (you need at least team manager access)

  • Unzip certificates.zip

  • Rename the files in the certificates folder. Team Name.pub_cert.pem becomes gremlin.cert. Team Name.priv_key.pem becomes gremlin.key.

  • Create a gremlin namespace: kubectl create namespace gremlin

  • Create a kubernetes secret by running the following:

    bash
    1kubectl -n gremlin create secret generic gremlin-team-cert --from-file=/path/to/gremlin.cert --from-file=/path/to/gremlin.key

Download and apply the Gremlin configuration manifest

  • Download the Gremlin configuration manifest by running the following:

    bash
    1wget https://k8s.gremlin.com/resources/gremlin-conf.yaml

  • Open the file and update the following:

  • Replace the following line with your team ID: "YOUR TEAM ID GOES HERE"

  • Replace the following line with your team secret: "YOUR TEAM SECRET GOES HERE"

    (If you are using certificate-based authentication, remove this line.)

  • Replace the following line with a string that you will use to identify your cluster: "YOUR UNIQUE CLUSTER NAME GOES HERE"

  • Apply the manifest with this command: kubectl apply -f /path/to/gremlin-conf.yaml

Download and apply the Gremlin client manifest

If you are using certificate-based authentication:

  • Download and apply the gremlin client manifest for your kubernetes cluster by running the following:

    bash
    1kubectl apply -f https://k8s.gremlin.com/resources/gremlin-client.yaml

If you are using secret-based authentication:

  • Download and apply the gremlin client manifest for your kubernetes cluster by running the following:

    bash
    1kubectl apply -f https://k8s.gremlin.com/resources/gremlin-client-secret.yaml

Download and apply the K8s client (Chao) manifest

If you are using certificate-based authentication:

  • Download and apply the k8s client manifest by running:

    bash
    1kubectl apply -f https://k8s.gremlin.com/resources/gremlin-chao.yaml

If you are using secret-based authentication:

  • Download and apply the k8s client manifest by running:

    bash
    1kubectl apply -f https://k8s.gremlin.com/resources/gremlin-chao-secret.yaml