Skip to content

Commit 2da8239

Browse files
TomFernTomFern
authored
docs: fix upgrade instructions (#194)
## 📝 Description Fix upgrade instructions to use the command that will always work. ## ✅ Checklist - [X] I have tested this change - [ ] This change requires documentation update
1 parent 7c00feb commit 2da8239

File tree

5 files changed

+93
-10
lines changed

5 files changed

+93
-10
lines changed

‎docs/versioned_docs/version-CE/getting-started/install-aws-ec2.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,14 +411,31 @@ To upgrade Semaphore from version `v1.0.x`, follow these steps:
411411
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
412412
kubectl get nodes
413413
```
414+
3. Load you configuration file and ensure the certificates are located in the right folder. See [Step 8](#certs) if you need to regenerate the certificates.
414415

415-
3. Run the following command to upgrade to `v1.1.0`
416+
```shell
417+
source semaphore-config
418+
echo "DOMAIN=${DOMAIN}"
419+
echo "IP_ADDRESS=${IP_ADDRESS}"
420+
ls certs/live/${DOMAIN}/fullchain.pem
421+
ls certs/live/${DOMAIN}/privkey.pem
422+
```
423+
424+
4. Run the following command to upgrade to `v1.1.0`
416425

417426
```shell
418427
helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
419428
--debug \
420429
--version v1.1.0 \
421-
--reuse-values
430+
--timeout 20m \
431+
--set global.domain.ip=${IP_ADDRESS} \
432+
--set global.domain.name=${DOMAIN} \
433+
--set ingress.enabled=true \
434+
--set ingress.ssl.enabled=true \
435+
--set ingress.className=traefik \
436+
--set ingress.ssl.type=custom \
437+
--set ingress.ssl.crt=$(cat certs/live/${DOMAIN}/fullchain.pem | base64 -w 0) \
438+
--set ingress.ssl.key=$(cat certs/live/${DOMAIN}/privkey.pem | base64 -w 0)
422439
```
423440

424441
</Steps>

‎docs/versioned_docs/version-CE/getting-started/install-eks.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,13 +225,29 @@ To upgrade Semaphore from version `v1.0.x`, follow these steps:
225225
kubectl get nodes
226226
```
227227

228-
3. Run the following command to upgrade to `v1.1.0`
228+
3. Source the config file:
229+
230+
```shell
231+
source aws-config
232+
echo "DOMAIN=${DOMAIN}"
233+
echo "CERT_NAME=${CERT_NAME}"
234+
```
235+
236+
4. Run the following command to upgrade to `v1.1.0`
229237

230238
```shell
231239
helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
232240
--debug \
233241
--version v1.1.0 \
234-
--reuse-values
242+
--timeout 20m \
243+
--set global.domain.ip=${IP_ADDRESS} \
244+
--set global.domain.name=${DOMAIN} \
245+
--set ingress.enabled=true \
246+
--set ingress.ssl.enabled=true \
247+
--set ingress.className=traefik \
248+
--set ingress.ssl.type=custom \
249+
--set ingress.ssl.crt=$(cat certs/live/${DOMAIN}/fullchain.pem | base64 -w 0) \
250+
--set ingress.ssl.key=$(cat certs/live/${DOMAIN}/privkey.pem | base64 -w 0)
235251
```
236252

237253
</Steps>

‎docs/versioned_docs/version-CE/getting-started/install-gcompute.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -404,13 +404,31 @@ To upgrade Semaphore from version `v1.0.x`, follow these steps:
404404
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
405405
kubectl get nodes
406406
```
407+
3. Load the configuration file and ensure the certificates are located on the correct folders. See [Step 9](#certs) if you need to regenerate the certificates.
407408

408-
3. Run the following command to upgrade to `v1.1.0`
409+
```shell
410+
source semaphore-config
411+
echo "DOMAIN=${DOMAIN}"
412+
echo "IP_ADDRESS=${IP_ADDRESS}"
413+
ls certs/live/${DOMAIN}/fullchain.pem
414+
ls certs/live/${DOMAIN}/privkey.pem
415+
```
416+
417+
4. Run the following command to upgrade to `v1.1.0`
409418

410419
```shell
411420
helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
421+
--debug \
412422
--version v1.1.0 \
413-
--reuse-values
423+
--timeout 20m \
424+
--set global.domain.ip=${IP_ADDRESS} \
425+
--set global.domain.name=${DOMAIN} \
426+
--set ingress.enabled=true \
427+
--set ingress.ssl.enabled=true \
428+
--set ingress.className=traefik \
429+
--set ingress.ssl.type=custom \
430+
--set ingress.ssl.crt=$(cat certs/live/${DOMAIN}/fullchain.pem | base64 -w 0) \
431+
--set ingress.ssl.key=$(cat certs/live/${DOMAIN}/privkey.pem | base64 -w 0)
414432
```
415433

416434
</Steps>

‎docs/versioned_docs/version-CE/getting-started/install-gke.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,14 +384,31 @@ To upgrade Semaphore from version `v1.0.x`, follow these steps:
384384
```shell
385385
kubectl get nodes
386386
```
387+
3. Load the configuration file and ensure the certificates are in the correct folder. See [Step 4](#certs) if you need to recreate the certificates.
387388
388-
3. Run the following command to upgrade to `v1.1.0`
389+
```shell
390+
source google-config
391+
echo "DOMAIN=${DOMAIN}"
392+
echo "IP_ADDRESS=${IP_ADDRESS}"
393+
echo "GOOGLE_CERTIFICATE_NAME=${GOOGLE_CERTIFICATE_NAME}"
394+
echo "GOOGLE_STATIC_IP_NAME=${GOOGLE_STATIC_IP_NAME}"
395+
ls certs/live/${DOMAIN}/privkey.pem certs/live/${DOMAIN}/fullchain.pem
396+
```
397+
4. Run the following command to upgrade to `v1.1.0`
389398
390399
```shell
391400
helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
392401
--debug \
393402
--version v1.1.0 \
394-
--reuse-values
403+
--timeout 20m \
404+
--set global.domain.ip=${IP_ADDRESS} \
405+
--set global.domain.name=${DOMAIN} \
406+
--set ingress.enabled=true \
407+
--set ingress.ssl.enabled=true \
408+
--set ingress.className=traefik \
409+
--set ingress.ssl.type=custom \
410+
--set ingress.ssl.crt=$(cat certs/live/${DOMAIN}/fullchain.pem | base64 -w 0) \
411+
--set ingress.ssl.key=$(cat certs/live/${DOMAIN}/privkey.pem | base64 -w 0)
395412
```
396413
397414
</Steps>

‎docs/versioned_docs/version-CE/getting-started/install-ubuntu.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,13 +281,28 @@ To upgrade Semaphore from version `v1.0.x`, follow these steps:
281281
kubectl get nodes
282282
```
283283

284-
3. Run the following command to upgrade to `v1.1.0`
284+
3. Source your configuration file and ensure your certificates are located in the expected folders. See [Step 4](#certs)
285+
286+
```shell
287+
source semaphore-config
288+
ls certs/live/${DOMAIN}/fullchain.pem
289+
ls certs/live/${DOMAIN}/privkey.pem
290+
```
291+
4. Run the following command to upgrade to `v1.1.0`
285292

286293
```shell
287294
helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
288295
--debug \
289296
--version v1.1.0 \
290-
--reuse-values
297+
--timeout 20m \
298+
--set global.domain.ip=${IP_ADDRESS} \
299+
--set global.domain.name=${DOMAIN} \
300+
--set ingress.enabled=true \
301+
--set ingress.ssl.enabled=true \
302+
--set ingress.className=traefik \
303+
--set ingress.ssl.type=custom \
304+
--set ingress.ssl.crt=$(cat certs/live/${DOMAIN}/fullchain.pem | base64 -w 0) \
305+
--set ingress.ssl.key=$(cat certs/live/${DOMAIN}/privkey.pem | base64 -w 0)
291306
```
292307

293308
</Steps>

0 commit comments

Comments
 (0)