Skip to content

Commit

Permalink
docs: update openparam example
Browse files Browse the repository at this point in the history
  • Loading branch information
jaydesl authored Nov 16, 2023
1 parent ce1f279 commit 05d36b8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/adv/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ Open Parameters.
For open parameters, use the `${PARAMETER_NAME}` syntax to refer to them,
for example in a Microservice's Docker-Compose.

In Compose, you can still use regular environment variable shell substition within the
`args` or `entrypoint` fields of the Compose, as in the example below. Please note that
as per [Compose documentation](https://docs.docker.com/compose/compose-file/compose-file-v2/#variable-substitution)
a single dollar-sign `$` must be escaped, by using double dollar-signs `$$`.

=== "Defining Parameters"

``` yaml
Expand Down Expand Up @@ -56,8 +61,13 @@ for example in a Microservice's Docker-Compose.
services:
ristra:
image: dbs-container-repo.emgora.eu/db-ristra-cli-cpu:1.0.0
entrypoint: python -m connect ${MINIO_URL} --user $MINIOUSER --pass $MINIOPASS
entrypoint: python -m connect ${MINIO_URL} --user $$MINIOUSER --pass $$MINIOPASS
environment:
MINIOUSER: ${MINIO_ROOT_USER}
MINIOPASS: ${MINIO_ROOT_PASS}
```

!!! warning
Note that due to a bug in external tooling, environment variables with underscores
in their names are not supported for shell substitution. If you need environment
variable shell substitution, please use environment variables named without underscores.

0 comments on commit 05d36b8

Please # to comment.