Skip to content

Commit fc5658d

Browse files
author
Martin Jackson
committed
Fix doc comments
1 parent 44871af commit fc5658d

3 files changed

Lines changed: 12 additions & 8 deletions

File tree

Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
apiVersion: v2
33
name: vp-sscsi-spc
4-
version: 0.1.2
4+
version: 0.1.3
55
description: >-
66
Library chart for app-level Vault SecretProviderClass rendering with hub, spoke, and
77
external Vault support. Cluster CA material is managed by a separate cluster-wide chart.

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# vp-sscsi-spc
22

3-
![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square)
3+
![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square)
44

55
Library chart for app-level Vault SecretProviderClass rendering with hub, spoke, and external Vault support. Cluster CA material is managed by a separate cluster-wide chart.
66

7-
This chart is the app-level SecretProviderClass companion to the cluster-wide Vault CSI chart.
7+
This chart is the **library for `SecretProviderClass` only**, **one dependency per application chart** that consumes Vault via SSCSI.
8+
9+
**Vault CSI provider DaemonSet and TLS trust on the provider** (for example projected proxy cluster CA) are installed by **`openshift-sscsi-vault`** (chart **0.2.0+**), not this library. The **`openshift-sscsi-vault`** is provided for this.
810

911
### Scope
1012

11-
This chart renders SecretProviderClass manifests only. Use it from application charts that need:
13+
This chart renders **only** `SecretProviderClass` YAML (named templates or optional `installDefaultManifests`). Use it from application charts that need:
1214

1315
- Hub-cluster Vault auth (`hub` mount + role)
1416
- Spoke-cluster auth to centralized Vault (`clusterDomain` mount + role)
1517
- External Vault endpoint override (`vault.externalAddress`)
1618
- Optional reference to a pre-mounted CA path (`tls.vaultCACertPath`)
1719
- Optional app-key driven workload auth lookup from `clusterGroup.applications[*].ssCsiWorkloadAuth`
1820

19-
This chart does not create or source CA ConfigMaps. Cluster-wide CA management stays in the cluster component chart.
21+
This chart does not install the CSI provider or mount trust bundles; set **`tls.vaultCACertPath`** to match whatever path the **provider** exposes (for example under **`/etc/pki/vault-ca`** from **`openshift-sscsi-vault`** defaults).
2022

2123
### Usage from parent charts
2224

README.md.gotmpl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@
55

66
{{ template "chart.description" . }}
77

8-
This chart is the app-level SecretProviderClass companion to the cluster-wide Vault CSI chart.
8+
This chart is the **library for `SecretProviderClass` only**, **one dependency per application chart** that consumes Vault via SSCSI.
9+
10+
**Vault CSI provider DaemonSet and TLS trust on the provider** (for example projected proxy cluster CA) are installed by **`openshift-sscsi-vault`** (chart **0.1.0+**), not this library.
911

1012
### Scope
1113

12-
This chart renders SecretProviderClass manifests only. Use it from application charts that need:
14+
This chart renders **only** `SecretProviderClass` YAML (named templates or optional `installDefaultManifests`). Use it from application charts that need:
1315

1416
- Hub-cluster Vault auth (`hub` mount + role)
1517
- Spoke-cluster auth to centralized Vault (`clusterDomain` mount + role)
1618
- External Vault endpoint override (`vault.externalAddress`)
1719
- Optional reference to a pre-mounted CA path (`tls.vaultCACertPath`)
1820
- Optional app-key driven workload auth lookup from `clusterGroup.applications[*].ssCsiWorkloadAuth`
1921

20-
This chart does not create or source CA ConfigMaps. Cluster-wide CA management stays in the cluster component chart.
22+
This chart does not install the CSI provider or mount trust bundles; set **`tls.vaultCACertPath`** to match whatever path the **provider** exposes (for example under **`/etc/pki/vault-ca`** from **`openshift-sscsi-vault`** defaults).
2123

2224
### Usage from parent charts
2325

0 commit comments

Comments
 (0)