Skip to content

Commit 8af5caf

Browse files
author
Martin Jackson
committed
Pacify super-linter
1 parent aa8221a commit 8af5caf

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

roles/vault_utils/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ For each `ssCsiWorkloadAuth` entry:
8888
- required: `serviceAccount`
8989
- optional: `namespace`, `cluster`, `roleSlug` (or `role_slug`)
9090

91-
For spokes, `cluster` in values can be the **managed cluster group** name (default), the ACM **`ManagedCluster` name**, the spoke **FQDN** (`vault_path`, same as Vault/ESO), or **`metadata.labels.clusterGroup`**. During `vault_spokes_init`, rows are **normalized** so spoke Vault roles always use **`vault_path`** (full cluster DNS name) as the cluster id, matching ESO and the Kubernetes auth mount path on the spoke.
91+
For spokes, `cluster` in values can be the **managed cluster group** name (default), the ACM **`ManagedCluster` name**, the spoke **FQDN** (`vault_path`, same as Vault/ESO), or **`metadata.labels.clusterGroup`**.
92+
During `vault_spokes_init`, rows are **normalized** so spoke Vault roles always use **`vault_path`** (full cluster DNS name) as the cluster ID, matching ESO and the Kubernetes auth mount path on the spoke.
9293

9394
**Charts (vp-sscsi-spc):** `SecretProviderClass` workload auth should use the same
9495
idea: with `roleSlug` set, the chart emits **`roleName: <vaultKubernetesMountPath>-sscsi-<roleSlug>`**

secrets-initialization-and-vault-unseal.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,15 @@ Summary:
105105
`vault_ss_csi_workload_auth.yaml` includes **`vault_ss_csi_load_clustergroup_values.yaml`**, which prefers an in-cluster **`ConfigMap`** so SS CSI sees **merged** values (including GitOps overrides), then optionally falls back to the local **`values-<clustergroup>.yaml`** file under `pattern_dir`.
106106

107107
- **Default `ConfigMap`:** namespace **`openshift-gitops`**, name **`values-<main_clustergroupname>`** (same stem as the usual values file), YAML in a data key tried from **`vault_ss_csi_clustergroup_configmap_key_candidates`** (for example **`values.yaml`**) unless **`vault_ss_csi_clustergroup_configmap_key`** is set.
108-
- **Requirement:** the decoded YAML must have a top-level **`clusterGroup`** map (same shape as the repo values file). The role then scans **`clusterGroup.applications`** and **`clusterGroup.managedClusterGroups`** for **`ssCsiWorkloadAuth`**.
108+
- **Requirement:** the decoded YAML must have a top-level **`clusterGroup`** map (same shape as the repository values file). The role then scans **`clusterGroup.applications`** and **`clusterGroup.managedClusterGroups`** for **`ssCsiWorkloadAuth`**.
109109
- **Fallback:** when **`vault_ss_csi_fallback_local_clustergroup_file`** is true (default), it uses **`vault_ss_csi_cluster_values_file`** if set, else **`{{ pattern_dir }}/values-{{ main_clustergroupname }}.yaml`**.
110110
- **Disable cluster read:** set **`vault_ss_csi_clustergroup_values_from_configmap`** to false to use only the file path.
111111

112-
**Spoke cluster id and charts:** Before applying SS CSI roles on spokes, **`vault_ss_csi_normalize_spoke_entries_to_vault_path.yaml`** rewrites each spoke row so **`cluster` equals `vault_path`** (spoke FQDN) for every cluster that has External Secrets token data (`esoToken`). That matches Vault Kubernetes auth mounts and ESO. Pattern charts that render **`SecretProviderClass`** via **vp-sscsi-spc** should keep **`global.clusterDomain`** set to that same FQDN on the spoke; the library builds **`spec.parameters.roleName`** as **`<vaultKubernetesMountPath>-sscsi-<roleSlug>`**, using the mount path (not the short `ssCsiWorkloadAuth.cluster` label).
112+
**Spoke cluster ID and charts:** Before applying SS CSI roles on spokes,
113+
`**vault_ss_csi_normalize_spoke_entries_to_vault_path.yaml`** rewrites each spoke row so **`cluster` equals `vault_path`**
114+
(spoke FQDN) for every cluster that has External Secrets token data (`esoToken`).
115+
That matches Vault Kubernetes auth mounts and ESO.
116+
Pattern charts that render **`SecretProviderClass`** via **vp-sscsi-spc** should keep **`global.clusterDomain`** set to that same FQDN on the spoke; the library builds **`spec.parameters.roleName`** as **`<vaultKubernetesMountPath>-sscsi-<roleSlug>`**, using the mount path (not the short `ssCsiWorkloadAuth.cluster` label).
113117

114118
### Vault route CA for SS CSI TLS
115119

0 commit comments

Comments
 (0)