Getting Started: Installation

Dependencies

Make sure the following dependencies are installed on the machine:

1. Golang: Shifu is created using Golang.

2. Docker: Shifu's components are packaged into a Docker image.

3. kind: Kind is used to run Kubernetes local cluster with a Docker image.

4. kubectl: The commandline tool for Kubernetes operations.

5. kubebuilder: Kubebuilder is used for building CRDs.

Shifu requires a Kubernetes cluster created before starting. Use kind to quickly create one:

kind create cluster

Quick setup

Apply the shifu_install.yml file (located in shifu/k8s/crd/install/shifu_install.yml) for the quickest installation:

cd shifu
kubectl apply -f k8s/crd/install/shifu_install.yml

Step by step setup

A step by step steup is as follows:

1. Initialize CRD
cd shifu/k8s/crd
make kube-builder-init

2. Create a new kind cluster
// kind delete cluster (in case you have any active kind clusters)
kind create cluster

3. Install CRD
make install

Now a basic Shifu is running on your machine. The next step is to add new devices to it and start managing them.