Skip to content

Commit 8647115

Browse files
committed
Fix parameters table and add minor explanations to Helm guide
1 parent 0be303f commit 8647115

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

content/docs/1.3.0/tools/how-to-helm.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ IoFog Helm chart allows users to easily deploy the ioFog stack onto exiting Kube
66

77
## Prerequisites
88

9-
First, we need a working Kubernetes cluster. WE can simply set up a cluster on the Google Kubernetes Engine (GKE) by following the [Creating a cluster tutorial](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster). Using any other managed cluster providers works as well, so do custom installations of Kubernetes, e.g. Minikube.
9+
First, we need a working Kubernetes cluster. We can simply set up a cluster on the Google Kubernetes Engine (GKE) by following the [Creating a cluster tutorial](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster). Using any other managed cluster providers works as well, so do custom installations of Kubernetes, e.g. Minikube.
1010

1111
IoFog also provides [tools for infrastructure setup](https://github.com/eclipse-iofog/platform) to setup a Kubernetes cluster in case we don't have one available. Please see [Platform Tools](./platform-tools.html) for more details.
1212

@@ -74,7 +74,12 @@ helm repo add iofog https://eclipse-iofog.github.io/helm
7474

7575
We can list all available versions of the ioFog Helm chart using `helm search -l iofog/iofog`.
7676

77-
To install a specific version of ioFog, use `helm install`:
77+
To install a specific version of ioFog, use `--version <desired-version>` parameter to `helm install`
78+
79+
_Keep in mind if there already is any existing ioFog stack on the cluster, a set of Custom Resource Definitions has probably already been created. In such case, you will need to disable deploying these CRDs as described in [Multiple Edge Compute Networks](#multiple-edge-compute-networks)._
80+
81+
The final `helm install` command to install ioFog with CRDs then looks like this:
82+
7883

7984
```bash
8085
helm install \
@@ -86,7 +91,9 @@ helm install \
8691
iofog/iofog
8792
```
8893

89-
To list all Helm releases, we can simply run `helm list`. The result should look like this:
94+
The `--name my-ecn` refers to the Helm release name as shown below, while the `--namespace my-ecn` refers to the namespace taken by the Helm release in the target Kubernetes cluster.
95+
96+
To list all Helm releases (including deployed ioFog stacks), we can simply run `helm list`. The result should look like this:
9097

9198
```plain
9299
NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE
@@ -98,10 +105,10 @@ The following is a complete list of all user configurable properties for the ioF
98105
| Property | Default value | Description |
99106
| --------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------- |
100107
| createCustomResources | true | See [Multiple Edge Compute Networks](#multiple-edge-compute-networks) |
101-
| controlPlane.userfirstName | First | First name of initial user in Controller |
102-
| controlPlane.usersurname | Second | Surname of initial user in Controller |
103-
| controlPlane.useremail | [email protected] | Email (login) of initial user in Controller |
104-
| controlPlane.userpassword | H23fkidf9hoibf2nlk | Password of initial user in Controller |
108+
| controlPlane.user.firstName | First | First name of initial user in Controller |
109+
| controlPlane.user.surname | Second | Surname of initial user in Controller |
110+
| controlPlane.user.email | [email protected] | Email (login) of initial user in Controller |
111+
| controlPlane.user.password | H23fkidf9hoibf2nlk | Password of initial user in Controller |
105112
| controlPlane.database.provider | | Not supported in ioFog Community Edition |
106113
| controlPlane.database.host | | Not supported in ioFog Community Edition |
107114
| controlPlane.database.port | 0 | Not supported in ioFog Community Edition |

0 commit comments

Comments
 (0)