Skip to content

Commit f775edb

Browse files
authored
ServiceControl --setup-and-run docs (#6816)
* ServiceControl --setup-and-run docs * Make setup-and-run a secondary option * Bring the bit about different settings higher * cotnainer
1 parent 97666a4 commit f775edb

File tree

3 files changed

+48
-9
lines changed

3 files changed

+48
-9
lines changed

servicecontrol/audit-instances/deployment/containers.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ docker run -d --name audit -p 44444:44444 \
1616
```
1717
## Initial setup
1818

19-
Before running the container image normally, it must be run in setup mode to create the required message queues.
19+
Before running the container image normally, it must run in setup mode to create the required message queues and perform upgrade tasks.
2020

2121
The container image will run in setup mode by adding the `--setup` argument. For example:
2222

@@ -25,11 +25,24 @@ The container image will run in setup mode by adding the `--setup` argument. For
2525
docker run --rm {OPTIONS} particular/servicecontrol-audit --setup
2626
```
2727

28-
Depending on the requirements of the message transport, setup mode may require different connection settings that have permissions to create queues, which are not necessary during non-setup runtime.
28+
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.
2929

3030
After setup is complete, the container will exit, and the `--rm` (or equivalent) option may be used to automatically remove the container.
3131

32-
The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
32+
The setup process should be repeated any time the container is [updated to a new version](#upgrading).
33+
34+
### Simplified setup
35+
36+
Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:
37+
38+
```shell
39+
# Using docker run
40+
docker run {OPTIONS} particular/servicecontrol-audit --setup-and-run
41+
```
42+
43+
The `--setup-and-run` argument will run the setup process when the container is run, after which the application will run normally. This simplifies deployment by removing the need for a separate init container in environments where the setup process does not need different settings.
44+
45+
Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.
3346

3447
## Required settings
3548

servicecontrol/monitoring-instances/deployment/containers.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ docker run -d --name monitoring -p 33633:33633 \
1515
```
1616
## Initial setup
1717

18-
Before running the container image normally, it must be run in setup mode to create the required message queues.
18+
Before running the container image normally, it must run in setup mode to create the required message queues and perform upgrade tasks.
1919

2020
The container image will run in setup mode by adding the `--setup` argument. For example:
2121

@@ -24,11 +24,24 @@ The container image will run in setup mode by adding the `--setup` argument. For
2424
docker run --rm {OPTIONS} particular/servicecontrol-monitoring --setup
2525
```
2626

27-
Depending on the requirements of the message transport, setup mode may require different connection settings that have permissions to create queues, which are not necessary during non-setup runtime.
27+
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.
2828

2929
After setup is complete, the container will exit, and the `--rm` (or equivalent) option may be used to automatically remove the container.
3030

31-
The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
31+
The setup process should be repeated any time the container is [updated to a new version](#upgrading).
32+
33+
### Simplified setup
34+
35+
Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:
36+
37+
```shell
38+
# Using docker run
39+
docker run {OPTIONS} particular/servicecontrol-monitoring --setup-and-run
40+
```
41+
42+
The `--setup-and-run` argument will run the setup process when the container is run, after which the application will run normally. This simplifies deployment by removing the need for a separate init container in environments where the setup process does not need different settings.
43+
44+
Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.
3245

3346
## Required settings
3447

servicecontrol/servicecontrol-instances/deployment/containers.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ docker run -d --name servicecontrol -p 33333:33333 \
1717
```
1818
## Initial setup
1919

20-
Before running the container image normally, it must be run in setup mode to create the required message queues.
20+
Before running the container image normally, it must run in setup mode to create the required message queues and perform upgrade tasks.
2121

2222
The container image will run in setup mode by adding the `--setup` argument. For example:
2323

@@ -26,11 +26,24 @@ The container image will run in setup mode by adding the `--setup` argument. For
2626
docker run --rm {OPTIONS} particular/servicecontrol --setup
2727
```
2828

29-
Depending on the requirements of the message transport, setup mode may require different connection settings that have permissions to create queues, which are not necessary during non-setup runtime.
29+
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.
3030

3131
After setup is complete, the container will exit, and the `--rm` (or equivalent) option may be used to automatically remove the container.
3232

33-
The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
33+
The setup process should be repeated any time the container is [updated to a new version](#upgrading).
34+
35+
### Simplified setup
36+
37+
Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:
38+
39+
```shell
40+
# Using docker run
41+
docker run {OPTIONS} particular/servicecontrol --setup-and-run
42+
```
43+
44+
The `--setup-and-run` argument will run the setup process when the container is run, after which the application will run normally. This simplifies deployment by removing the need for a separate init container in environments where the setup process does not need different settings.
45+
46+
Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.
3447

3548
## Required settings
3649

0 commit comments

Comments
 (0)