You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
S3CSI-195: Update user-facing docs for secret configuration requirement
Update dynamic provisioning user documentation to reflect actual behavior:
Changes to overview.md:
- Clarify two authentication modes (secret-based vs driver-level)
- Emphasize both secrets must be configured together
- Explain CSI limitation preventing node-only secret detection
Changes to storageclass-reference-and-usage-examples.md:
- Removed misleading 'only node-publish-secret' example
- Removed 'only provisioner-secret' example
- Added 'shared secret' example showing both pointing to same Secret
- Added warning callout about single secret configuration
These updates align user-facing docs with the implementation and prevent
users from attempting unsupported configurations.
Copy file name to clipboardExpand all lines: docs/volume-provisioning/dynamic-provisioning/overview.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,12 +167,20 @@ Dynamic provisioning supports all [mount options](../mount-options.md) through t
167
167
168
168
## Authentication
169
169
170
-
Dynamic provisioning requires two sets of credentials. If either or both credential types are missing from the StorageClass configuration, the CSI driver will fall back to the default driver-level credentials.
170
+
Dynamic provisioning supports two authentication modes:
171
171
172
-
1. **Provisioner Secrets**: Used by CSI controller for bucket creation and deletion
173
-
2. **Node Secrets**: Used by nodes for mounting operations
172
+
1. **Secret-based Authentication (Recommended)**: Configure **both** `provisioner-secret` and `node-publish-secret` in StorageClass
173
+
- **Provisioner Secret**: Used by CSI controller for bucket creation/deletion
174
+
- **Node-Publish Secret**: Used by nodes for mounting operations
175
+
- Both secrets can point to the same Secret or different Secrets (for least privilege)
174
176
175
-
See the [Credential Management Guide](../../architecture/ring-s3-credentials-management/dynamic-provisioning-credentials-management.md) for detailed configuration.
177
+
2. **Driver-level Authentication**: Omit both secret parameters to use driver-level credentials for all operations
178
+
179
+
**Important:** Both secrets must be configured together when using secret-based authentication.
180
+
The controller cannot detect if only `node-publish-secret` is configured (CSI specification limitation),
181
+
so configuring only one secret will result in driver-level credentials being used.
182
+
183
+
See the [Credential Management Guide](../../architecture/ring-s3-credentials-management/dynamic-provisioning-credentials-management.md) for detailed configuration and examples.
0 commit comments