Skip to content

Commit 167af94

Browse files
committed
Add document for SubscriptionConfig
This commit introduces a document that highlights how a user can configure operators deployed via OLM.
1 parent 0725370 commit 167af94

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

doc/design/subscription-config.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Subscription Config
2+
3+
## Configuring Operators deployed by OLM
4+
5+
It is possible to configure how OLM deploys an operator via the `config` field in the [subscription](../../pkg/api/apis/operators/subscription_types.go) object.
6+
7+
Currently, the OLM supports the following configurations:
8+
9+
### Env
10+
11+
The `Env` field defines a list of environment variables that must exist in all containers in the `pod` created by OLM.
12+
13+
> Note: Values defined here will overwrite existing environment varaibles of the same name.
14+
15+
### EnvFrom
16+
17+
The `EnvFrom` field defines a list of sources to populate environment variables in the container.
18+
The keys defined within a source must be a C_IDENTIFIER.
19+
All invalid keys will be reported as an event when the container is starting.
20+
When a key exists in multiple sources, the value associated with the last source will take precedence.
21+
22+
> Note: Values defined by an Env with a duplicate key will take precedence.
23+
24+
### Volumes
25+
26+
The `Volumes` field defines a list of [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) that must exist on the `pod` created by OLM.
27+
28+
> Note: Volumes defined here will overwrite existing Volumes of the same name.
29+
30+
### VolumeMounts
31+
32+
The `VolumeMounts` field defines a list of [volumeMounts](https://kubernetes.io/docs/concepts/storage/volumes/) that must exist in all containers in the `pod` created by OLM. If a `volumeMount` references a `volume` that does not exist, OLM will fail to deploy the operator.
33+
34+
> Note: VolumeMounts defined here will overwrite existing VolumeMounts of the same name.

0 commit comments

Comments
 (0)