8.1 KiB
database.rook.crossplane.io/v1alpha1 API Reference
Package v1alpha1 contains database service resources for Rook
This API group contains the following Crossplane resources:
CockroachCluster
A CockroachCluster configures a Rook 'clusters.cockroachdb.rook.io'
| Name | Type | Description |
|---|---|---|
apiVersion |
string | database.rook.crossplane.io/v1alpha1 |
kind |
string | CockroachCluster |
metadata |
meta/v1.ObjectMeta | Kubernetes object metadata. |
spec |
CockroachClusterSpec | A CockroachClusterSpec defines the desired state of a CockroachCluster. |
status |
CockroachClusterStatus | A CockroachClusterStatus defines the current state of a CockroachCluster. |
CockroachClusterClass
A CockroachClusterClass is a resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
| Name | Type | Description |
|---|---|---|
apiVersion |
string | database.rook.crossplane.io/v1alpha1 |
kind |
string | CockroachClusterClass |
metadata |
meta/v1.ObjectMeta | Kubernetes object metadata. |
specTemplate |
CockroachClusterClassSpecTemplate | SpecTemplate is a template for the spec of a dynamically provisioned CockroachCluster. |
YugabyteCluster
A YugabyteCluster configures a Rook 'ybclusters.yugabytedb.rook.io'
| Name | Type | Description |
|---|---|---|
apiVersion |
string | database.rook.crossplane.io/v1alpha1 |
kind |
string | YugabyteCluster |
metadata |
meta/v1.ObjectMeta | Kubernetes object metadata. |
spec |
YugabyteClusterSpec | A YugabyteClusterSpec defines the desired state of a YugabyteCluster. |
status |
YugabyteClusterStatus | A YugabyteClusterStatus defines the current state of a YugabyteCluster. |
YugabyteClusterClass
A YugabyteClusterClass is a resource class. It defines the desired spec of resource claims that use it to dynamically provision a managed resource.
| Name | Type | Description |
|---|---|---|
apiVersion |
string | database.rook.crossplane.io/v1alpha1 |
kind |
string | YugabyteClusterClass |
metadata |
meta/v1.ObjectMeta | Kubernetes object metadata. |
specTemplate |
YugabyteClusterClassSpecTemplate | SpecTemplate is a template for the spec of a dynamically provisioned YugabyteCluster. |
CockroachClusterClassSpecTemplate
A CockroachClusterClassSpecTemplate is a template for the spec of a dynamically provisioned CockroachCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
forProvider |
CockroachClusterParameters | A CockroachClusterParameters defines the desired state of a CockroachCluster. |
CockroachClusterClassSpecTemplate supports all fields of:
CockroachClusterParameters
A CockroachClusterParameters defines the desired state of a CockroachCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
name |
string | |
namespace |
string | |
annotations |
v1alpha1.Annotations | The annotations-related configuration to add/set on each Pod related object. |
scope |
v1alpha1.StorageScopeSpec | |
network |
NetworkSpec | NetworkSpec describes network related settings of the cluster |
secure |
bool | |
cachePercent |
int | |
maxSQLMemoryPercent |
int |
CockroachClusterSpec
A CockroachClusterSpec defines the desired state of a CockroachCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
forProvider |
CockroachClusterParameters | A CockroachClusterParameters defines the desired state of a CockroachCluster. |
CockroachClusterSpec supports all fields of:
CockroachClusterStatus
A CockroachClusterStatus defines the current state of a CockroachCluster.
Appears in:
CockroachClusterStatus supports all fields of:
NetworkSpec
NetworkSpec describes network related settings of the cluster
Appears in:
| Name | Type | Description |
|---|---|---|
ports |
[]PortSpec | Set of named ports that can be configured for this resource |
PortSpec
PortSpec is named port
Appears in:
| Name | Type | Description |
|---|---|---|
name |
string | Name of port |
port |
int32 | Port number |
ServerSpec
ServerSpec describes server related settings of the cluster
Appears in:
| Name | Type | Description |
|---|---|---|
replicas |
int32 | |
network |
NetworkSpec | NetworkSpec describes network related settings of the cluster |
volumeClaimTemplate |
core/v1.PersistentVolumeClaim |
YugabyteClusterClassSpecTemplate
A YugabyteClusterClassSpecTemplate is a template for the spec of a dynamically provisioned YugabyteCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
forProvider |
YugabyteClusterParameters | A YugabyteClusterParameters defines the desired state of a YugabyteCluster. |
YugabyteClusterClassSpecTemplate supports all fields of:
YugabyteClusterParameters
A YugabyteClusterParameters defines the desired state of a YugabyteCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
name |
string | |
namespace |
string | |
annotations |
v1alpha1.Annotations | |
master |
ServerSpec | ServerSpec describes server related settings of the cluster |
tserver |
ServerSpec | ServerSpec describes server related settings of the cluster |
YugabyteClusterSpec
A YugabyteClusterSpec defines the desired state of a YugabyteCluster.
Appears in:
| Name | Type | Description |
|---|---|---|
forProvider |
YugabyteClusterParameters | A YugabyteClusterParameters defines the desired state of a YugabyteCluster. |
YugabyteClusterSpec supports all fields of:
YugabyteClusterStatus
A YugabyteClusterStatus defines the current state of a YugabyteCluster.
Appears in:
YugabyteClusterStatus supports all fields of:
This API documentation was generated by crossdocs.