IBM Cloud Provider

This is the IBM Cloud Provider repository which implements the IBM Cloud Controller Manager (CCM). The IBM CCM can be used to provide IBM Cloud infrastructure node and load balancer support to Kubernetes or OpenShift clusters running on IBM Cloud. This repository branch is based on Kubernetes version v1.29.1. See CONTRIBUTING.md for contribution guidelines.

Local Build and Deploy Instructions

Building IBM Cloud Provider from your Local Repository

These build instructions have been verified using VirtualBox version 6.1.36, Vagrant version 2.2.19, and MacOS version 12.5.

1. Create VirtualBox network configuration /etc/vbox/network.conf with the following content:

   $ cat /etc/vbox/network.conf
   * 192.168.10.0/21 192.168.56.0/21

2. Change to your local repository. The build will work against this directory by making it a vagrant folder synchronized to the VM.

3. cd vagrant-kube-build

4. ./build.sh

5. If the build fails, you can correct the errors and re-run ./build.sh. You can also run specific build steps by passing one or more of the following options:

   • Build setup (always run with other steps to setup the build environment and dependencies): setup
   • Build source (i.e. make fmt, make lint, etc.): source
   • Build containers (i.e. make containers): containers
   • Build Docker registry for the containers: registry
   • Build specific make step (cannot be run with other steps): make [[option] ...]

6. Once the build is complete, you can log into the VM via vagrant ssh. Running vagrant ssh-config will give you SSH configuration updates which you can apply to your host's ~/.ssh/config file. This allows you to run ssh cloud-provider-ibm-build to access the VM. Also, you can use vagrant suspend to suspend the VM and vagrant destroy -f to destroy it.

Deploying IBM Cloud Provider

Refer to examples for deploying the IBM Cloud Provider based on underlying infrastructure type, classic or VPC.

Testing

Unit

The default build process above will run all unit tests and matches what is done by Travis CI.

make test

Functional

Functional tests are available under tests/fvt and are designed to run against an existing cluster. These tests exercise the load balancer interfaces without having to do a full build and deployment. These tests are not run by Travis CI.

To run these tests, do the following:

1. Copy your cluster admin configuration into tests/fvt/kubeconfig along with the associated 3 *.pem files:

   1. The setupFVT.sh script in vagrant-kube-build can do this for you, just:
      • cd vagrant-kube-build
      • ./setupFVT.sh <CLUSTER_NAME>

2. Edit ibm-cloud-config.ini file depending on whether you are testing a cluster using classic or VPC infrastructure:

   1. For Classic, no modifications are needed
   2. For VPC, you must uncomment the lines at the bottom from [provider] to the end, and update them with information from your cluster:
      • accountID can be anything (for example, accountID = bogusAccountID)
      • clusterID must be set to your cluster ID

3. Once you have this done, the default ./build.sh script will run the FVT tests.

4. You can also use this tester to run additional tests. To do that:

   1. Run the full ./build.sh to run through the default tests once
   2. vagrant ssh into the build VM and run other variations of the tests using any of the following as examples:
      • make runfvt TEST_FVT_OPTIONS="--action=create --name=BradsLB1"
      • make runfvt TEST_FVT_OPTIONS="--action=delete --name=BradsLB1"

Dependencies

Dependencies are managed via go modules for builds. Be sure to regenerate the go.mod and go.sum files when there are new or updated dependencies. You can do this by running make updatedeps.

Kubernetes Version Update Process

The steps needed to support a new Kubernetes release have been moved to a Wiki page.

Release Process

Travis CI is used to build IBM Cloud Provider releases. A nightly build job will trigger a Travis build by publishing a new tag when there are changes for a release.