CrunchyBridgeCluster

CrunchyBridgeCluster is the Schema for the crunchybridgeclusters API

name	type	required	description
apiVersion	`string`	✅	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
kind	`string`	✅	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
metadata	`object`	✅	Kubernetes resource namespace, name, labels, and annotations
spec	`object`	❌	CrunchyBridgeClusterSpec defines the desired state of CrunchyBridgeCluster to be managed by Crunchy Data Bridge
status	`object`	❌	CrunchyBridgeClusterStatus defines the observed state of CrunchyBridgeCluster

↩ ParentCrunchyBridgeCluster.spec

CrunchyBridgeClusterSpec defines the desired state of CrunchyBridgeCluster to be managed by Crunchy Data Bridge

name	type	required	description
clusterName	`string`	✅	The name of the cluster --- According to Bridge API/GUI errors, "Field name should be between 5 and 50 characters in length, containing only unicode characters, unicode numbers, hyphens, spaces, or underscores, and starting with a character", and ending with a character or number.
isHa	`boolean`	✅	Whether the cluster is high availability, meaning that it has a secondary it can fail over to quickly in case the primary becomes unavailable.
isProtected	`boolean`	❌	Whether the cluster is protected. Protected clusters can't be destroyed until their protected flag is removed
majorVersion	`integer`	✅	The ID of the cluster's major Postgres version. Currently Bridge offers 13-17
metadata	`object`	❌	Metadata contains metadata for custom resources
plan	`string`	✅	The ID of the cluster's plan. Determines instance, CPU, and memory.
provider	`aws`, `azure`, `gcp`	✅	The cloud provider where the cluster is located. Currently Bridge offers aws, azure, and gcp only
region	`string`	✅	The provider region where the cluster is located.
roles	`[]object`	❌	Roles for which to create Secrets that contain their credentials which are retrieved from the Bridge API. An empty list creates no role secrets. Removing a role from this list does NOT drop the role nor revoke their access, but it will delete that role's secret from the kube cluster.
secret	`string`	✅	The name of the secret containing the API key and team id
storage	`int or string`	✅	The amount of storage available to the cluster in gigabytes. The amount must be an integer, followed by Gi (gibibytes) or G (gigabytes) to match Kubernetes conventions. If the amount is given in Gi, we round to the nearest G value. The minimum value allowed by Bridge is 10 GB. The maximum value allowed by Bridge is 65535 GB.

↩ ParentCrunchyBridgeCluster.spec.metadata

Metadata contains metadata for custom resources

name	type	required	description
annotations	`map[string]: string`	❌	undefined
labels	`map[string]: string`	❌	undefined

↩ ParentCrunchyBridgeCluster.spec.roles[index]

Roles for which to create Secrets that contain their credentials which are retrieved from the Bridge API. An empty list creates no role secrets. Removing a role from this list does NOT drop the role nor revoke their access, but it will delete that role's secret from the kube cluster.

name	type	required	description
name	`string`	✅	Name of the role within Crunchy Bridge. More info: https://docs.crunchybridge.com/concepts/users
secretName	`string`	✅	The name of the Secret that will hold the role credentials.

↩ ParentCrunchyBridgeCluster.status

CrunchyBridgeClusterStatus defines the observed state of CrunchyBridgeCluster

name	type	required	description
conditions	`[]object`	❌	conditions represent the observations of postgres cluster's current state.
host	`string`	❌	The Hostname of the postgres cluster in Bridge, provided by Bridge API and null until then.
id	`string`	❌	The ID of the postgres cluster in Bridge, provided by Bridge API and null until then.
isHa	`boolean`	❌	Whether the cluster is high availability, meaning that it has a secondary it can fail over to quickly in case the primary becomes unavailable.
isProtected	`boolean`	❌	Whether the cluster is protected. Protected clusters can't be destroyed until their protected flag is removed
majorVersion	`integer`	❌	The cluster's major Postgres version.
name	`string`	❌	The name of the cluster in Bridge.
observedGeneration	`integer`	❌	observedGeneration represents the .metadata.generation on which the status was based.
ongoingUpgrade	`[]object`	❌	The cluster upgrade as represented by Bridge
plan	`string`	❌	The ID of the cluster's plan. Determines instance, CPU, and memory.
responses	`object`	❌	Most recent, raw responses from Bridge API
state	`string`	❌	State of cluster in Bridge.
storage	`int or string`	❌	The amount of storage available to the cluster.

↩ ParentCrunchyBridgeCluster.status.conditions[index]

conditions represent the observations of postgres cluster's current state.

name	type	required	description
lastTransitionTime	`string`	✅	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	`string`	✅	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	`integer`	❌	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	`string`	✅	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	`True`, `False`, `Unknown`	✅	status of the condition, one of True, False, Unknown.
type	`string`	✅	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

↩ ParentCrunchyBridgeCluster.status.ongoingUpgrade[index]

The cluster upgrade as represented by Bridge

name	type	required	description
flavor	`string`	✅	undefined
starting_from	`string`	✅	undefined
state	`string`	✅	undefined