# cluster-api-provider-alibaba

**Repository Path**: mirrors_openshift/cluster-api-provider-alibaba

## Basic Information

- **Project Name**: cluster-api-provider-alibaba
- **Description**: OpenShift Machine API provider for Alibaba
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-28
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenShift cluster-api-provider-alibaba

This repository hosts an implementation of a provider for AlibabaCloud for the
OpenShift [machine-api](https://github.com/openshift/cluster-api).

This provider runs as a machine-controller deployed by the
[machine-api-operator](https://github.com/openshift/machine-api-operator)

### How to build the images in the RH infrastructure
The Dockerfiles use `as builder` in the `FROM` instruction which is not currently supported
by the RH's docker fork (see [https://github.com/kubernetes-sigs/kubebuilder/issues/268](https://github.com/kubernetes-sigs/kubebuilder/issues/268)).
One needs to run the `imagebuilder` command instead of the `docker build`.

Note: this info is RH only, it needs to be backported every time the `README.md` is synced with the upstream one.

## Deploy machine API plane with minikube

1. **Install kvm**

   Depending on your virtualization manager you can choose a different [driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md).
   In order to install kvm, you can run (as described in the [drivers](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) documentation):

    ```sh
    $ sudo yum install libvirt-daemon-kvm qemu-kvm libvirt-daemon-config-network
    $ systemctl start libvirtd
    $ sudo usermod -a -G libvirt $(whoami)
    $ newgrp libvirt
    ```

   To install to kvm2 driver:

    ```sh
    curl -Lo docker-machine-driver-kvm2 https://storage.googleapis.com/minikube/releases/latest/docker-machine-driver-kvm2 \
    && chmod +x docker-machine-driver-kvm2 \
    && sudo cp docker-machine-driver-kvm2 /usr/local/bin/ \
    && rm docker-machine-driver-kvm2
    ```

2. **Deploying the cluster**

   To install minikube `v1.1.0`, you can run:

    ```sg
    $ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v1.1.0/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
    ```

   To deploy the cluster:

    ```
    $ minikube start --vm-driver kvm2 --kubernetes-version v1.13.1 --v 5
    $ eval $(minikube docker-env)
    ```

3. **Deploying machine API controllers**

   For development purposes the AlibabaCloud machine controller itself will run out of the machine API stack.
   Otherwise, docker images needs to be built, pushed into a docker registry and deployed within the stack.

   To deploy the stack:
    ```
    kustomize build config | kubectl apply -f -
    ```

4. **Deploy secret with AlibabaCloud credentials**

   AlibabaCloud actuator assumes existence of a secret file (references in machine object) with base64 encoded credentials:

   ```yaml
   apiVersion: v1
   kind: Secret
   metadata:
     name: alibabacloud-credentials-secret
     namespace: default
   type: Opaque
   data:
     accessKeyID: FILLIN
     accessKeySecret: FILLIN
   ```

   Save the above resource as **_secret.yaml_** and then apply it:
   ```sh
   kubectl apply -f secret.yaml
   ```

## Test locally built AlibabaCloud actuator

1. **Tear down machine-controller**

   Deployed machine API plane (`machine-api-controllers` deployment) is (among other
   controllers) running `machine-controller`. In order to run locally built one,
   simply edit `machine-api-controllers` deployment and remove `machine-controller` container from it.

2. **Build and run AlibabaCloud actuator outside of the cluster**

   ```sh
   $ go build -o bin/machine-controller-manager github.com/openshift/cluster-api-provider-alibaba/cmd/manager
   ```

   ```sh
   $ ./bin/machine-controller-manager --kubeconfig ~/.kube/config --logtostderr -v 5 -alsologtostderr
   ```
   If running in container with `podman`, or locally without `docker` installed, and encountering issues, see [hacking-guide](https://github.com/openshift/machine-api-operator/blob/master/docs/dev/hacking-guide.md#troubleshooting-make-targets).

1. **Deploy k8s apiserver through machine manifest**:

   To deploy user data secret with kubernetes apiserver initialization (under [config/master-user-data-secret.yaml](config/master-user-data-secret.yaml)):

   ```sh
   $ kubectl apply -f config/master-user-data-secret.yaml
   ```

   To deploy kubernetes master machine (under [config/master-machine.yaml](config/master-machine.yaml)):

   ```sh
   $ kubectl apply -f config/master-machine.yaml
   ```

1. **Join worker node through machine manifest**:

   To deploy user data secret with kubernetes apiserver initialization (under [config/worker-user-data-secret.yaml](config/worker-user-data-secret.yaml)):

   ```sh
   $ kubectl apply -f config/worker-user-data-secret.yaml
   ```

   To deploy kubernetes worker machine (under [config/worker-machine.yaml](config/worker-machine.yaml)):

   ```sh
   $ kubectl apply -f config/worker-machine.yaml
   ```

1. **Pull kubeconfig from created master machine**

   The master public IP can be accessed from AlibabaCloud Portal. Once done, you
   can collect the kube config by running:

   ```
   $ ssh -i SSHPMKEY root@PUBLICIP 'sudo cat /root/.kube/config' > kubeconfig
   $ kubectl --kubeconfig=kubeconfig config set-cluster kubernetes --server=https://PUBLICIP:6443
   ```

   Once done, you can access the cluster via `kubectl`. E.g.

   ```sh
   $ kubectl --kubeconfig=kubeconfig get nodes
   ```


## Deploy machine API plane with AlibabaCloud ACK Cluster

1. **Creating ACK Cluster**

    You can create a Kubernetes cluster using the CLI, TerraForm, or ACK console

    CLI Document:
    ```
   https://www.alibabacloud.com/help/doc-detail/198808.htm
    ```

   TerraForm Document:
    ```
   https://www.alibabacloud.com/help/doc-detail/252824.htm
    ```

   ACK Console Document:
    ```
   https://www.alibabacloud.com/help/doc-detail/86488.htm
    ```


2. **Deploying machine API controllers**

   For development purposes the AlibabaCloud machine controller itself will run out of the machine API stack.
   Otherwise, docker images needs to be built, pushed into a docker registry and deployed within the stack.

   To deploy the machine crds:
    ```sh
    $ kubectl apply -f config/crds/
    ```

   To deploy the machine rbac:
    ```sh
    $ kubectl apply -f config/rbac/
    ```

   To deploy the machine controller:
    ```sh
    $ kubectl apply -f config/controllers/
    ```

3. **Deploy secret with AlibabaCloud credentials**

   AlibabaCloud actuator assumes existence of a secret file (references in machine object) with base64 encoded credentials:

   ```yaml
   apiVersion: v1
   kind: Secret
   metadata:
     name: alibabacloud-credentials-secret
     namespace: default
   type: Opaque
   data:
     accessKeyID: FILLIN
     accessKeySecret: FILLIN
   ```

   Save the above resource as **_secret.yaml_** and then apply it:
   ```sh
   $ kubectl apply -f secret.yaml
   ``` 

1. **Deploy k8s apiserver through machine manifest**:

   To deploy user data secret with kubernetes apiserver initialization (under [config/master-user-data-secret.yaml](config/master-user-data-secret.yaml)):

   ```sh
   $ kubectl apply -f config/master-user-data-secret.yaml
   ```

   To deploy kubernetes master machine (under [config/master-machine.yaml](config/master-machine.yaml)):

   ```sh
   $ kubectl apply -f config/master-machine.yaml
   ```

1. **Join worker node through machine manifest**:

   To deploy user data secret with kubernetes apiserver initialization (under [config/worker-user-data-secret.yaml](config/worker-user-data-secret.yaml)):

   ```sh
   $ kubectl apply -f config/worker-user-data-secret.yaml
   ```

   To deploy kubernetes worker machine (under [config/worker-machine.yaml](config/worker-machine.yaml)):

   ```sh
   $ kubectl apply -f config/worker-machine.yaml
   ```

1. **Pull kubeconfig from created master machine**

   The master public IP can be accessed from AlibabaCloud Portal. Once done, you
   can collect the kube config by running:

   ```
   $ ssh -i SSHPMKEY root@PUBLICIP 'sudo cat /root/.kube/config' > kubeconfig
   $ kubectl --kubeconfig=kubeconfig config set-cluster kubernetes --server=https://PUBLICIP:6443
   ```

   Once done, you can access the cluster via `kubectl`. E.g.

   ```sh
   $ kubectl --kubeconfig=kubeconfig get nodes
   ```

### Add worker nodes to the ACK cluster via Machine-API

1. **Deploy secret with AlibabaCloud worker nodes userdata**

   AlibabaCloud actuator assumes existence of a secret file (references in machine object) with base64 encoded userdata:

   How do I get the script to add worker nodes? You can refer to the documentation
   
   ```
   https://www.alibabacloud.com/help/doc-detail/86919.htm
   ```

   And then generate the userdata:

   ```sh
   $ echo '#!/bin/bash  <Your worker node script>' | base64
   ```

   Replace FILLIN with userdata:
   
   ```yaml
   apiVersion: v1
   kind: Secret
   metadata:
     name: worker-user-data-secret
     namespace: default
   type: Opaque
   data:
    userData: FILLIN
   ```

   Save the above resource as **_worker-user-data-secret.yaml_** and then apply it:
   ```sh
   kubectl apply -f worker-user-data-secret.yaml
   ``` 

 1. **Add worker machine to ACK Cluster**
    
   ```yaml
   apiVersion: machine.openshift.io/v1beta1
   kind: Machine
   metadata:
     name: alibabacloud-actuator-testing-machine
     namespace: default
     labels:
       machine.openshift.io/cluster-api-cluster: alibabacloud-actuator-k8s
   spec:
     metadata:
       labels:
         node-role.kubernetes.io/infra: ""
     providerSpec:
       value:
         apiVersion: alibabacloudproviderconfig.openshift.io/v1
         kind: AlibabaCloudMachineProviderConfig
         instanceType: FILLIN
         imageId: FILLIN
         regionId: FILLIN
         zoneId: FILLIN
         securityGroupId: FILLIN
         vpcId: FILLIN
         vSwitchId: FILLIN
         systemDiskCategory: FILLIN
         systemDiskSize: FILLIN
         internetMaxBandwidthOut: FILLIN
         password: FILLIN
         tags:
           - key: openshift-node-group-config
             value: node-config-node
           - key: host-type
             value: node
           - key: sub-host-type
             value: default
         userDataSecret:
           name: alibabacloud-worker-user-data-secret
         credentialsSecret:
           name: alibabacloud-credentials-secret
   ```
   
     Save the above resource as **_worker-machine-with-user-data.yaml_** and then apply it:

   ```sh
   kubectl apply -f worker-machine-with-user-data.yaml
   ``` 

   Once done, you can describe the machine via `kubectl`. E.g.
   
   ```sh
   $ kubectl  get machine
   ```