From 88603e42bd8c79de4b16e36132cf35052fdd5afa Mon Sep 17 00:00:00 2001 From: nrogerarkhn Date: Mon, 19 Jun 2023 17:03:20 +0200 Subject: [PATCH 1/2] Add queried endpoint to check Vault status when initializing issuer The Vault Issuer queries an endpoint to check is the Vault instance is healthy. When configuring the Issuer with a remote Vault instance protected behind a firewall, the 'Vault sealed or unintialized' error could be thrown when the endpoint could simply not be reached. There was no sign of this endpoint in the docs, so adding it for commodity. Signed-off-by: nrogerarkhn --- content/docs/configuration/vault.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/content/docs/configuration/vault.md b/content/docs/configuration/vault.md index c5d6df09236..26d0707f672 100644 --- a/content/docs/configuration/vault.md +++ b/content/docs/configuration/vault.md @@ -369,9 +369,15 @@ Kubernetes 1.24 and above. ## Verifying the issuer Deployment Once the Vault issuer has been deployed, it will be marked as ready if the -configuration is valid. Replace `issuers` here with `clusterissuers` if that is what has +configuration is valid. Replace `issuers` below with `clusterissuers` if that is what has been deployed. +The Vault issuer tests your Vault instance by querying the `v1/sys/health` +endpoint, to ensure your Vault instance is unsealed and initialized before +requesting certificates. The result of that query will populate the `STATUS` +column + + ```bash $ kubectl get issuers vault-issuer -n sandbox -o wide NAME READY STATUS AGE @@ -379,4 +385,4 @@ vault-issuer True Vault verified 2m ``` Certificates are now ready to be requested by using the Vault issuer named -`vault-issuer` within the `sandbox` namespace. \ No newline at end of file +`vault-issuer` within the `sandbox` namespace. From f7f6687333bdc23488e92b4e47fac8b6f50efbe8 Mon Sep 17 00:00:00 2001 From: nrogerarkhn Date: Mon, 19 Jun 2023 17:17:28 +0200 Subject: [PATCH 2/2] Fix typos Signed-off-by: nrogerarkhn --- content/docs/configuration/vault.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/docs/configuration/vault.md b/content/docs/configuration/vault.md index 26d0707f672..f2b15b54356 100644 --- a/content/docs/configuration/vault.md +++ b/content/docs/configuration/vault.md @@ -375,8 +375,7 @@ been deployed. The Vault issuer tests your Vault instance by querying the `v1/sys/health` endpoint, to ensure your Vault instance is unsealed and initialized before requesting certificates. The result of that query will populate the `STATUS` -column - +column. ```bash $ kubectl get issuers vault-issuer -n sandbox -o wide