development.md

Table of Contents generated with DocToc

• Development Guide
  • Using your own capi-openstack controller image for testing cluster creation or deletion
    • Building and upload your own capi-openstack controller image
    • Using your own capi-openstack controller image
  • Developing with Tilt

Development Guide

This document explains how to develop Cluster API Provider OpenStack.

Using your own capi-openstack controller image for testing cluster creation or deletion

You need to create your own openstack-capi controller image for testing cluster creation or deletion by your code. The image is stored in the docker registry. You need to create an account of Docker registry in advance.

Building and upload your own capi-openstack controller image

Log in to your registry account. Export the following environment variables which will be used by the Makefile.

Variable	Meaning	Mandatory	Example
REGISTRY	The registry name	Yes	docker.io/<username>
IMAGE_NAME	The image name (default: capi-openstack-controller)	No	capi-openstack-controller
TAG	The image version (default: dev)	No	latest

Execute the command to build and upload the image to the Docker registry.

make docker-build docker-push

Using your own capi-openstack controller image

After generating provider-components.yaml, replace the us.gcr.io/k8s-artifacts-prod/capi-openstack/capi-openstack-controller:v0.2.0 with your image.

Developing with Tilt

For rapid development it's recommended to use Tilt. An example for a development environment setup with Tilt can be found in sbueringer/capi-dev.