Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deployment Strategy section Update companions.md #192

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Deployment Strategy section Update companions.md #192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/companions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,9 @@ The list of available handlebars variables:

### Deployment Strategy

Companions offer different deployment strategies so that a companion could be restarted or not under certain conditions. Therefore, PREvant offers following configuration flags:
Companions offer different deployment strategies, enabling a companion to be
restarted or remain running based on specific conditions. Therefore, PREvant
offers following configuration flags:

```toml
[companions.openid]
Expand All @@ -143,10 +145,10 @@ image = 'private.example.com/library/openid:latest'
deploymentStrategy = 'redeploy-on-image-update'
```

`deploymentStrategy` offers the following values and if a companion exists for an app following strategy will be applied:
`deploymentStrategy` offers the following values and if a companion exists for an app, following strategy will be applied:

- `redeploy-always` (_default_): Re-deploys the companion every time there is a new deployment request.
- `redeploy-on-image-update`: Re-deploys the companion if there is a more rescent image available.
- `redeploy-on-image-update`: Re-deploys the companion if there is a newer image version available.
- `redeploy-never`: Even if there is a new deployment request the companion won't be redeployed and stays running.

### Storage Strategy
Expand Down
Loading