Skip to content

Commit

Permalink
docs: clarify sync k8s secret namespace (#468)
Browse files Browse the repository at this point in the history
Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
  • Loading branch information
aramase committed Apr 13, 2021
1 parent 72a2c0b commit 6320300
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions website/content/en/configurations/sync-with-k8-secretes.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,16 @@ spec:

In some cases, you may want to create a Kubernetes Secret to mirror the mounted content. Use the optional `secretObjects` field to define the desired state of the synced Kubernetes secret objects.

> NOTE: Make sure the `objectName` in `secretObjects` matches the file name of the mounted content. This could be the object name or the object alias.
> NOTE: Make sure the `objectName` in `secretObjects` matches the file name of the mounted content. If object alias used, then it should be the object alias else this would be the object name.
> The secrets will only sync once you *start a pod mounting the secrets*. Solely relying on the syncing with Kubernetes secrets feature thus does not work.
{{% alert title="NOTE" color="warning" %}}

- The secrets will only sync once you *start a pod mounting the secrets*. Solely relying on the syncing with Kubernetes secrets feature thus does not work.
- The Kubernetes secrets will be synced to the same namespace as the application pod and `SecretProviderClass`.
{{% /alert %}}

A `SecretProviderClass` custom resource should have the following components:

```yaml
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
kind: SecretProviderClass
Expand Down

0 comments on commit 6320300

Please sign in to comment.