diff --git a/docs/.crd-ref-docs.yaml b/docs/.crd-ref-docs.yaml index ab04824..fea36bc 100644 --- a/docs/.crd-ref-docs.yaml +++ b/docs/.crd-ref-docs.yaml @@ -2,10 +2,8 @@ processor: # RE2 regular expressions describing types that should be excluded from the generated documentation. ignoreTypes: - "(LKEClusterConfig)List$" - - "(LKEClusterConfig)Status$" # RE2 regular expressions describing type fields that should be excluded from the generated documentation. ignoreFields: - - "status$" - "TypeMeta$" render: diff --git a/docs/deployment/installation.md b/docs/deployment/installation.md new file mode 100644 index 0000000..96025dd --- /dev/null +++ b/docs/deployment/installation.md @@ -0,0 +1 @@ +# Installation Guide diff --git a/docs/deployment/upgrade.md b/docs/deployment/upgrade.md new file mode 100644 index 0000000..dab017f --- /dev/null +++ b/docs/deployment/upgrade.md @@ -0,0 +1 @@ +# Upgrade diff --git a/docs/reference/out.md b/docs/reference/out.md index 16adcc4..3875045 100644 --- a/docs/reference/out.md +++ b/docs/reference/out.md @@ -27,8 +27,9 @@ LKEClusterConfig is the Schema for the lkeclusterconfigs API. | --- | --- | --- | --- | | `apiVersion` _string_ | `lke.anza-labs.dev/v1alpha1` | | | | `kind` _string_ | `LKEClusterConfig` | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/vv1.30/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec` _[LKEClusterConfigSpec](#lkeclusterconfigspec)_ | | | | +| `status` _[LKEClusterConfigStatus](#lkeclusterconfigstatus)_ | | | | #### LKEClusterConfigSpec @@ -51,6 +52,25 @@ _Appears in:_ | `kubernetesVersion` _string_ | KubernetesVersion indicates the Kubernetes version of the LKE cluster. | latest | Optional: {}
| +#### LKEClusterConfigStatus + + + +LKEClusterConfigStatus defines the observed state of an LKEClusterConfig resource. + + + +_Appears in:_ +- [LKEClusterConfig](#lkeclusterconfig) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `phase` _[Phase](#phase)_ | Phase represents the current phase of the LKE cluster. | Unknown | Enum: [Active Deleting Error Provisioning Unknown Updating]
Optional: {}
| +| `clusterID` _integer_ | ClusterID contains the ID of the provisioned LKE cluster. | | Optional: {}
| +| `nodePoolStatuses` _object (keys:string, values:[NodePoolStatus](#nodepoolstatus))_ | NodePoolStatuses contains the Status of the provisioned node pools within the LKE cluster. | | Optional: {}
| +| `failureMessage` _string_ | FailureMessage contains an optional failure message for the LKE cluster. | | Optional: {}
| + + #### LKENodePool @@ -87,7 +107,34 @@ _Appears in:_ | `max` _integer_ | Max specifies the maximum number of nodes in the pool. | | Maximum: 100
Minimum: 3
Required: {}
| +#### NodePoolStatus + + +NodePoolStatus + + + +_Appears in:_ +- [LKEClusterConfigStatus](#lkeclusterconfigstatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `id` _integer_ | ID | | Optional: {}
| +| `details` _[LKENodePool](#lkenodepool)_ | NodePoolDetails | | Required: {}
| + + +#### Phase + +_Underlying type:_ _string_ + + + +_Validation:_ +- Enum: [Active Deleting Error Provisioning Unknown Updating] + +_Appears in:_ +- [LKEClusterConfigStatus](#lkeclusterconfigstatus) diff --git a/docs/user-guide/quickstart.md b/docs/user-guide/quickstart.md new file mode 100644 index 0000000..acb9843 --- /dev/null +++ b/docs/user-guide/quickstart.md @@ -0,0 +1 @@ +# Quickstart