adding conjur description (#4578)

* adding conjur description

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

* adding into Golang Struct models

Your commit message

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

* Add `webhook.create: false` warning comment (#4579)

* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

Revert "Add `webhook.create: false` warning comment (#4579)"

This reverts commit 41f8344042bf8e3cdaa71fdf9819790a53b2c086.

* generating API doc

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

---------

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
Co-authored-by: Aaron Hastings <thecosmicfrog@users.noreply.github.com>
Co-authored-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>

apis/externalsecrets/v1beta1/secretstore_conjur_types.go

@@ -17,28 +17,48 @@ package v1beta1
 import esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
 
 type ConjurProvider struct {
+	// URL is the endpoint of the Conjur instance.
 	URL string `json:"url"`
+
+	// CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.
 	// +optional
 	CABundle string `json:"caBundle,omitempty"`
+
+	// Used to provide custom certificate authority (CA) certificates
+	// for a secret store. The CAProvider points to a Secret or ConfigMap resource
+	// that contains a PEM-encoded certificate.
 	// +optional
 	CAProvider *CAProvider `json:"caProvider,omitempty"`
-	Auth       ConjurAuth  `json:"auth"`
+
+	// Defines authentication settings for connecting to Conjur.
+	Auth ConjurAuth `json:"auth"`
 }
 
 type ConjurAuth struct {
+	// Authenticates with Conjur using an API key.
 	// +optional
 	APIKey *ConjurAPIKey `json:"apikey,omitempty"`
+
+	// Jwt enables JWT authentication using Kubernetes service account tokens.
 	// +optional
 	Jwt *ConjurJWT `json:"jwt,omitempty"`
 }
 
 type ConjurAPIKey struct {
-	Account   string                    `json:"account"`
-	UserRef   *esmeta.SecretKeySelector `json:"userRef"`
+	// Account is the Conjur organization account name.
+	Account string `json:"account"`
+
+	// A reference to a specific 'key' containing the Conjur username
+	// within a Secret resource. In some instances, `key` is a required field.
+	UserRef *esmeta.SecretKeySelector `json:"userRef"`
+
+	// A reference to a specific 'key' containing the Conjur API key
+	// within a Secret resource. In some instances, `key` is a required field.
 	APIKeyRef *esmeta.SecretKeySelector `json:"apiKeyRef"`
 }
 
 type ConjurJWT struct {
+	// Account is the Conjur organization account name.
 	Account string `json:"account"`
 
 	// The conjur authn jwt webservice id

config/crds/bases/external-secrets.io_clustersecretstores.yaml

@@ -3262,15 +3262,20 @@ spec:
                       conjur provider
                     properties:
                       auth:
+                        description: Defines authentication settings for connecting
+                          to Conjur.
                         properties:
                           apikey:
+                            description: Authenticates with Conjur using an API key.
                             properties:
                               account:
+                                description: Account is the Conjur organization account
+                                  name.
                                 type: string
                               apiKeyRef:
                                 description: |-
-                                  A reference to a specific 'key' within a Secret resource.
-                                  In some instances, `key` is a required field.
+                                  A reference to a specific 'key' containing the Conjur API key
+                                  within a Secret resource. In some instances, `key` is a required field.
                                 properties:
                                   key:
                                     description: |-
@@ -3298,8 +3303,8 @@ spec:
                                 type: object
                               userRef:
                                 description: |-
-                                  A reference to a specific 'key' within a Secret resource.
-                                  In some instances, `key` is a required field.
+                                  A reference to a specific 'key' containing the Conjur username
+                                  within a Secret resource. In some instances, `key` is a required field.
                                 properties:
                                   key:
                                     description: |-
@@ -3331,8 +3336,12 @@ spec:
                             - userRef
                             type: object
                           jwt:
+                            description: Jwt enables JWT authentication using Kubernetes
+                              service account tokens.
                             properties:
                               account:
+                                description: Account is the Conjur organization account
+                                  name.
                                 type: string
                               hostId:
                                 description: |-
@@ -3408,6 +3417,8 @@ spec:
                             type: object
                         type: object
                       caBundle:
+                        description: CABundle is a PEM encoded CA bundle that will
+                          be used to validate the Conjur server certificate.
                         type: string
                       caProvider:
                         description: |-
@@ -3449,6 +3460,7 @@ spec:
                         - type
                         type: object
                       url:
+                        description: URL is the endpoint of the Conjur instance.
                         type: string
                     required:
                     - auth

config/crds/bases/external-secrets.io_secretstores.yaml

@@ -3262,15 +3262,20 @@ spec:
                       conjur provider
                     properties:
                       auth:
+                        description: Defines authentication settings for connecting
+                          to Conjur.
                         properties:
                           apikey:
+                            description: Authenticates with Conjur using an API key.
                             properties:
                               account:
+                                description: Account is the Conjur organization account
+                                  name.
                                 type: string
                               apiKeyRef:
                                 description: |-
-                                  A reference to a specific 'key' within a Secret resource.
-                                  In some instances, `key` is a required field.
+                                  A reference to a specific 'key' containing the Conjur API key
+                                  within a Secret resource. In some instances, `key` is a required field.
                                 properties:
                                   key:
                                     description: |-
@@ -3298,8 +3303,8 @@ spec:
                                 type: object
                               userRef:
                                 description: |-
-                                  A reference to a specific 'key' within a Secret resource.
-                                  In some instances, `key` is a required field.
+                                  A reference to a specific 'key' containing the Conjur username
+                                  within a Secret resource. In some instances, `key` is a required field.
                                 properties:
                                   key:
                                     description: |-
@@ -3331,8 +3336,12 @@ spec:
                             - userRef
                             type: object
                           jwt:
+                            description: Jwt enables JWT authentication using Kubernetes
+                              service account tokens.
                             properties:
                               account:
+                                description: Account is the Conjur organization account
+                                  name.
                                 type: string
                               hostId:
                                 description: |-
@@ -3408,6 +3417,8 @@ spec:
                             type: object
                         type: object
                       caBundle:
+                        description: CABundle is a PEM encoded CA bundle that will
+                          be used to validate the Conjur server certificate.
                         type: string
                       caProvider:
                         description: |-
@@ -3449,6 +3460,7 @@ spec:
                         - type
                         type: object
                       url:
+                        description: URL is the endpoint of the Conjur instance.
                         type: string
                     required:
                     - auth

deploy/charts/external-secrets/tests/__snapshot__/crds_test.yaml.snap

@@ -3080,15 +3080,18 @@ should match snapshot of default values:
                           description: Conjur configures this store to sync secrets using conjur provider
                           properties:
                             auth:
+                              description: Defines authentication settings for connecting to Conjur.
                               properties:
                                 apikey:
+                                  description: Authenticates with Conjur using an API key.
                                   properties:
                                     account:
+                                      description: Account is the Conjur organization account name.
                                       type: string
                                     apiKeyRef:
                                       description: |-
-                                        A reference to a specific 'key' within a Secret resource.
-                                        In some instances, `key` is a required field.
+                                        A reference to a specific 'key' containing the Conjur API key
+                                        within a Secret resource. In some instances, `key` is a required field.
                                       properties:
                                         key:
                                           description: |-
@@ -3115,8 +3118,8 @@ should match snapshot of default values:
                                       type: object
                                     userRef:
                                       description: |-
-                                        A reference to a specific 'key' within a Secret resource.
-                                        In some instances, `key` is a required field.
+                                        A reference to a specific 'key' containing the Conjur username
+                                        within a Secret resource. In some instances, `key` is a required field.
                                       properties:
                                         key:
                                           description: |-
@@ -3147,8 +3150,10 @@ should match snapshot of default values:
                                     - userRef
                                   type: object
                                 jwt:
+                                  description: Jwt enables JWT authentication using Kubernetes service account tokens.
                                   properties:
                                     account:
+                                      description: Account is the Conjur organization account name.
                                       type: string
                                     hostId:
                                       description: |-
@@ -3222,6 +3227,7 @@ should match snapshot of default values:
                                   type: object
                               type: object
                             caBundle:
+                              description: CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.
                               type: string
                             caProvider:
                               description: |-
@@ -3260,6 +3266,7 @@ should match snapshot of default values:
                                 - type
                               type: object
                             url:
+                              description: URL is the endpoint of the Conjur instance.
                               type: string
                           required:
                             - auth

deploy/crds/bundle.yaml

@@ -4333,15 +4333,18 @@ spec:
                       description: Conjur configures this store to sync secrets using conjur provider
                       properties:
                         auth:
+                          description: Defines authentication settings for connecting to Conjur.
                           properties:
                             apikey:
+                              description: Authenticates with Conjur using an API key.
                               properties:
                                 account:
+                                  description: Account is the Conjur organization account name.
                                   type: string
                                 apiKeyRef:
                                   description: |-
-                                    A reference to a specific 'key' within a Secret resource.
-                                    In some instances, `key` is a required field.
+                                    A reference to a specific 'key' containing the Conjur API key
+                                    within a Secret resource. In some instances, `key` is a required field.
                                   properties:
                                     key:
                                       description: |-
@@ -4368,8 +4371,8 @@ spec:
                                   type: object
                                 userRef:
                                   description: |-
-                                    A reference to a specific 'key' within a Secret resource.
-                                    In some instances, `key` is a required field.
+                                    A reference to a specific 'key' containing the Conjur username
+                                    within a Secret resource. In some instances, `key` is a required field.
                                   properties:
                                     key:
                                       description: |-
@@ -4400,8 +4403,10 @@ spec:
                                 - userRef
                               type: object
                             jwt:
+                              description: Jwt enables JWT authentication using Kubernetes service account tokens.
                               properties:
                                 account:
+                                  description: Account is the Conjur organization account name.
                                   type: string
                                 hostId:
                                   description: |-
@@ -4475,6 +4480,7 @@ spec:
                               type: object
                           type: object
                         caBundle:
+                          description: CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.
                           type: string
                         caProvider:
                           description: |-
@@ -4513,6 +4519,7 @@ spec:
                             - type
                           type: object
                         url:
+                          description: URL is the endpoint of the Conjur instance.
                           type: string
                       required:
                         - auth
@@ -11657,15 +11664,18 @@ spec:
                       description: Conjur configures this store to sync secrets using conjur provider
                       properties:
                         auth:
+                          description: Defines authentication settings for connecting to Conjur.
                           properties:
                             apikey:
+                              description: Authenticates with Conjur using an API key.
                               properties:
                                 account:
+                                  description: Account is the Conjur organization account name.
                                   type: string
                                 apiKeyRef:
                                   description: |-
-                                    A reference to a specific 'key' within a Secret resource.
-                                    In some instances, `key` is a required field.
+                                    A reference to a specific 'key' containing the Conjur API key
+                                    within a Secret resource. In some instances, `key` is a required field.
                                   properties:
                                     key:
                                       description: |-
@@ -11692,8 +11702,8 @@ spec:
                                   type: object
                                 userRef:
                                   description: |-
-                                    A reference to a specific 'key' within a Secret resource.
-                                    In some instances, `key` is a required field.
+                                    A reference to a specific 'key' containing the Conjur username
+                                    within a Secret resource. In some instances, `key` is a required field.
                                   properties:
                                     key:
                                       description: |-
@@ -11724,8 +11734,10 @@ spec:
                                 - userRef
                               type: object
                             jwt:
+                              description: Jwt enables JWT authentication using Kubernetes service account tokens.
                               properties:
                                 account:
+                                  description: Account is the Conjur organization account name.
                                   type: string
                                 hostId:
                                   description: |-
@@ -11799,6 +11811,7 @@ spec:
                               type: object
                           type: object
                         caBundle:
+                          description: CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.
                           type: string
                         caProvider:
                           description: |-
@@ -11837,6 +11850,7 @@ spec:
                             - type
                           type: object
                         url:
+                          description: URL is the endpoint of the Conjur instance.
                           type: string
                       required:
                         - auth

docs/api/spec.md

@@ -2468,6 +2468,7 @@ string
 </em>
 </td>
 <td>
+<p>Account is the Conjur organization account name.</p>
 </td>
 </tr>
 <tr>
@@ -2480,6 +2481,8 @@ External Secrets meta/v1.SecretKeySelector
 </em>
 </td>
 <td>
+<p>A reference to a specific &lsquo;key&rsquo; containing the Conjur username
+within a Secret resource. In some instances, <code>key</code> is a required field.</p>
 </td>
 </tr>
 <tr>
@@ -2492,6 +2495,8 @@ External Secrets meta/v1.SecretKeySelector
 </em>
 </td>
 <td>
+<p>A reference to a specific &lsquo;key&rsquo; containing the Conjur API key
+within a Secret resource. In some instances, <code>key</code> is a required field.</p>
 </td>
 </tr>
 </tbody>
@@ -2523,6 +2528,7 @@ ConjurAPIKey
 </td>
 <td>
 <em>(Optional)</em>
+<p>Authenticates with Conjur using an API key.</p>
 </td>
 </tr>
 <tr>
@@ -2536,6 +2542,7 @@ ConjurJWT
 </td>
 <td>
 <em>(Optional)</em>
+<p>Jwt enables JWT authentication using Kubernetes service account tokens.</p>
 </td>
 </tr>
 </tbody>
@@ -2564,6 +2571,7 @@ string
 </em>
 </td>
 <td>
+<p>Account is the Conjur organization account name.</p>
 </td>
 </tr>
 <tr>
@@ -2646,6 +2654,7 @@ string
 </em>
 </td>
 <td>
+<p>URL is the endpoint of the Conjur instance.</p>
 </td>
 </tr>
 <tr>
@@ -2657,6 +2666,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
+<p>CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.</p>
 </td>
 </tr>
 <tr>
@@ -2670,6 +2680,9 @@ CAProvider
 </td>
 <td>
 <em>(Optional)</em>
+<p>Used to provide custom certificate authority (CA) certificates
+for a secret store. The CAProvider points to a Secret or ConfigMap resource
+that contains a PEM-encoded certificate.</p>
 </td>
 </tr>
 <tr>
@@ -2682,6 +2695,7 @@ ConjurAuth
 </em>
 </td>
 <td>
+<p>Defines authentication settings for connecting to Conjur.</p>
 </td>
 </tr>
 </tbody>