Installation

This section shows us how to install operator in our cluster.

Requirements

1. Kubernetes 1.14+
2. Kubectl 1.14+

Please make sure the kubectl is properly configured to interact with the Kubernetes environment.

Preparing Images of Coordinators and Shuffle Servers

Run the following command:

cd deploy/kubernetes/docker && sh build.sh --registry ${our-registry}

Creating or Updating CRD

We can refer to crd yaml file.

Run the following command:

# create, cannot use apply here, see https://github.com/apache/incubator-uniffle/issues/774
kubectl create -f ${crd-yaml-file}

# update, make sure the crd-yaml-file is a complete CRD file.
kubectl replace -f ${crd-yaml-file}

Setup or Update Uniffle Webhook

We can refer to webhook yaml file.

Run the following command:

kubectl apply -f ${webhook-yaml-file}

Setup or Update Uniffle Controller

We can refer to controller yaml file.

Run the following command:

kubectl apply -f ${controller-yaml-file}

How To Use

We can learn more details about usage of CRD from uniffle operator design.

Examples

Example uses of CRD have been provided.