Update API definition

Author: pcallewaert

api/v1alpha1/postgresuser_types.go

@@ -9,12 +9,16 @@ import (
 
 // PostgresUserSpec defines the desired state of PostgresUser
 type PostgresUserSpec struct {
-	Role       string `json:"role"`
-	Database   string `json:"database"`
+	// Name of the PostgresRole this user will be associated with
+	Role string `json:"role"`
+	// Name of the PostgresDatabase this user will be related to
+	Database string `json:"database"`
+	// Name of the secret to create with user credentials
 	SecretName string `json:"secretName"`
 	// +optional
 	SecretTemplate map[string]string `json:"secretTemplate,omitempty"` // key-value, where key is secret field, value is go template
 	// +optional
+	// List of privileges to grant to this user
 	Privileges string `json:"privileges"`
 	// +optional
 	AWS *PostgresUserAWSSpec `json:"aws,omitempty"`
@@ -27,6 +31,8 @@ type PostgresUserSpec struct {
 // PostgresUserAWSSpec encapsulates AWS specific configuration toggles.
 type PostgresUserAWSSpec struct {
 	// +optional
+	// +kubebuilder:default=false
+	// Enable IAM authentication for this user (PostgreSQL on AWS RDS only)
 	EnableIamAuth bool `json:"enableIamAuth,omitempty"`
 }
 
@@ -37,7 +43,9 @@ type PostgresUserStatus struct {
 	PostgresLogin string `json:"postgresLogin"`
 	PostgresGroup string `json:"postgresGroup"`
 	DatabaseName  string `json:"databaseName"`
-	EnableIamAuth bool   `json:"enableIamAuth"`
+	// Reflects whether IAM authentication is enabled for this user.
+	// +optional
+	EnableIamAuth bool `json:"enableIamAuth"`
 }
 
 // +kubebuilder:object:root=true

config/crd/bases/db.movetokube.com_postgresusers.yaml

@@ -48,19 +48,28 @@ spec:
                   toggles.
                 properties:
                   enableIamAuth:
+                    default: false
+                    description: Enable IAM authentication for this user (PostgreSQL
+                      on AWS RDS only)
                     type: boolean
                 type: object
               database:
+                description: Name of the PostgresDatabase this user will be related
+                  to
                 type: string
               labels:
                 additionalProperties:
                   type: string
                 type: object
               privileges:
+                description: List of privileges to grant to this user
                 type: string
               role:
+                description: Name of the PostgresRole this user will be associated
+                  with
                 type: string
               secretName:
+                description: Name of the secret to create with user credentials
                 type: string
               secretTemplate:
                 additionalProperties:
@@ -77,6 +86,8 @@ spec:
               databaseName:
                 type: string
               enableIamAuth:
+                description: Reflects whether IAM authentication is enabled for this
+                  user.
                 type: boolean
               postgresGroup:
                 type: string
@@ -88,7 +99,6 @@ spec:
                 type: boolean
             required:
             - databaseName
-            - enableIamAuth
             - postgresGroup
             - postgresLogin
             - postgresRole