|
| 1 | +# Nstance <https://nstance.dev> |
| 2 | +# Copyright The Nstance Authors |
| 3 | +# SPDX-License-Identifier: Apache-2.0 |
| 4 | + |
| 5 | +--- |
| 6 | +apiVersion: apiextensions.k8s.io/v1 |
| 7 | +kind: CustomResourceDefinition |
| 8 | +metadata: |
| 9 | + annotations: |
| 10 | + controller-gen.kubebuilder.io/version: v0.19.0 |
| 11 | + helm.sh/resource-policy: keep |
| 12 | + labels: |
| 13 | + cluster.x-k8s.io/v1beta1: v1beta1 |
| 14 | + cluster.x-k8s.io/v1beta2: v1beta1 |
| 15 | + name: nstancemachinepools.infrastructure.cluster.x-k8s.io |
| 16 | +spec: |
| 17 | + group: infrastructure.cluster.x-k8s.io |
| 18 | + names: |
| 19 | + categories: |
| 20 | + - cluster-api |
| 21 | + kind: NstanceMachinePool |
| 22 | + listKind: NstanceMachinePoolList |
| 23 | + plural: nstancemachinepools |
| 24 | + singular: nstancemachinepool |
| 25 | + scope: Namespaced |
| 26 | + versions: |
| 27 | + - additionalPrinterColumns: |
| 28 | + - description: Nstance Group |
| 29 | + jsonPath: .spec.group |
| 30 | + name: Group |
| 31 | + type: string |
| 32 | + - description: Backed by static config |
| 33 | + jsonPath: .status.isStatic |
| 34 | + name: Static |
| 35 | + type: boolean |
| 36 | + - description: Machine pool is ready |
| 37 | + jsonPath: .status.ready |
| 38 | + name: Ready |
| 39 | + type: boolean |
| 40 | + name: v1beta1 |
| 41 | + schema: |
| 42 | + openAPIV3Schema: |
| 43 | + description: NstanceMachinePool is the Schema for the nstancemachinepools |
| 44 | + API |
| 45 | + properties: |
| 46 | + apiVersion: |
| 47 | + description: |- |
| 48 | + APIVersion defines the versioned schema of this representation of an object. |
| 49 | + Servers should convert recognized schemas to the latest internal value, and |
| 50 | + may reject unrecognized values. |
| 51 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 52 | + type: string |
| 53 | + kind: |
| 54 | + description: |- |
| 55 | + Kind is a string value representing the REST resource this object represents. |
| 56 | + Servers may infer this from the endpoint the client submits requests to. |
| 57 | + Cannot be updated. |
| 58 | + In CamelCase. |
| 59 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 60 | + type: string |
| 61 | + metadata: |
| 62 | + type: object |
| 63 | + spec: |
| 64 | + description: NstanceMachinePoolSpec defines the desired state of NstanceMachinePool |
| 65 | + properties: |
| 66 | + group: |
| 67 | + description: |- |
| 68 | + Group is the Nstance Group key. This can match a static group in |
| 69 | + server config, or be a new key for a dynamic group. |
| 70 | + minLength: 1 |
| 71 | + type: string |
| 72 | + instanceType: |
| 73 | + description: InstanceType is an optional override (must be allowed |
| 74 | + by the Group) |
| 75 | + type: string |
| 76 | + providerIDList: |
| 77 | + description: |- |
| 78 | + ProviderIDList is the list of provider IDs of running instances across all shards. |
| 79 | + Required by the CAPI InfraMachinePool contract (spec.providerIDList). |
| 80 | + items: |
| 81 | + type: string |
| 82 | + type: array |
| 83 | + x-kubernetes-list-type: atomic |
| 84 | + shards: |
| 85 | + description: |- |
| 86 | + Shards is the list of zone shards this group should be distributed across. |
| 87 | + Each shard will have a corresponding NstanceShardGroup created. |
| 88 | + Replicas from the MachinePool are distributed across these shards. |
| 89 | + items: |
| 90 | + type: string |
| 91 | + minItems: 1 |
| 92 | + type: array |
| 93 | + subnetPool: |
| 94 | + description: |- |
| 95 | + SubnetPool specifies which subnet pool to use for new dynamic groups. |
| 96 | + This is a subnet pool ID that references server.subnet_pools map key. |
| 97 | + If not specified, uses the template's default. |
| 98 | + Must not be set for groups backed by static config (server will reject). |
| 99 | + type: string |
| 100 | + template: |
| 101 | + description: |- |
| 102 | + Template is the name of the Nstance template defined in server config. |
| 103 | + Required when creating a new dynamic group (no static group with this key). |
| 104 | + Must not be set for groups backed by static config (server will reject). |
| 105 | + type: string |
| 106 | + vars: |
| 107 | + additionalProperties: |
| 108 | + type: string |
| 109 | + description: Vars are additional vars merged with Group vars (enables |
| 110 | + node labels, etc.) |
| 111 | + type: object |
| 112 | + required: |
| 113 | + - group |
| 114 | + - shards |
| 115 | + type: object |
| 116 | + status: |
| 117 | + description: NstanceMachinePoolStatus defines the observed state of NstanceMachinePool |
| 118 | + properties: |
| 119 | + conditions: |
| 120 | + description: Conditions represent the current state of the NstanceMachinePool |
| 121 | + items: |
| 122 | + description: Condition contains details for one aspect of the current |
| 123 | + state of this API Resource. |
| 124 | + properties: |
| 125 | + lastTransitionTime: |
| 126 | + description: |- |
| 127 | + lastTransitionTime is the last time the condition transitioned from one status to another. |
| 128 | + This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
| 129 | + format: date-time |
| 130 | + type: string |
| 131 | + message: |
| 132 | + description: |- |
| 133 | + message is a human readable message indicating details about the transition. |
| 134 | + This may be an empty string. |
| 135 | + maxLength: 32768 |
| 136 | + type: string |
| 137 | + observedGeneration: |
| 138 | + description: |- |
| 139 | + observedGeneration represents the .metadata.generation that the condition was set based upon. |
| 140 | + For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date |
| 141 | + with respect to the current state of the instance. |
| 142 | + format: int64 |
| 143 | + minimum: 0 |
| 144 | + type: integer |
| 145 | + reason: |
| 146 | + description: |- |
| 147 | + reason contains a programmatic identifier indicating the reason for the condition's last transition. |
| 148 | + Producers of specific condition types may define expected values and meanings for this field, |
| 149 | + and whether the values are considered a guaranteed API. |
| 150 | + The value should be a CamelCase string. |
| 151 | + This field may not be empty. |
| 152 | + maxLength: 1024 |
| 153 | + minLength: 1 |
| 154 | + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
| 155 | + type: string |
| 156 | + status: |
| 157 | + description: status of the condition, one of True, False, Unknown. |
| 158 | + enum: |
| 159 | + - "True" |
| 160 | + - "False" |
| 161 | + - Unknown |
| 162 | + type: string |
| 163 | + type: |
| 164 | + description: type of condition in CamelCase or in foo.example.com/CamelCase. |
| 165 | + maxLength: 316 |
| 166 | + pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ |
| 167 | + type: string |
| 168 | + required: |
| 169 | + - lastTransitionTime |
| 170 | + - message |
| 171 | + - reason |
| 172 | + - status |
| 173 | + - type |
| 174 | + type: object |
| 175 | + type: array |
| 176 | + x-kubernetes-list-map-keys: |
| 177 | + - type |
| 178 | + x-kubernetes-list-type: map |
| 179 | + isStatic: |
| 180 | + description: |- |
| 181 | + IsStatic indicates this group is backed by static server config. |
| 182 | + When true, spec.template and spec.subnetPool cannot be modified. |
| 183 | + type: boolean |
| 184 | + observedGeneration: |
| 185 | + description: ObservedGeneration is the generation of the spec that |
| 186 | + was last observed |
| 187 | + format: int64 |
| 188 | + type: integer |
| 189 | + observedOwnerGeneration: |
| 190 | + description: ObservedOwnerGeneration is the generation of the owner |
| 191 | + MachinePool that was last observed |
| 192 | + format: int64 |
| 193 | + type: integer |
| 194 | + ready: |
| 195 | + description: Ready indicates whether the machine pool is ready |
| 196 | + type: boolean |
| 197 | + replicas: |
| 198 | + description: |- |
| 199 | + Replicas is the most recently observed number of running instances across all shards. |
| 200 | + Required by the CAPI InfraMachinePool contract (status.replicas). |
| 201 | + format: int32 |
| 202 | + type: integer |
| 203 | + type: object |
| 204 | + required: |
| 205 | + - spec |
| 206 | + type: object |
| 207 | + served: true |
| 208 | + storage: true |
| 209 | + subresources: |
| 210 | + status: {} |
0 commit comments