alloydbinstance_v1alpha1.json

{
  "properties": {
    "apiVersion": {
      "description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "oneOf": [
        {
          "required": [
            "instanceType"
          ]
        },
        {
          "required": [
            "instanceTypeRef"
          ]
        }
      ],
      "properties": {
        "annotations": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels.",
          "type": "object"
        },
        "availabilityType": {
          "description": "'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.\nNote that primary and read instances can have different availability types.\nOnly READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.\nZone is automatically chosen from the list of zones in the region specified.\nRead pool of size 1 can only have zonal availability. Read pools with node count of 2 or more\ncan have regional availability (nodes are present in 2 or more zones in a region).' Possible values: [\"AVAILABILITY_TYPE_UNSPECIFIED\", \"ZONAL\", \"REGIONAL\"].",
          "type": "string"
        },
        "clusterRef": {
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "Allowed value: The `name` field of an `AlloyDBCluster` resource.",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "databaseFlags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.",
          "type": "object"
        },
        "displayName": {
          "description": "User-settable and human-readable display name for the Instance.",
          "type": "string"
        },
        "gceZone": {
          "description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.",
          "type": "string"
        },
        "instanceType": {
          "description": "We recommend that you use `instanceTypeRef` instead.\nThe type of the instance. Possible values: [PRIMARY, READ_POOL, SECONDARY]",
          "type": "string"
        },
        "instanceTypeRef": {
          "description": "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.\nThis is recommended because the instance type of primary and secondary instances is tied to the cluster type of the associated cluster.\nIf the secondary cluster is promoted to primary cluster, then the associated secondary instance also becomes primary instance.\nExample:\ninstanceTypeRef:\n  name: clusterName\nFor instances of type READ_POOL, set the value using external keyword.\nExample:\ninstanceTypeRef:\n  external: READ_POOL\nIf the instance type is SECONDARY, the delete instance operation does not delete the secondary instance but abandons it instead.\nUse deletionPolicy = \"FORCE\" in the associated secondary cluster and delete the cluster forcefully to delete the secondary cluster as well its associated secondary instance.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "Allowed value: The `clusterType` field of an `AlloyDBCluster` resource.",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "machineConfig": {
          "description": "Configurations for the machines that host the underlying database engine.",
          "properties": {
            "cpuCount": {
              "description": "The number of CPU's in the VM instance.",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "networkConfig": {
          "description": "Instance level network configuration.",
          "properties": {
            "authorizedExternalNetworks": {
              "description": "A list of external networks authorized to access this instance. This field is only allowed to be set when 'enable_public_ip' is set to true.",
              "items": {
                "properties": {
                  "cidrRange": {
                    "description": "CIDR range for one authorized network of the instance.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "enableOutboundPublicIp": {
              "description": "Enabling outbound public ip for the instance.",
              "type": "boolean"
            },
            "enablePublicIp": {
              "description": "Enabling public ip for the instance. If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.",
              "type": "boolean"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "readPoolConfig": {
          "description": "Read pool specific config. If the instance type is READ_POOL, this configuration must be provided.",
          "properties": {
            "nodeCount": {
              "description": "Read capacity, i.e. number of nodes in a read pool instance.",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "resourceID": {
          "description": "Immutable. Optional. The instanceId of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.",
          "type": "string"
        }
      },
      "required": [
        "clusterRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observation of the resource's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "createTime": {
          "description": "Time the Instance was created in UTC.",
          "type": "string"
        },
        "ipAddress": {
          "description": "The IP address for the Instance. This is the connection endpoint for an end-user application.",
          "type": "string"
        },
        "name": {
          "description": "The name of the instance resource.",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "type": "integer"
        },
        "outboundPublicIpAddresses": {
          "description": "The outbound public IP addresses for the instance. This is available ONLY when\nnetworkConfig.enableOutboundPublicIp is set to true. These IP addresses are used\nfor outbound connections.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "publicIpAddress": {
          "description": "The public IP addresses for the Instance. This is available ONLY when networkConfig.enablePublicIp is set to true. This is the connection endpoint for an end-user application.",
          "type": "string"
        },
        "reconciling": {
          "description": "Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.",
          "type": "boolean"
        },
        "state": {
          "description": "The current state of the alloydb instance.",
          "type": "string"
        },
        "uid": {
          "description": "The system-generated UID of the resource.",
          "type": "string"
        },
        "updateTime": {
          "description": "Time the Instance was updated in UTC.",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}