Search…
⌃K

1. Set up a Context [Beta]

Connect Velocity to an existing K8s cluster using a Velocity Operator
This feature is still in beta and is currently only delivered to selected customers. Contact us if you would like to learn more. To install Velocity in a self-hosted cluster in your cloud account, read our admin guide.

Introduction

With the Velocity Operator, you can use Velocity on any existing Kubernetes cluster.
For example, you can install the operator in a shared development cluster or in MiniKube on your local machine.

Requirements

A Kubernetes Cluster: A shared development cluster or a local MiniKube cluster.
For easier onboarding, it is best to use a cluster with an instance of your application already deployed in it.

Velocity Operator

Velocity uses an operator installed in your cluster to spin up isolated ephemeral environments.
The operator pulls environment requests and manages the environments in your cluster.
Once an environment is running, you can develop code locally connected to it.

Installation

Follow the steps below to generate an API token and install the Velocity Operator using Helm:
  1. 1.
    Open the Account Settings Contexts page and click 'Add a Context'
    1. 1.
      Specify a name for your cluster context. Use a unique name that identifies your cluster. For example, dev-cluster.
    2. 2.
      (Optional) To access environments through public URIs, enter the domain name configured in your Ingress Controller. Leave empty if you are using MiniKube or a private cluster.
    3. 3.
      Once you create the Context, an API token will be generated with specific shell commands that add Velocity's repository to Helm and installs the Velocity operator. Copy these commands and run them in your terminal.

Operator Upgrade

When a new version is released, you can use the following commands to install the latest version of the Velocity Operator:
helm repo update
helm get values -n velocity velocity-operator -o yaml | helm upgrade velocity-operator velocity/velocity-operator -n velocity -f -