Skip to content

Commit c796429

Browse files
deploy/helm fix mardown in README
Signed-off-by: Jordi Massaguer Pla <[email protected]>
1 parent 2456c45 commit c796429

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

deploy/helm/README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ namespace, here you need to use the one you've chosen.
8888
> :warning: Note the user and password are hard coded inside the yaml
8989
file.
9090

91-
> :hint: Note we use the -local.yaml file. This is because this is a
91+
> :bulb: Note we use the -local.yaml file. This is because this is a
9292
demo and we are not using external storage. On a production environment,
9393
you should consider using volume claims.
9494

@@ -104,7 +104,7 @@ install mongodb.
104104
> :warning: Note the user and password are hard coded inside the yaml
105105
file.
106106

107-
>: hint: Note we use the -local.yaml file, so storage is not persisted.
107+
> :bulb: Note we use the -local.yaml file, so storage is not persisted.
108108
For production, you should consider using volume claims.
109109

110110
Next, let's install minio, a "like s3" service.
@@ -128,7 +128,7 @@ dependency, which are argo workflows.
128128

129129
``` helm upgrade -i -n monai -f argo-workflows.yaml argo-workflows argo/argo-workflows ```
130130

131-
> :Warning: Note that we are setting up the authentication method for
131+
> :warning: Note that we are setting up the authentication method for
132132
demonstration purposes. You might want to review this for production envs.
133133

134134
You need to have some admin permissions so that new deployments can be
@@ -154,23 +154,25 @@ Now, let's install the Monai Project components.
154154

155155
Easy, right?
156156

157-
> :Hint: If you look at the yaml file, you will notice that we setting
157+
> :bulb: If you look at the yaml file, you will notice that we setting
158158
the container image and the tag name to pull. We are using the devel
159159
image from the github registry. You may want to change that and use a
160160
more stable release for production environments and even pull t hem from
161161
a private container registry.
162-
> :Hint: In the yaml file, you will see that there are the secrets for
162+
163+
> :bulbt: In the yaml file, you will see that there are the secrets for
163164
mongodb and minio. In case you changed them earlier, you should change
164165
them as well in this yaml file. Not only the secrets, but also the
165166
endpoints. The endpoints are the name of the service in your kubernetes
166167
cluster. You can get this with `kubectl get services`.
167-
> :Hint: You can see in the yaml file that there is a specific syntax
168+
169+
> :bulb: You can see in the yaml file that there is a specific syntax
168170
for the configuration environment variables. All configuration variables
169171
can be overwritten with environment variables in this yaml file. To see
170172
the list of variables, see the application.settings file in
171173
src/TaskManager/TaskManager . You will easily guess the syntax ;)
172174

173-
> :Hint: You can see that we are setting the environment variables
175+
> :waning: You can see that we are setting the environment variables
174176
`ASPNETCORE_ENVIRONMENT` and `DOTNET_ENVIRONMENT` . This is to enable
175177
debug messages and tooling. For production environments you should
176178
change that.
@@ -181,7 +183,7 @@ change that.
181183

182184
``` helm upgrade -i -n monai -f MWM.yaml mwm . ```
183185

184-
> :Hint: All previous hints warnings in the Monai Task Manager can be
186+
> All previous :bulb: and :warnings: warnings in the Monai Task Manager can be
185187
applied.
186188

187189
With the Worfklow Manager installed, there is only one last piece to
@@ -197,8 +199,9 @@ install the Monai Informatics Gateway.
197199

198200
```
199201
MIG=$(kubectl get pods --no-headers -o=name --selector=app.kubernetes.io/instance=mig)
200-
kubectl exec -ti ${MIG} -- curl --location --request POST 'http://localhost:5000/config/ae/' --header 'Content-Type: application/json' --data-raw '{ "aeTitle": "MONAISCU", "name": "MONAISCU" }```
202+
kubectl exec -ti ${MIG} -- curl --location --request POST 'http://localhost:5000/config/ae/' --header 'Content-Type: application/json' --data-raw '{ "aeTitle": "MONAISCU", "name": "MONAISCU" }'
201203
kubectl exec -ti ${MIG} -- curl --location --request POST http://localhost:5000/config/destination --header 'Content-Type: application/json' --data-raw '{"name": "ORTHANC", "hostIp": "orthanc-monai", "port": 4242, "aeTitle": "ORTHANC"}'
204+
```
202205

203206
Note without this extra step, you will not be able to connect to and from
204207
Orthanc.
@@ -211,7 +214,7 @@ And now is time to install Orthanc, the last piece.
211214

212215
``` helm upgrade -i -n monai -f orthanc.yaml orthanc . ```
213216

214-
> :Warning: As before, note credentials are in the yaml file. You should
217+
> :warning: As before, note credentials are in the yaml file. You should
215218
change that for production environments.
216219

217220
Congrats! You have finish the setup! Now let's test it.
@@ -222,7 +225,7 @@ We need to access the orthanc web interface. We can do this by using port-forwar
222225

223226
```kubectl port-forward services/orthanc-monai 4242:4242 8042:8042```
224227

225-
> :Warning: for production environments, you will need something more
228+
> :warning: for production environments, you will need something more
226229
sophisticated, like a load balancer.
227230

228231
Now you can open your browser and point it to `http://127.0.0.1:8042`.
@@ -251,7 +254,7 @@ https://github.com/Project-MONAI/monai-deploy/blob/main/e2e-testing/test-scenari
251254
Review the namespace that should be one you have setup. If you followed
252255
the example in this README, it should be "monai".
253256

254-
> :Hint: You could also use curl and use the REST API
257+
> :bulb: You could also use curl and use the REST API
255258
256259

257260
### Clinical Workflow
@@ -275,7 +278,7 @@ the example in this README, it should be "monai".
275278
Review the "ae_title" value. If you have followed the example in this
276279
README, it should be "MONAISCU".
277280

278-
> :Warning: On a production environment swagger won't be available.
281+
> :warning: On a production environment swagger won't be available.
279282
You can still use the REST api.
280283

281284

@@ -308,7 +311,7 @@ If you want to uninstall, just run
308311
sudo /usr/local/bin/k3s-uninstall.sh
309312
```
310313

311-
> :Warning: This will erase everything!
314+
> :warning: This will erase everything!
312315
313316

314317
## Troubleshooting
@@ -485,7 +488,7 @@ e2-standard-2.
485488

486489
Now, you can run all the helm and kubectl commands above.
487490

488-
```Warning: Using GKE with GPUs will cost you money, be careful with
491+
```warning: Using GKE with GPUs will cost you money, be careful with
489492
that. ```
490493
491494

0 commit comments

Comments
 (0)