The Ketch Developer Hub

Welcome to the Ketch developer hub. You'll find comprehensive guides and documentation to help you start working with Ketch as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started

Getting started with Ketch only takes a few minutes. The sections below will guide you step-by-step from installing Ketch to deploying your first application.

More in-depth tutorials can also be found as part of this documentation.

Installing Ketch

The latest Ketch release can be found here. Use the following commands to install Ketch, changing the version in the commands to match the version of Ketch you want to install.

Ketch CLI

You can use the following command to download and install the Ketch CLI on your local machine:

curl -s | bash

The command above will download and install the Ketch CLI based on your local operating system

Ingress Controller, Cluster Issuer and Cert Manager


Existing cluster resources

The ingress controller, cluster issuer, or cert-manager should only be installed if one is not currently installed in the cluster where Ketch will be installed.

In case there is already an ingress controller (Traefik or Istio), cluster issuer or cert-manager installed in the cluster, the steps below specific to each are not necessary.

* Installing Cert-Manager

If not already present in your cluster, you can install cert-manager by using the following commands:

kubectl apply --validate=false -f

* Installing Traefik

If not already present in your cluster, you can install Traefik by using the following commands:

helm repo add traefik
helm repo update
helm install traefik traefik/traefik

* Installing Istio

If not already present in your cluster, you can install Istio by using the following commands:

ISTIO_VERSION=1.9.0 && curl -L |ISTIO_VERSION=1.9.0 sh - && cd istio-$ISTIO_VERSION && export PATH=$PWD/bin:$PATH

istioctl install --set profile=demo

* Cluster Issuer

If not already present in your cluster, you can install a cluster issuer by creating the cluster-issuer-istio.yaml file with the following content:

kind: ClusterIssuer
  name: le 
      name: my-account-key
    - http01:
         class: istio

Once the file is created, you can install it using the following command:

kubectl apply -f cluster-issuer-istio.yaml

Ketch Controller

Run the command below to install the Ketch controller:

kubectl apply -f

Deploying an Application

Creating a Pool

Deploying applications is easy once you've installed Ketch, where the first step is to create a pool.

When creating a pool, you should assign which ingress controller you want to associate with the pool.

  • When using Traefik:
ketch pool add dev  --ingress-service-endpoint --ingress-type traefik


Traefik Ingress IP

You can find Traefik's ingress service IP by running the command below:

kubectl get services

You should use the IP presented under the EXTERNAL-IP column.

  • When using Istio:
ketch pool add dev  --ingress-service-endpoint --ingress-type istio


Istio Ingress IP

You can find Istio's ingress service IP by running the command below:

kubectl get services -n istio-system

You should use the IP presented under the EXTERNAL-IP column.


Kubernetes Namespace

The commands above will create a dedicated namespace for the Ketch pool during the pool creation.

You can also have Ketch use an existing namespace for the pool instead. This can be achieved by adding the --namespace flag in the command.

Creating an Application

By using the command below, you will create an application named bulletinboard and assign it to the pool dev created in the previous step:

ketch app create bulletinboard --pool dev

Deploying Applications Using a Docker Image

The command below will deploy an existing Docker image as your application image to bulletinboard:

ketch app deploy bulletinboard -i


Deploying image from private docker registry

If your image is in a private docker registry repo you should set up docker-registry secret using kubectl. Follow kubectl documentation on pulling images from private docker registry for details.

Once you set it up, you should create an app or update app by providing the secret name using

ketch app create $APPNAME --pool $POOLNAME --registry-secret $DOCKER_REGISTRY_SECRET_NAME

Deploying Applications From Source

To deploy an application from source code, you need to add a platform for the stack you are using and use it during app creation. e.g., below, we are creating and deploying a python application:

# Add python platform
$ ketch platform  add python
Added platform "python"

# Create application to deploy from source using python platform
$ ketch app create python-sample --pool istio-pool -P python 

# Deploy app
$ ketch app deploy python-sample .  -i

During application deployment, Ketch creates a docker image and pushes it to a docker registry. To build and push docker images, ketch uses the docker CLI on your machine and expects you to be logged in using the docker login command.

If you are pushing the image to a private docker registry, follow the notes above on setting up a docker-registry secret and creating a ketch app with it using the --registry-secret option.


Ketch platform for source deployment

Ketch platform makes it easier to deploy applications from source. See Ketch Platforms for details.

Once deployed, you can check the application status by using the app list command:

ketch app list

After you deploy your application, you can access it at the address associated with it using the ketch app list, in this example,

Updated about a month ago

Getting Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.