Skip to content

Commit 43e6182

Browse files
authored
docs: update documentation regarding deployment (#416)
1 parent 433d1cb commit 43e6182

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/deploy/deployment.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Server Version: v1.11.9
1515
#
1616
```
1717
### - Install the Helm Package Manager
18-
Install the Helm Client on your local machine and the Helm Cerver on your kubernetes cluster. Helm installation documentation is [here]
18+
Install the Helm Client on your local machine and the Helm Server on your kubernetes cluster. Helm installation documentation is [here]
1919
(https://docs.helm.sh/using_helm/#installing-helm). After you install Helm you can list the Help packages installed with the following command:
2020
```
2121
# helm list
@@ -44,7 +44,7 @@ $ kubectl get nodes
4444
minikube Ready master 91d v1.10.0
4545
```
4646

47-
To find out the available resources in you cluster inspect each node from the command output above with the following command:
47+
To find out the available resources in your cluster inspect each node from the command output above with the following command:
4848
```
4949
$ kubectl describe node <node_name>
5050
```
@@ -110,37 +110,37 @@ All Helm parameters are described in the table at the bottom of this section.
110110
#### 3.a) Start the Multi-Cluster-App-Dispatcher Controller on All Target Deployment Clusters (*Agent Mode*).
111111
__Agent Mode__: Install and set up the `multi-cluster-app-dispatcher` controller (_MCAD_) in *Agent Mode* for each clusters that will orchestrate the resources defined within an _AppWrapper_ using Helm. *Agent Mode* is the default mode when deploying the _MCAD_ controller.
112112
```
113-
helm install mcad-controller --namespace kube-system --wait --set image.repository=<image repository and name> --set image.tag=<image tag> --set imagePullSecret.name=<Name of image pull kubernetes secret> --set imagePullSecret.password=<REPLACE_WITH_REGISTRY_TOKEN_GENERATED_IN_PREREQs_STAGE1_REGISTRY.d)> --set localConfigName=<Local Kubernetes Config File for Current Cluster> --set volumes.hostPath=<Host_Path_location_of_local_Kubernetes_config_file>
113+
helm install <release-name> mcad-controller --namespace kube-system --wait --set image.repository=<image repository and name> --set image.tag=<image tag> --set imagePullSecret.name=<Name of image pull kubernetes secret> --set imagePullSecret.password=<REPLACE_WITH_REGISTRY_TOKEN_GENERATED_IN_PREREQs_STAGE1_REGISTRY.d)> --set localConfigName=<Local Kubernetes Config File for Current Cluster> --set volumes.hostPath=<Host_Path_location_of_local_Kubernetes_config_file>
114114
```
115115

116116
##### Example 1
117117
*Assuming the default for `image.repository` and `image.tag` fields*:
118118
```
119-
helm install mcad-controller --namespace kube-system
119+
helm install <release-name> mcad-controller --namespace kube-system
120120
```
121121
##### Example 2
122122
*Assuming the MCAD controller image is already pulled onto the local target machine with the following image `image.repository=mcad-controller`, `image.tag=latest`*
123123
```
124-
helm install mcad-controller --namespace kube-system --wait --set image.pullPolicy=Never --set image.repository=mcad-controller --set image.tag=latest
124+
helm install <release-name> mcad-controller --namespace kube-system --wait --set image.pullPolicy=Never --set image.repository=mcad-controller --set image.tag=latest
125125
```
126126
##### Example 3
127127
To adjust the cpu and memory demands of the deployment with command line overrides example:
128128

129129
```
130-
helm install mcad-controller --namespace kube-system --wait --set resources.requests.cpu=1000m --set resources.requests.memory=1024Mi --set resources.limits.cpu=1000m --set resources.limits.memory=1024Mi --set image.repository=myContainerRegistry/mcad-controller --set image.tag=latest --set image.pullPolicy=Always
130+
helm install <release-name> mcad-controller --namespace kube-system --wait --set resources.requests.cpu=1000m --set resources.requests.memory=1024Mi --set resources.limits.cpu=1000m --set resources.limits.memory=1024Mi --set image.repository=myContainerRegistry/mcad-controller --set image.tag=latest --set image.pullPolicy=Always
131131
```
132132
#### 3.b) Start the Multi-Cluster-App-Dispatcher Controller on the Controller Cluster (*Dispatcher Mode*).
133133
_Dispatcher Mode__: Install and set up the Multi-Cluster-App-Dispatcher Controler (_MCAD_) in *Dispatcher Mode* for the control cluster that will dispatch the _MCAD_ controller to an *Agent* cluster using Helm.
134134

135135

136136
__Dispatcher Mode__: Installing the Multi-Cluster-App-Dispatcher Controler in *Dispatcher Mode*.
137137
```
138-
helm install mcad-controller --namespace kube-system --wait --set image.repository=<image repository and name> --set image.tag=<image tag> --set configMap.name=<Config> --set configMap.dispatcherMode='"true"' --set configMap.agentConfigs=agent101config:uncordon --set volumes.hostPath=<Host_Path_location_of_all_agent_Kubernetes_config_files>
138+
helm install <release-name> mcad-controller --namespace kube-system --wait --set image.repository=<image repository and name> --set image.tag=<image tag> --set configMap.name=<Config> --set configMap.dispatcherMode='"true"' --set configMap.agentConfigs=agent101config:uncordon --set volumes.hostPath=<Host_Path_location_of_all_agent_Kubernetes_config_files>
139139
```
140140

141141
For example:
142142
```
143-
helm install mcad-controller --namespace kube-system --wait --set image.repository=tonghoon --set image.tag=both --set configMap.name=mcad-deployer --set configMap.dispatcherMode='"true"' --set configMap.agentConfigs=agent101config:uncordon --set volumes.hostPath=/etc/kubernetes
143+
helm install <release-name> mcad-controller --namespace kube-system --wait --set image.repository=tonghoon --set image.tag=both --set configMap.name=mcad-deployer --set configMap.dispatcherMode='"true"' --set configMap.agentConfigs=agent101config:uncordon --set volumes.hostPath=/etc/kubernetes
144144
```
145145
### Chart configuration
146146

0 commit comments

Comments
 (0)