dev-setup.md

Setting up Your Development Environment

This page explains you how to set up your development environment.

Requirements

Before you start, install the following tools and packages:

• go (>= 1.13)
• golangci-lint
• kubectl (>= 1.14)
• kubebuilder (>= 2.0.0)
• docker
• Kubernetes distribution such as minikube or kind, or access to a hosted Kubernetes service such as GKE or AKS

Get sources

git clone https://github.com/elastic/cloud-on-k8s.git
cd cloud-on-k8s

Check prerequisites

Run make check-requisites to check that all dependencies are installed.

Development

1. Run make dependencies to download the Go libraries needed to compile the project.
2. Get a working development Kubernetes cluster. You can use:

• Minikube

  make bootstrap-minikube

• Kind

  make bootstrap-kind

• Cloud providers

  Use deployer (note that some one time configuration is required):

  • GKE: make switch-gke bootstrap-cloud
  • AKS: make switch-aks bootstrap-cloud

3. Deploy the operator.

• make run to run the operator locally, or make deploy to deploy the operators into the configured k8s cluster.
• make samples to apply a sample stack resource.

Running E2E tests

E2E tests will run in the e2e-mercury and e2e-venus namespaces. Run make run to start the operator and then run make e2e-local in a separate shell to run the tests.

Recommended reading

• Resources
• Controllers
• Controller Managers