Skip to content

Deploy Okera on GKE

This document will guide you through installing Okera on a GKE cluster. You will walk through the following steps:

  1. Verifying you have access to your GKE cluster.
  2. Downloading and unpacking okctl.
  3. Deploying a base unconfigured Okera cluster.
  4. Updating the configuration of your cluster.


  1. A functional GKE cluster that adheres to the Okera prerequisites.
  2. A Linux node that can execute kubectl commands against the GKE cluster - we will call this the deployer node.

Verify GKE Access

On the deployer node, you can verify you have GKE access by running:

$ kubectl get nodes -owide
NAME                                       STATUS   ROLES    AGE   VERSION             INTERNAL-IP   EXTERNAL-IP      OS-IMAGE                             KERNEL-VERSION   CONTAINER-RUNTIME
gke-cluster-1-odas-default-309f3494-chhm   Ready    <none>   10m   v1.15.12-gke.6002   Container-Optimized OS from Google   4.19.112+        docker://19.3.1
gke-cluster-1-odas-default-309f3494-d1vl   Ready    <none>   20d   v1.15.12-gke.6002    Container-Optimized OS from Google   4.19.112+        docker://19.3.1
gke-cluster-1-odas-default-309f3494-t7m0   Ready    <none>   10m   v1.15.12-gke.6002     Container-Optimized OS from Google   4.19.112+        docker://19.3.1

You should see all the nodes that you have in your GKE cluster listed.

Choosing a Region

Okera provides the installation files in three locations, US West, US East, and EU West. You should modify the links shown below choosing the region closest to you by replacing the S3 base URL, while leaving the rest of the URL path as given in the examples on this page.

The base links for the available regions are:

Region Base URL
US West
US East
EU West
Asia Pacific (Sydney)

For example, for the download link of the Okera command-line tool (explained in the next section) in the US East region, combine the S3 base URL for the region with the path of the installation resource, including the Okera version number:

|---------------- Base URL -----------------||---- Resource Path ----|

Download okctl

On the deployer node, we will be downloading okctl and the Okera Kubernetes resource files. Run the following commands to create a directory and then download and unpack okctl in it:

$ mkdir okera && cd okera
$ curl -O
$ tar xvf okctl.tar

We can verify we have a functional okctl binary by running:

$ ./okctl version
$ ./okctl --help
usage: okctl [<flags>] <command> [<args> ...]

the Okera Controller

    --help                   Show context-sensitive help (also try --help-long and --help-man).
-v, --debug                  Show debug output (WARNING: this will output sensitive information to your shell)
    --kubeconfig=KUBECONFIG  Kubernetes config to use
    --cluster=CLUSTER        Kubernetes cluster to use as defined in KUBECONFIG
    --context=CONTEXT        Kubernetes context to use as defined in KUBECONFIG
    --namespace=NAMESPACE    Kubernetes namespace to use
-o, --output=OUTPUT          Format to print output in
    --auth-dir=".auth"       Location for auth related files

help [<command>...]
    Show help.


Below instructions will assume that you are executing commands from within the folder we created above.

Deploying Okera

To deploy Okera, run:

$ ./okctl deploy --arch gcp
2019/08/26 16:26:08 Deploying 'resources/kubernetes/gcp/00-roles.yaml'...
2019/08/26 16:26:09 Deployed successfully
2019/08/26 16:26:09 Deploying 'resources/kubernetes/gcp/01-secrets.yaml'...
2019/08/26 16:26:10 Deployed successfully
2019/08/26 16:26:10 Deploying 'resources/kubernetes/gcp/02-config.yaml'...
2019/08/26 16:26:11 Deployed successfully
2019/08/26 16:26:11 Deploying 'resources/kubernetes/gcp/03-services.yaml'...
2019/08/26 16:26:12 Deployed successfully
2019/08/26 16:26:12 Deploying 'resources/kubernetes/gcp/04-canary.yaml'...
2019/08/26 16:26:13 Deployed successfully
2019/08/26 16:26:14 Deploying 'resources/kubernetes/gcp/06-catalog.yaml'...
2019/08/26 16:26:15 Deployed successfully
2019/08/26 16:26:15 Deploying 'resources/kubernetes/gcp/07-planner.yaml'...
2019/08/26 16:26:16 Deployed successfully
2019/08/26 16:26:16 Deploying 'resources/kubernetes/gcp/08-worker.yaml'...
2019/08/26 16:26:17 Deployed successfully
2019/08/26 16:26:17 Deploying 'resources/kubernetes/gcp/09-rest-server.yaml'...
2019/08/26 16:26:17 Deployed successfully
2019/08/26 16:26:17 Deploying 'resources/kubernetes/gcp/10-presto.yaml'...
2019/08/26 16:26:18 Deployed successfully

This deploys a base version of Okera on your GKE cluster that is not configured: no authentication is set up and all state is being persisted locally.

Notes: The files in resources/kubernetes/gcp are self-contained Kubernetes resource files, and you can deploy them yourself using your preferred Kubernetes tooling, including using kubectl apply -f.

The cerebro-planner, cerebro-worker, cdas-rest-server and presto-coordinator services use only LoadBalancer types (type: LoadBalancer). Consequently Helm Charts must also use LoadBalancer types. The Helm Chart settings can be specified in the values.yaml file associated with the chart. The Okera settings are in the service yaml file: resources/kubernetes/aks/03-services.yaml.

Configuring Your Okera Cluster

Okera clusters use a YAML configuration file, which you can learn more about here.

You can update the configuration of your cluster using okctl update.

To deploy the Quickstart configuration, which will add authentication and SSL:

$ ./okctl update --config configs/config-quickstart.yaml

You can copy this file (or the other example configuration files in the configs/ directory) and modify them for your deployment, and then apply them using okctl update.