development.md

Development Guide

Table of Contents generated with DocToc

• Development Guide
  • Required tools/Binaries
  • Launch Dev mode
  • Build a local image

Required tools/Binaries

Multicloud-Operators projects are built with following tools. Use the links provided to install them on your environment:

• Find an environment, or set up Kubernetes version 1.13 and later: kubernetes.io

• Build with Go verson 1.13 and later

• Enforce style and formatting with Lint:

  • hadolint
  • shellcheck
  • yamllint
  • helm client
  • golangci-lint
  • autopep8
  • mdl
  • awesome_bot
  • sass-lint
  • tslint
  • prototool
  • goimports - Run go get -v golang.org/x/tools/cmd/goimports to install

• Test with kubebuilder v1.0.8

Launch Dev mode

Run the following command to launch developer mode:

git clone git@github.com:stolostron/multicloud-operators-deployable.git
cd multicloud-operators-deployable
export GITHUB_USER=<github_user>
export GITHUB_TOKEN=<github_token>
make
make build
./build/_output/bin/multicluster-operators-deployable

Build a local image

Build a local image by running the following command:

git clone git@github.com:stolostron/multicloud-operators-deployable.git
cd multicloud-operators-deployable
export GITHUB_USER=<github_user>
export GITHUB_TOKEN=<github_token>
make
make build-images