Skip to content

Commit

Permalink
feat(faq): adding faq docs around using the csi driver (#763)
Browse files Browse the repository at this point in the history
* feat(faq): adding faq docs around using the csi driver

Signed-off-by: rumstead <37445536+rumstead@users.noreply.github.com>

* Update content/en/docs/FAQ/installation.md

Co-authored-by: John Mazzitelli <mazz@redhat.com>

* Update content/en/docs/FAQ/installation.md

Co-authored-by: John Mazzitelli <mazz@redhat.com>

* Update content/en/docs/FAQ/installation.md

Co-authored-by: John Mazzitelli <mazz@redhat.com>

* Retrigger CI pipeline

Signed-off-by: rumstead <37445536+rumstead@users.noreply.github.com>

* Update content/en/docs/FAQ/installation.md

Co-authored-by: John Mazzitelli <mazz@redhat.com>

---------

Signed-off-by: rumstead <37445536+rumstead@users.noreply.github.com>
Co-authored-by: John Mazzitelli <mazz@redhat.com>
  • Loading branch information
rumstead and jmazzitelli committed Mar 14, 2024
1 parent 374bdc2 commit d47d76b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion content/en/docs/FAQ/installation.md
Expand Up @@ -153,7 +153,7 @@ NAME READY STATUS RESTARTS AGE
kiali-56bbfd644-nkhlw 2/2 Running 0 43s
```

### How Can I Specify a Container Image Digest Hash When Installing Kiali Server and Kiali Operator?
### How can I specify a container image digest hash when installing Kiali Server and Kiali Operator?

To tell the operator to install a specific container image using a digest hash, you must use the `deployment.image_digest` setting in conjunction with the `deployment.image_version` setting. `deployment.image_version` is simply the digest hash code and `deployment.image_digest` is the type of digest (most likely you want to set this value to `sha256`). So for example, in your Kiali CR you will want something like this:

Expand All @@ -174,3 +174,15 @@ As for the operator itself, when installing the operator using its helm chart, t
helm install --set image.tag=7336eb77199a4d737435a8bf395e1666b7085cc7f0ad8b4cf9456b7649b7d6ad --set image.digest=sha256 ...and the rest of the helm install options...
```

### How can I use a CSI Driver to expose a custom secret to the Kiali Server?
You first must already have a [CSI driver and provider installed](https://secrets-store-csi-driver.sigs.k8s.io/introduction)
in your cluster and a valid [SecretProviderClass](https://secrets-store-csi-driver.sigs.k8s.io/concepts.html?#secretproviderclass) deployed in the namespace where Kiali is installed.

To mount a secret exposed by the CSI Driver, you can use the [custom_secret](https://kiali.io/docs/configuration/kialis.kiali.io/#.spec.deployment.custom_secrets) configuration
to supply the [CSI volume source](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) on the pod. The [Kiali CR reference docs](https://kiali.io/docs/configuration/kialis.kiali.io/#example-cr) have an example.
The Kiali Operator or server helm chart will automatically expose the secret as a volume mount into the container at the specified mount location.

Although Kiali retrieves the secret over the Kubernetes API, [mounting the secret](https://secrets-store-csi-driver.sigs.k8s.io/topics/sync-as-kubernetes-secret) is required for the CSI Driver to create the backing Kubernetes secret.
Note that the [`custom_secrets` `optional` flag](https://kiali.io/docs/configuration/kialis.kiali.io/#.spec.deployment.custom_secrets[*].optional) is ignored when mounting secrets from the CSI provider. The secrets are required to exist - then cannot be optional.


0 comments on commit d47d76b

Please sign in to comment.