From 10218d1ef7177cc45df04b089ad2065c0dfd0377 Mon Sep 17 00:00:00 2001 From: xxxbobrxxx Date: Thu, 13 May 2021 19:32:06 +0300 Subject: [PATCH] #150 Small corrections, generate docs --- ...ternal-secrets.io_clustersecretstores.yaml | 2 +- .../external-secrets.io_secretstores.yaml | 2 +- docs/spec.md | 119 ++++++++++++++++++ go.sum | 8 ++ 4 files changed, 129 insertions(+), 2 deletions(-) diff --git a/deploy/crds/external-secrets.io_clustersecretstores.yaml b/deploy/crds/external-secrets.io_clustersecretstores.yaml index da8aa8db4..33c020a94 100644 --- a/deploy/crds/external-secrets.io_clustersecretstores.yaml +++ b/deploy/crds/external-secrets.io_clustersecretstores.yaml @@ -200,7 +200,7 @@ spec: tokenSecretRef: description: SecretRef to a key in a Secret resource containing JWT token to authenticate with Vault - using the LDAP authentication method + using the JWT/OIDC authentication method properties: key: description: The key of the entry in the Secret diff --git a/deploy/crds/external-secrets.io_secretstores.yaml b/deploy/crds/external-secrets.io_secretstores.yaml index 0450d8886..59c709e32 100644 --- a/deploy/crds/external-secrets.io_secretstores.yaml +++ b/deploy/crds/external-secrets.io_secretstores.yaml @@ -200,7 +200,7 @@ spec: tokenSecretRef: description: SecretRef to a key in a Secret resource containing JWT token to authenticate with Vault - using the LDAP authentication method + using the JWT/OIDC authentication method properties: key: description: The key of the entry in the Secret diff --git a/docs/spec.md b/docs/spec.md index dbe38b83b..f9ef3b918 100644 --- a/docs/spec.md +++ b/docs/spec.md @@ -1359,6 +1359,80 @@ VaultKubernetesAuth token stored in the named Secret resource to the Vault server.

+ + +ldap
+ + +VaultLdapAuth + + + + +(Optional) +

Ldap authenticates with Vault by passing username/password pair using +the LDAP authentication method

+ + + + +jwt
+ + +VaultJwtAuth + + + + +(Optional) +

Jwt authenticates with Vault by passing role and JWT token using the +JWT/OIDC authentication method

+ + + + +

VaultJwtAuth +

+

+(Appears on: +VaultAuth) +

+

+

VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication +method, with the role name and token stored in a Kubernetes Secret resource.

+

+ + + + + + + + + + + + + + + +
FieldDescription
+role
+ +string + +		 +

Role is a JWT role to authenticate using the JWT/OIDC Vault +authentication method

+
+tokenSecretRef
+ +github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector + +		 +

SecretRef to a key in a Secret resource containing JWT token to +authenticate with Vault using the JWT/OIDC authentication method

+

VaultKVStoreVersion @@ -1456,6 +1530,51 @@ Kubernetes ServiceAccount with a set of Vault policies.

+

VaultLdapAuth +

+

+(Appears on: +VaultAuth) +

+

+

VaultLdapAuth authenticates with Vault using the LDAP authentication method, +with the username and password stored in a Kubernetes Secret resource.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+username
+ +string + +		 +

Username is a LDAP user name used to authenticate using the LDAP Vault +authentication method

+
+tokenSecretRef
+ +github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector + +		 +

SecretRef to a key in a Secret resource containing password for the LDAP +user used to authenticate with Vault using the LDAP authentication +method

+

VaultProvider

diff --git a/go.sum b/go.sum index 79173326e..f8b4b531f 100644 --- a/go.sum +++ b/go.sum @@ -55,6 +55,8 @@ github.com/Shopify/sarama v1.19.0/go.mod h1:FVkBWblsNy7DGZRfXLU0O9RCGt5g3g3yEuWX github.com/Shopify/toxiproxy v2.1.4+incompatible/go.mod h1:OXgGpZ6Cli1/URJOF1DMxUHB2q5Ap20/P/eIdh4G0pI= github.com/VividCortex/gohistogram v1.0.0/go.mod h1:Pf5mBqqDxYaXu3hDrrU+w6nw50o/4+TcAqDqk/vUH7g= github.com/afex/hystrix-go v0.0.0-20180502004556-fa1af6a1f4f5/go.mod h1:SkGFH1ia65gfNATL8TAiHDNxPzPdmEL5uirI2Uyuz6c= +github.com/ahmetb/gen-crd-api-reference-docs v0.3.0 h1:+XfOU14S4bGuwyvCijJwhhBIjYN+YXS18jrCY2EzJaY= +github.com/ahmetb/gen-crd-api-reference-docs v0.3.0/go.mod h1:TdjdkYhlOifCQWPs1UdTma97kQQMozf5h26hTuG70u8= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= @@ -530,7 +532,9 @@ github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40T github.com/rcrowley/go-metrics v0.0.0-20181016184325-3113b8401b8a/go.mod h1:bCqnVzQkZxMG4s8nGwiZ5l3QUCyqpo9Y+/ZMZ9VjZe4= github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo= github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= +github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q= github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= @@ -538,6 +542,7 @@ github.com/ryanuber/go-glob v1.0.0 h1:iQh3xXAumdQ+4Ufa5b25cRpC5TYKlno6hsv6Cb3pkB github.com/ryanuber/go-glob v1.0.0/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc= github.com/samuel/go-zookeeper v0.0.0-20190923202752-2cc03de413da/go.mod h1:gi+0XIa01GRL2eRQVjQkKGqKF3SF9vZR/HnPullcV2E= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= +github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= @@ -999,6 +1004,9 @@ k8s.io/component-base v0.20.2 h1:LMmu5I0pLtwjpp5009KLuMGFqSc2S2isGw8t1hpYKLE= k8s.io/component-base v0.20.2/go.mod h1:pzFtCiwe/ASD0iV7ySMu8SYVJjCapNM9bjvk7ptpKh0= k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0= k8s.io/gengo v0.0.0-20201113003025-83324d819ded/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E= +k8s.io/gengo v0.0.0-20201203183100-97869a43a9d9 h1:1bLA4Agvs1DILmc+q2Bbcqjx6jOHO7YEFA+G+0aTZoc= +k8s.io/gengo v0.0.0-20201203183100-97869a43a9d9/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E= +k8s.io/klog v0.2.0/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk= k8s.io/klog v0.3.0 h1:0VPpR+sizsiivjIfIAQH/rl8tan6jvWkS7lU+0di3lE= k8s.io/klog v0.3.0/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk= k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE=