Table of Contents generated with DocToc
- Kubernetes Cluster API Provider IBM Cloud
Kubernetes Cluster API Provider IBM Cloud
This repository hosts a concrete implementation of an IBM Cloud provider for the cluster-api project.
What is the Cluster API Provider IBM Cloud
The Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management. The API itself is shared across multiple cloud providers allowing for true IBM Cloud hybrid deployments of Kubernetes.
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
kubectl(see here). Because
kustomizewas included into
kubectland it's used by
cluster-api-provider-ibmcloudin generating yaml files, so version
kubectlis required, see integrate kustomize into kubectl for more info.
You can use either VM, container or existing Kubernetes cluster act as bootstrap cluster.
Install a driver if you are using minikube. For Linux, we recommend kvm2. For MacOS, we recommend VirtualBox.
An appropriately configured Go development environment
git clone https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud $GOPATH/src/sigs.k8s.io/cluster-api-provider-ibmcloud cd $GOPATH/src/sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/clusterctl go build
addons.yamlfiles if needed.
cd examples/ibmcloud ./generate-yaml.sh [options] <path/to/clouds.yaml> <provider os: [centos,ubuntu,coreos]> cd ../..
<clouds.yaml>is a yaml file to record how to interact with IBM Cloud, there's a sample clouds.yaml.
<provider os>specifies the operating system of the virtual machines Kubernetes will run on. Supported Operating Systems:
Quick notes on clouds.yaml
$ cat clouds.yaml userName: "your-name" apiKey: "your-api-key"
You can get
apiKeyfrom https://control.softlayer.com/ .
- Logon to https://control.softlayer.com/ .
- Click your user name on the right top of the console.
- The console will navigate you to the page of
Edit User Profile.
- Scroll down the page to the bottom, you will see a section
API Access Information. You can get
Special notes on ssh keys and fetching
In order to allow
clusterctlto fetch Kubernetes'
admin.conffrom the master node, you must manually create the key pair in IBM Cloud. By default the generated
cluster-api-provider-ibmcloudto be the
sshKeyName. However, you are free to change that.
For the ssh key, you can logon to https://control.softlayer.com/ , click
Devices->Manage->SSH Keys, you will be navigated to the page of
SSH Keys, click
Addto create your own key.
NOTE The private key used to connect to the master node is by default (currently hardcoded) at ~/.ssh/id_ibmcloud, so make sure you copy the generated key's private key info into this file.
Create a cluster:
- If you are using minikube:
./clusterctl create cluster --bootstrap-type minikube --bootstrap-flags kubernetes-version=v1.12.3 \ --provider ibmcloud -c examples/ibmcloud/out/cluster.yaml \ -m examples/ibmcloud/out/machines.yaml -p examples/ibmcloud/out/provider-components.yaml
To choose a specific minikube driver, please use the
--bootstrap-flags vm-driver=xxxcommand line parameter. For example to use the kvm2 driver with clusterctl you woud add
--bootstrap-flags vm-driver=kvm2, for linux, if you haven't installed any driver, you can add
- If you are using kind:
./clusterctl create cluster --bootstrap-type kind --provider ibmcloud \ -c examples/ibmcloud/out/cluster.yaml -m examples/ibmcloud/out/machines.yaml \ -p examples/ibmcloud/out/provider-components.yaml
- If you are using existing Kubernetes cluster:
./clusterctl create cluster --bootstrap-cluster-kubeconfig ~/.kube/config \ --provider ibmcloud -c examples/ibmcloud/out/cluster.yaml \ -m examples/ibmcloud/out/machines.yaml \ -p examples/ibmcloud/out/provider-components.yaml
For the above command, the
bootstrap-cluster-kubeconfigwas located at
~/.kube/config, you must update it to use your kubeconfig.
Additional advanced flags can be found via help.
./clusterctl create cluster --help
Interacting with your cluster
If you are using kind, config the
KUBECONFIG first before using kubectl:
export KUBECONFIG="$(kind get kubeconfig-path --name="clusterapi")"
Once you have created a cluster, you can interact with the cluster and machine resources using kubectl:
kubectl --kubeconfig=kubeconfig get clusters kubectl --kubeconfig=kubeconfig get machines kubectl --kubeconfig=kubeconfig get machines -o yaml
This guide explains how to delete all resources that were created as part of your IBM Cloud Cluster API Kubernetes cluster.
Delete all of the node Machines in the cluster. Make sure to wait for the corresponding Nodes to be deleted before moving onto the next step. After this step, the master node will be the only remaining node.
kubectl --kubeconfig=kubeconfig delete machines -l set=node kubectl --kubeconfig=kubeconfig get nodes
Delete the master machine.
kubectl --kubeconfig=kubeconfig delete machines -l set=master
Delete the kubeconfig file that were created for your cluster.
Delete the ssh keypair that were created for your cluster machine.
rm -rf $HOME/.ssh/id_ibmcloud*
Please refer to Trouble shooting documentation for further info.
IBM Cloud References
If you have any further question about IBM Cloud settings in provider, please refer to IBM Cloud help documentation for further infomation.