Skip to content

Commit

Permalink
ServiceControl --setup-and-run docs (#6816)
Browse files Browse the repository at this point in the history
* ServiceControl --setup-and-run docs

* Make setup-and-run a secondary option

* Bring the bit about different settings higher

* cotnainer
  • Loading branch information
DavidBoike authored Aug 26, 2024
1 parent 97666a4 commit f775edb
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 9 deletions.
19 changes: 16 additions & 3 deletions servicecontrol/audit-instances/deployment/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ docker run -d --name audit -p 44444:44444 \
```
## Initial setup

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

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

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

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.
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.

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

The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
The setup process should be repeated any time the container is [updated to a new version](#upgrading).

### Simplified setup

Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:

```shell
# Using docker run
docker run {OPTIONS} particular/servicecontrol-audit --setup-and-run
```

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.

Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.

## Required settings

Expand Down
19 changes: 16 additions & 3 deletions servicecontrol/monitoring-instances/deployment/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ docker run -d --name monitoring -p 33633:33633 \
```
## Initial setup

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

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

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

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.
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.

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

The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
The setup process should be repeated any time the container is [updated to a new version](#upgrading).

### Simplified setup

Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:

```shell
# Using docker run
docker run {OPTIONS} particular/servicecontrol-monitoring --setup-and-run
```

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.

Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.

## Required settings

Expand Down
19 changes: 16 additions & 3 deletions servicecontrol/servicecontrol-instances/deployment/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ docker run -d --name servicecontrol -p 33333:33333 \
```
## Initial setup

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

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

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

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.
Setup mode may require different settings, such as a different transport connection string with permissions to create queues.

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

The initial setup should be repeated any time the container is [updated to a new version](#upgrading).
The setup process should be repeated any time the container is [updated to a new version](#upgrading).

### Simplified setup

Instead of running `--setup` as a separate container, the setup and run operations can be combined using the `--setup-and-run` argument:

```shell
# Using docker run
docker run {OPTIONS} particular/servicecontrol --setup-and-run
```

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.

Using `--setup-and-run` removes the need to repeat a setup process when the container is updated to a new version.

## Required settings

Expand Down

0 comments on commit f775edb

Please sign in to comment.