Skip to content
IBM Cloud Provider for Cluster API
Branch: master
Clone or download
Latest commit 95f1a1f May 22, 2019

Build Status Go Report Card LICENSE Releases

Table of Contents generated with DocToc

Kubernetes Cluster API Provider IBM Cloud

Powered by 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.

Getting Started


  1. Install kubectl (see here). Because kustomize was included into kubectl and it's used by cluster-api-provider-ibmcloud in generating yaml files, so version 1.14.0+ of kubectl is required, see integrate kustomize into kubectl for more info.

  2. You can use either VM, container or existing Kubernetes cluster act as bootstrap cluster.

    • If you want to use container, install kind. This is preferred.
    • If you want to use VM, install minikube, version 0.30.0 or greater.
    • If you want to use existing Kubernetes cluster, prepare your kubeconfig.
  3. Install a driver if you are using minikube. For Linux, we recommend kvm2. For MacOS, we recommend VirtualBox.

  4. An appropriately configured Go development environment

  5. Build the clusterctl tool

    git clone $GOPATH/src/
    cd $GOPATH/src/
    go build

Cluster Creation

  1. Create the cluster.yaml, machines.yaml, provider-components.yaml, and addons.yaml files if needed.

    cd examples/ibmcloud
    ./ [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:

    • ubuntu
    • centos (Not Implemented)
    • coreos (Not Implemented)

    Quick notes on clouds.yaml

    $ cat clouds.yaml
    userName: "your-name"
    apiKey: "your-api-key"

    You can get userName and apiKey from .

    • Logon to .
    • Click your user name on the right top of the console. ibmcloud account
    • The console will navigate you to the page of Edit User Profile. ibmcloud profile
    • Scroll down the page to the bottom, you will see a section API Access Information. You can get userName and apiKey from there. ibmcloud auth

    Special notes on ssh keys and fetching admin.conf

    In order to allow clusterctl to fetch Kubernetes' admin.conf from the master node, you must manually create the key pair in IBM Cloud. By default the generated machine.yaml uses cluster-api-provider-ibmcloud to be the sshKeyName. However, you are free to change that.

    For the ssh key, you can logon to , click Devices->Manage->SSH Keys, you will be navigated to the page of SSH Keys, click Add to create your own key. ibmcloud key management ibmcloud key add

    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.

  2. 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=xxx command 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 --bootstrap-flags vm-driver=none.

    • 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-kubeconfig was 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

Cluster Deletion

This guide explains how to delete all resources that were created as part of your IBM Cloud Cluster API Kubernetes cluster.

  1. 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
  2. Delete the master machine.

    kubectl --kubeconfig=kubeconfig delete machines -l set=master
  3. Delete the kubeconfig file that were created for your cluster.

    rm kubeconfig
  4. Delete the ssh keypair that were created for your cluster machine.

    rm -rf $HOME/.ssh/id_ibmcloud*

Trouble shooting

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.

You can’t perform that action at this time.