Skip to content

Commit 0f11e75

Browse files
committed
Hardened ZTWIM GA documentation
Signed-off-by: Andrew Block <andy.block@gmail.com>
1 parent 208df3e commit 0f11e75

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

zero-trust-workload-identity-manager/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Do not use the `base` directory directly, as you will need to patch the `channel
1010

1111
The current *overlays* available are for the following channels:
1212

13+
* [stable-v1](operator/overlays/stable-v1)
1314
* [tech-preview](operator/overlays/tech-preview)
1415

1516
### Usage
@@ -37,22 +38,22 @@ resources:
3738

3839
## Deploy an Instance of Zero Trust Workload Identity Manager
3940

40-
Once the Operator has been installed, an instance of Zero Trust Workload Identity Manager can be deployed. The content is available within the [instance](instance) directory. Similar to the _operator_ deployment described in the prior section, it is not recommended to use the `base` directory, and instead use the contents in the `overlays/default` directory.
41+
Once the Operator has been installed, an instance of Zero Trust Workload Identity Manager can be deployed. The content is available within the [instance](instance) directory. Similar to the _operator_ deployment described in the prior section, it is not recommended to use the `base` directory, and instead use the contents in the `overlays/<channel>>` directory.
4142

4243
### Usage
4344

44-
The default instance enables the configuration of both the `trustDomain`, `jwtIssuer` and `clusterName` fields that are present across multiple Custom Resources associated with the Zero Trust Workload Identity Manager. Update either of these values as desired within the `patches` section of the [kustomization.yaml](instance/overlays/default/kustomization.yaml) file within the `instance/overlays/default` directory.
45+
Cluster specific values for `trustDomain`, `jwtIssuer` and `clusterName` fields that are present across multiple Custom Resources associated with the Zero Trust Workload Identity Manager. Update these values as desired within the `patches` section of the `kustomization.yaml` within the desired _overlay_ directory `instance/overlays/<channel>/kustomization.yaml`.
4546

4647
The instance can be installed by running the following command from the root of the `gitops-catalog` directory.
4748

4849
```
49-
oc apply -k zero-trust-workload-identity-manager/instance/overlays/stable-v1
50+
oc apply -k zero-trust-workload-identity-manager/instance/overlays/<channel>
5051
```
5152

5253
Or, without cloning:
5354

5455
```
55-
oc apply -k https://github.com/redhat-cop/gitops-catalog/zero-trust-workload-identity-manager/instance/overlays/stable-v1
56+
oc apply -k https://github.com/redhat-cop/gitops-catalog/zero-trust-workload-identity-manager/instance/overlays/<channel>
5657
```
5758

5859

zero-trust-workload-identity-manager/instance/overlays/stable-v1/kustomization.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,6 @@ patches:
3030
- op: replace
3131
path: /spec/trustDomain
3232
value: 'apps.example.openshift.io'
33+
- op: replace
34+
path: /spec/clusterName
35+
value: 'cluster'

0 commit comments

Comments
 (0)