rediscluster_v1alpha1.json

{
  "description": "RedisCluster is the Schema for the RedisCluster API",
  "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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "RedisClusterSpec defines the desired state of RedisCluster",
      "properties": {
        "authorizationMode": {
          "description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.",
          "type": "string"
        },
        "deletionProtectionEnabled": {
          "description": "Optional. The delete operation will fail when the value is set to true.",
          "type": "boolean"
        },
        "location": {
          "description": "Immutable. Location of the resource.",
          "type": "string"
        },
        "nodeType": {
          "description": "Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.",
          "type": "string"
        },
        "persistenceConfig": {
          "description": "Optional. Persistence config (RDB, AOF) for the cluster.",
          "properties": {
            "aofConfig": {
              "description": "Optional. AOF configuration. This field will be ignored if mode is not AOF.",
              "properties": {
                "appendFsync": {
                  "description": "Optional. fsync configuration.",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "mode": {
              "description": "Optional. The mode of persistence.",
              "type": "string"
            },
            "rdbConfig": {
              "description": "Optional. RDB configuration. This field will be ignored if mode is not RDB.",
              "properties": {
                "rdbSnapshotPeriod": {
                  "description": "Optional. Period between RDB snapshots.",
                  "type": "string"
                },
                "rdbSnapshotStartTime": {
                  "description": "Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "projectRef": {
          "description": "Immutable. The Project that this resource belongs to.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "The `projectID` field of a project, when not managed by Config Connector.",
              "type": "string"
            },
            "kind": {
              "description": "The kind of the Project resource; optional but must be `Project` if provided.",
              "type": "string"
            },
            "name": {
              "description": "The `name` field of a `Project` resource.",
              "type": "string"
            },
            "namespace": {
              "description": "The `namespace` field of a `Project` resource.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "pscConfigs": {
          "description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.",
          "items": {
            "properties": {
              "networkRef": {
                "description": "Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}.",
                "oneOf": [
                  {
                    "not": {
                      "required": [
                        "external"
                      ]
                    },
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "not": {
                      "anyOf": [
                        {
                          "required": [
                            "name"
                          ]
                        },
                        {
                          "required": [
                            "namespace"
                          ]
                        }
                      ]
                    },
                    "required": [
                      "external"
                    ]
                  }
                ],
                "properties": {
                  "external": {
                    "description": "A reference to an externally managed Compute Network resource. Should be in the format `projects/<projectID>/global/networks/<network>`.",
                    "type": "string"
                  },
                  "name": {
                    "description": "The `name` field of a `ComputeNetwork` resource.",
                    "type": "string"
                  },
                  "namespace": {
                    "description": "The `namespace` field of a `ComputeNetwork` resource.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "required": [
              "networkRef"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "redisConfigs": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Optional. Key/Value pairs of customer overrides for mutable Redis Configs",
          "type": "object"
        },
        "replicaCount": {
          "description": "Optional. The number of replica nodes per shard.",
          "format": "int32",
          "type": "integer"
        },
        "resourceID": {
          "description": "The RedisCluster name. If not given, the metadata.name will be used.",
          "type": "string"
        },
        "shardCount": {
          "description": "Required. Number of shards for the Redis cluster.",
          "format": "int32",
          "type": "integer"
        },
        "transitEncryptionMode": {
          "description": "Optional. The in-transit encryption for the Redis cluster. If not provided, encryption  is disabled for the cluster.",
          "type": "string"
        },
        "zoneDistributionConfig": {
          "description": "Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.",
          "properties": {
            "mode": {
              "description": "Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.",
              "type": "string"
            },
            "zone": {
              "description": "Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "location",
        "projectRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "RedisClusterStatus defines the config connector machine state of RedisCluster",
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observations of the object'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"
        },
        "externalRef": {
          "description": "A unique specifier for the RedisCluster resource in GCP.",
          "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.",
          "format": "int64",
          "type": "integer"
        },
        "observedState": {
          "description": "ObservedState is the state of the resource as most recently observed in GCP.",
          "properties": {
            "createTime": {
              "description": "Output only. The timestamp associated with the cluster creation request.",
              "type": "string"
            },
            "discoveryEndpoints": {
              "description": "Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.",
              "items": {
                "properties": {
                  "address": {
                    "description": "Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname.",
                    "type": "string"
                  },
                  "port": {
                    "description": "Output only. The port number of the exposed Redis endpoint.",
                    "format": "int32",
                    "type": "integer"
                  },
                  "pscConfig": {
                    "description": "Output only. Customer configuration for where the endpoint is created and accessed from.",
                    "properties": {
                      "network": {
                        "description": "Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}.",
                        "type": "string"
                      }
                    },
                    "type": "object",
                    "additionalProperties": false
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "preciseSizeGb": {
              "description": "Output only. Precise value of redis memory size in GB for the entire cluster.",
              "type": "number"
            },
            "pscConnections": {
              "description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.",
              "items": {
                "properties": {
                  "address": {
                    "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.",
                    "type": "string"
                  },
                  "forwardingRule": {
                    "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.",
                    "type": "string"
                  },
                  "network": {
                    "description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.",
                    "type": "string"
                  },
                  "projectID": {
                    "description": "Output only. The consumer project_id where the forwarding rule is created from.",
                    "type": "string"
                  },
                  "pscConnectionID": {
                    "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "sizeGb": {
              "description": "Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.",
              "format": "int32",
              "type": "integer"
            },
            "state": {
              "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED",
              "type": "string"
            },
            "stateInfo": {
              "description": "Output only. Additional information about the current state of the cluster.",
              "properties": {
                "updateInfo": {
                  "description": "Describes ongoing update on the cluster when cluster state is UPDATING.",
                  "properties": {
                    "targetReplicaCount": {
                      "description": "Target number of replica nodes per shard.",
                      "format": "int32",
                      "type": "integer"
                    },
                    "targetShardCount": {
                      "description": "Target number of shards for redis cluster",
                      "format": "int32",
                      "type": "integer"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "uid": {
              "description": "Output only. System assigned, unique identifier for the cluster.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}