Skip to content

Commit

Permalink
Document steps to build and run CVO locally
Browse files Browse the repository at this point in the history
Document instructions to build and run the CVO executable locally,for
example on your development laptop, allowing a "quick-turn" test
capability.
  • Loading branch information
jottofar committed Jun 8, 2020
1 parent cb8241a commit 20e42a3
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/dev/run-cvo-locally.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# How to Build and Run CVO Locally

This document provides the instructions to build and run the CVO executable locally. Local execution of CVO, for example executing CVO on your development laptop, allows a "quick-turn" test capability whereby the CVO executable can be quickly rebuilt with changes and launched again without the need of starting a new OCP cluster.

## Preconditions

Build the CVO executable using the standard procedure:

```console
$ cd ~/go/src/github.com/openshift/cluster-version-operator
$ make
```

Start an OCP cluster of the appropriate version. One that is compatiable with the version of CVO with which you're working.

Extract and download the OCP cluster release:

```console
$ oc image extract -a ~/pull-secret-internal quay.io/openshift-release-dev/ocp-release:4.4.0-rc.4-x86_64 --path /:/tmp/release/
```

## Steps to Run CVO Locally

Scale down the CVO pod on the cluster:

```console
$ oc scale --replicas=0 deployment.apps/cluster-version-operator
```

Set the following environment variables used by CVO:

```console
# Set to anything
$ export NODE_NAME=foobar

# Set to release extracted above
$ export PAYLOAD_OVERRIDE=/tmp/release/

# Point to cluster
$ export KUBECONFIG=~/Downloads/cluster-bot-2020-05-29-183515.kubeconfig
```

Run the CVO executable specifying `start`, the appropriate release image and, optionally, logging verbosity:

```console
$ ./_output/linux/amd64/cluster-version-operator -v5 start --release-image 4.4.0-rc.4
```

## Limitations

A locally executed CVO is unable to successfully handle an upgrade request. CVO upgrade processing relies on starting another pod that mounts the same host path as the original CVO pod.

0 comments on commit 20e42a3

Please sign in to comment.