images/bootstrap_capo/resource/help.txt
Ratnopam Chakrabarti 3b351b1aa1 Bootstrap container for openstack provider (capo)
This patchset provides the Go code and scripts for the
Bootstrap container for Openstack.

The Bootstrap container for Openstack provider accepts
three commands: create, delete and help.
- create - creates an Ephemeral K8S cluster in Openstack
- delete - deletes the Ephemeral K8S cluster in Openstack
- help - Stdout the help text for usage of the bootstrap container.

Documentation is available at bootstrap_capo/README.md

Change-Id: Idd444834070b84170f18561626c487e23a3ca951
2020-11-10 13:16:47 +00:00

33 lines
1.2 KiB
Plaintext

Openstack Ephemeral Configuration File Definition
-----------------------------------------------------
The Openstack Bootstrap container creates an Ephemeral K8S cluster on the Openstack.
The container requires clouds.yaml credentials and other information about the cluster to deploy.
It requires a YAML configuration file with the format provided below.
<Openstack Config Definition>
apiVersion: v1
kind: OpenstackConfig
metadata:
name: <metadata-name>
credentials:
credential: <Clouds.yaml file of devstack>
cloudName: <openstack cloud name i.e. devstack>
spec:
cluster:
machineSize: <Openstack VM flavor, e.g. ds2G>
kubeconfig: <Kubeconfig filename, Default is 'kubeconfig'>
securityGroup:<Security Group that'll be attached to the VM>
</Openstack Config Definition>
The expected location for the Openstack bootstrap configuration file is dictated by the "volume" mount
specified in the Airship config file (bootstrapInfo.ephemeral.container.volume).
For example, $HOME/.airship folder and shown in the snippet below:
<Snippet>
apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
ephemeral:
container:
volume: /home/stack/.airship:/kube
</Snippet>