ioFog Kubernetes Helm Package Repository

This repository is used to serve Helm packages of ioFog Kubernetes.

Prerequisites

The following commands require an installation of Helm and kubectl executing the deployment. It also assumes you have a running Kubernetes cluster and Agent nodes.

• Helm installation instructions
• kubectl installation instructions

Usage

Create Service Account for Tiller

Note that on RBAC enabled Kubernetes clusters (e.g. GKE, AKE), it is necessary to create a service account for Tiller before initializing helm. See helm init instructions for more details.

In order to create the cluster role binding on GKE, you need to have roles/container.admin permission. If your account doesn't have the role, it can be added using the following:

gcloud projects add-iam-policy-binding $PROJECT --member=user:person@company.com --role=roles/container.admin

Next, create service account for Tiller and bind cluster-admin role.

kubectl create serviceaccount --namespace kube-system tiller-svacc
kubectl create clusterrolebinding tiller-crb --clusterrole=cluster-admin --serviceaccount=kube-system:tiller-svacc

Initialize Helm And Install Tiller

Now is the time to use our service account to initialize Helm.

helm init --service-account tiller --wait

Note that on Azure Kubernetes Service (AKS), we will also need to specify node selectors for Tiller.

helm init --service-account tiller --node-selectors "beta.kubernetes.io/os"="linux" --wait

Install ioFog Stack

Add this Helm repository to our Helm repository index and install the ioFog stack and Kubernetes services

helm repo add iofog https://eclipse-iofog.github.io/helm

We can list all available versions of the ioFog Helm chart using helm search -l iofog/iofog. From Helm 2.16 onwards, only charts with production versions are listed by default. To list all versions, including development versions, use helm search -l --devel iofog

To install a specific version of ioFog, use helm install:

helm install \
    --set controlPlane.user.email=user@domain.com \
    --set controlPlane.user.password=any123password345 \
    --version 1.3.0 \
    --namespace my-ecn \
    --name my-ecn \
    iofog/iofog

To list all Helm releases, we can simply run helm list. The result should look like this:

NAME      	REVISION	UPDATED                 	STATUS  	CHART          	    APP VERSION	NAMESPACE
my-ecn     	1       	Tue Oct  1 21:34:42 2019	DEPLOYED	iofog-1.3.0	1.3.0 	my-ecn

The following is a complete list of all user configurable properties for the ioFog Helm chart. All of the properties are optional and have defaults. Use --set property.name=value in helm install to parametrize Helm release.

Property	Default value	Description
createCustomResources	true	See Multiple Edge Compute Networks
controlPlane.userfirstName	First	First name of initial user in Controller
controlPlane.usersurname	Second	Surname of initial user in Controller
controlPlane.useremail	user@domain.com	Email (login) of initial user in Controller
controlPlane.userpassword	H23fkidf9hoibf2nlk	Password of initial user in Controller
controlPlane.database.provider		Not supported in ioFog Community Edition
controlPlane.database.host		Not supported in ioFog Community Edition
controlPlane.database.port	0	Not supported in ioFog Community Edition
controlPlane.database.password		Not supported in ioFog Community Edition
controlPlane.database.dbName		Not supported in ioFog Community Edition
controlPlane.controller.replicas	1	Number of replicas of Controller pods
controlPlane.controller.image	iofog/controller:1.3.1	Controller Docker image
controlPlane.controller.imagePullPolicy	Always	Controller Docker image pull policy
controlPlane.kubeletImage	iofog/iofog-kubelet:1.3.0	Kubelet Docker image
controlPlane.loadBalancerIp		Pre-allocated static IP address for Controller
controlPlane.serviceType	LoadBalancer	Service type for Controller (one of LoadBalancer, NodePort or ClusterIP)
connectors.image	iofog/connector:1.3.0	Connector Docker image
connectors.serviceType	LoadBalancer	Service type for Connector (one of LoadBalancer, NodePort or ClusterIP)
connectors.instanceNames	["first","second"]	Array of Connector instance names
operator.replicas	1	Number of replicas of Operator pods
operator.image	iofog/iofog-operator:1.3.0	OperatorDocker image
operator.imagePullPolicy	Always	Operator Docker image pull policy

Connection to Installed ioFog

Once the installation is complete, you will be able to connect to the ioFog Controller on K8s using iofogctl.

iofogctl connect k8s-ctrl --kube-config ~/.kube/config --email user@domain.com --pass any123password345

Once you are connected, you can use iofogctl to deploy edge Agents. Then, you can use kubectl or iofogctl to deploy microservices to your edge Agents.

Multiple Edge Compute Networks

If we want to have multiple instances of ioFog on the same Kubernetes cluster, it is necessary to tell Helm not to install custom resource definitions. This can be done by overriding the createCustomResources (default: true) variable.

helm install \
    --set createCustomResources=false \
    --set controlPlane.user.email=user@domain.com \
    --set controlPlane.user.password=any123password345 \
    --version 1.3.0 \
    --namespace second-ecn \
    --name second-ecn \
    iofog/iofog

Only use this option when the ioFog custom resource exists, either from another Helm installation or manual installation using iofogctl.

To check if the custom resources exist, run kubectl get crd | grep iofog. If the resources exist, we must use createCustomResources=false so that Helm does not try to create them again.

Uninstall ioFog Stack

To uninstall ioFog stack, simply delete the Helm release, where the release name refers to --name arguments used during installation.

helm delete --purge my-ecn

Note that due to Helm's handing of custom resource definitions, all such definitions are orphaned when a release is created and thus need to be deleted manually.

kubectl get crds | grep iofog | awk '{print $1}' | xargs kubectl delete crds