Build qserv-operator

Prerequisites

  • git

  • go version v1.16+.

  • docker version 20.10+.

  • Access to a Kubernetes v1.20+ cluster. For development purpose, kind is recommended. This kind quickstart might help.

  • Operator-sdk v1.15+ (see below for quick install)

  • kubectl version v1.20+.

Build

qserv-operator is based on operator-sdk v1.9.0

git clone https://github.com/lsst/qserv-operator.git
cd qserv-operator
# Pre-requisite, run it only once
./install-operator-sdk.sh
# Build qserv-operator image
./build.sh
# If using `kind`, push qserv-operator image to it
./push-image.sh -kd

Test qserv-operator

# Install qserv-operator
./deploy.sh
# Install qserv
kubectl apply -k manifests/base
./tests/e2e/integration.sh

Generate and upload documentation

Documentation is automatically built and generated on each Travis-CI build. This can also be performed manually by launching script below:

curl -fsSL https://raw.githubusercontent.com/lsst-dm/qserv-doc-container/master/run.sh | bash -s -- -p <LTD_PASSWORD> ~/src/qserv