Add KCC specific message for instanceTypeRef

199201shubhamsahu · Mar 11, 2024 · fbfb6cc · fbfb6cc
1 parent 3feb83e
commit fbfb6cc
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 1 deletion.
diff --git a/...ns.k8s.io_v1_customresourcedefinition_alloydbinstances.alloydb.cnrm.cloud.google.com.yaml b/...ns.k8s.io_v1_customresourcedefinition_alloydbinstances.alloydb.cnrm.cloud.google.com.yaml
@@ -131,6 +131,12 @@ spec:
                   the instance.
                 type: string
               instanceTypeRef:
+                description: "\"(Required) The type of instance.\nPossible values:
+                  [\"PRIMARY\", \"READ_POOL\", \"SECONDARY\"]\nFor PRIMARY and SECONDARY
+                  instances, set the value to refer to the name of the associated
+                  cluster.\ninstanceTypeRef: \n  name: clusterName\nFor instance of
+                  type READ_POOL, set the value using external keyword.\nExample:\ninstanceTypeRef:\n
+                  \ external: READ_POOL\""
                 oneOf:
                 - not:
                     required:
@@ -357,6 +363,12 @@ spec:
                   the instance.
                 type: string
               instanceTypeRef:
+                description: "\"(Required) The type of instance.\nPossible values:
+                  [\"PRIMARY\", \"READ_POOL\", \"SECONDARY\"]\nFor PRIMARY and SECONDARY
+                  instances, set the value to refer to the name of the associated
+                  cluster.\ninstanceTypeRef: \n  name: clusterName\nFor instance of
+                  type READ_POOL, set the value using external keyword.\nExample:\ninstanceTypeRef:\n
+                  \ external: READ_POOL\""
                 oneOf:
                 - not:
                     required:

diff --git a/config/servicemappings/alloydb.yaml b/config/servicemappings/alloydb.yaml
@@ -176,6 +176,16 @@ spec:
             kind: AlloyDBCluster
           parent: true
         - tfField: instance_type
+          description: |-
+            "(Required) The type of instance.
+            Possible values: ["PRIMARY", "READ_POOL", "SECONDARY"]
+            For PRIMARY and SECONDARY instances, set the value to refer to the name of the associated cluster.
+            instanceTypeRef: 
+              name: clusterName
+            For instance of type READ_POOL, set the value using external keyword.
+            Example:
+            instanceTypeRef:
+              external: READ_POOL"
           key: instanceTypeRef
           targetField: cluster_type
           gvk:

diff --git a/pkg/clients/generated/apis/alloydb/v1beta1/alloydbinstance_types.go b/pkg/clients/generated/apis/alloydb/v1beta1/alloydbinstance_types.go
diff --git a/...gle3-docs/resource-reference/generated/resource-docs/alloydb/alloydbinstance.md b/...gle3-docs/resource-reference/generated/resource-docs/alloydb/alloydbinstance.md
@@ -219,7 +219,15 @@ can have regional availability (nodes are present in 2 or more zones in a region
         </td>
         <td>
             <p><code class="apitype">object</code></p>
-            <p>{% verbatim %}{% endverbatim %}</p>
+            <p>{% verbatim %}"(Required) The type of instance.
+Possible values: ["PRIMARY", "READ_POOL", "SECONDARY"]
+For PRIMARY and SECONDARY instances, set the value to refer to the name of the associated cluster.
+instanceTypeRef: 
+  name: clusterName
+For instance of type READ_POOL, set the value using external keyword.
+Example:
+instanceTypeRef:
+  external: READ_POOL"{% endverbatim %}</p>
         </td>
     </tr>
     <tr>