|
| 1 | +{ |
| 2 | + "description": "DevCluster is the schema for the dev cluster infrastructure API.", |
| 3 | + "properties": { |
| 4 | + "apiVersion": { |
| 5 | + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", |
| 6 | + "type": "string" |
| 7 | + }, |
| 8 | + "kind": { |
| 9 | + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", |
| 10 | + "type": "string" |
| 11 | + }, |
| 12 | + "metadata": { |
| 13 | + "type": "object" |
| 14 | + }, |
| 15 | + "spec": { |
| 16 | + "description": "DevClusterSpec defines the desired state of the DevCluster infrastructure.", |
| 17 | + "properties": { |
| 18 | + "backend": { |
| 19 | + "description": "backend defines backends for a DevCluster.", |
| 20 | + "properties": { |
| 21 | + "docker": { |
| 22 | + "description": "docker defines a backend for a DevCluster using docker containers.", |
| 23 | + "properties": { |
| 24 | + "failureDomains": { |
| 25 | + "additionalProperties": { |
| 26 | + "description": "FailureDomainSpec is the Schema for Cluster API failure domains.\nIt allows controllers to understand how many failure domains a cluster can optionally span across.", |
| 27 | + "properties": { |
| 28 | + "attributes": { |
| 29 | + "additionalProperties": { |
| 30 | + "type": "string" |
| 31 | + }, |
| 32 | + "description": "attributes is a free form map of attributes an infrastructure provider might use or require.", |
| 33 | + "type": "object" |
| 34 | + }, |
| 35 | + "controlPlane": { |
| 36 | + "description": "controlPlane determines if this failure domain is suitable for use by control plane machines.", |
| 37 | + "type": "boolean" |
| 38 | + } |
| 39 | + }, |
| 40 | + "type": "object", |
| 41 | + "additionalProperties": false |
| 42 | + }, |
| 43 | + "description": "failureDomains are usually not defined in the spec.\nThe docker provider is special since failure domains don't mean anything in a local docker environment.\nInstead, the docker cluster controller will simply copy these into the Status and allow the Cluster API\ncontrollers to do what they will with the defined failure domains.", |
| 44 | + "type": "object" |
| 45 | + }, |
| 46 | + "loadBalancer": { |
| 47 | + "description": "loadBalancer allows defining configurations for the cluster load balancer.", |
| 48 | + "properties": { |
| 49 | + "customHAProxyConfigTemplateRef": { |
| 50 | + "description": "CustomHAProxyConfigTemplateRef allows you to replace the default HAProxy config file.\nThis field is a reference to a config map that contains the configuration template. The key of the config map should be equal to 'value'.\nThe content of the config map will be processed and will replace the default HAProxy config file. Please use it with caution, as there are\nno checks to ensure the validity of the configuration. This template will support the following variables that will be passed by the controller:\n$IPv6 (bool) indicates if the cluster is IPv6, $FrontendControlPlanePort (string) indicates the frontend control plane port,\n$BackendControlPlanePort (string) indicates the backend control plane port, $BackendServers (map[string]string) indicates the backend server\nwhere the key is the server name and the value is the address. This map is dynamic and is updated every time a new control plane\nnode is added or removed. The template will also support the JoinHostPort function to join the host and port of the backend server.", |
| 51 | + "properties": { |
| 52 | + "name": { |
| 53 | + "default": "", |
| 54 | + "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", |
| 55 | + "type": "string" |
| 56 | + } |
| 57 | + }, |
| 58 | + "type": "object", |
| 59 | + "x-kubernetes-map-type": "atomic", |
| 60 | + "additionalProperties": false |
| 61 | + }, |
| 62 | + "imageRepository": { |
| 63 | + "description": "ImageRepository sets the container registry to pull the haproxy image from.\nif not set, \"kindest\" will be used instead.", |
| 64 | + "type": "string" |
| 65 | + }, |
| 66 | + "imageTag": { |
| 67 | + "description": "ImageTag allows to specify a tag for the haproxy image.\nif not set, \"v20210715-a6da3463\" will be used instead.", |
| 68 | + "type": "string" |
| 69 | + } |
| 70 | + }, |
| 71 | + "type": "object", |
| 72 | + "additionalProperties": false |
| 73 | + } |
| 74 | + }, |
| 75 | + "type": "object", |
| 76 | + "additionalProperties": false |
| 77 | + }, |
| 78 | + "inMemory": { |
| 79 | + "description": "inMemory defines a backend for a DevCluster that runs in memory.", |
| 80 | + "type": "object" |
| 81 | + } |
| 82 | + }, |
| 83 | + "type": "object", |
| 84 | + "additionalProperties": false |
| 85 | + }, |
| 86 | + "controlPlaneEndpoint": { |
| 87 | + "description": "controlPlaneEndpoint represents the endpoint used to communicate with the control plane.", |
| 88 | + "properties": { |
| 89 | + "host": { |
| 90 | + "description": "Host is the hostname on which the API server is serving.", |
| 91 | + "type": "string" |
| 92 | + }, |
| 93 | + "port": { |
| 94 | + "description": "Port is the port on which the API server is serving.\nDefaults to 6443 if not set.", |
| 95 | + "type": "integer" |
| 96 | + } |
| 97 | + }, |
| 98 | + "required": [ |
| 99 | + "host", |
| 100 | + "port" |
| 101 | + ], |
| 102 | + "type": "object", |
| 103 | + "additionalProperties": false |
| 104 | + } |
| 105 | + }, |
| 106 | + "required": [ |
| 107 | + "backend" |
| 108 | + ], |
| 109 | + "type": "object", |
| 110 | + "additionalProperties": false |
| 111 | + }, |
| 112 | + "status": { |
| 113 | + "description": "DevClusterStatus defines the observed state of the DevCluster.", |
| 114 | + "properties": { |
| 115 | + "conditions": { |
| 116 | + "description": "conditions defines current service state of the DevCluster.", |
| 117 | + "items": { |
| 118 | + "description": "Condition defines an observation of a Cluster API resource operational state.", |
| 119 | + "properties": { |
| 120 | + "lastTransitionTime": { |
| 121 | + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when\nthe API field changed is acceptable.", |
| 122 | + "format": "date-time", |
| 123 | + "type": "string" |
| 124 | + }, |
| 125 | + "message": { |
| 126 | + "description": "message is a human readable message indicating details about the transition.\nThis field may be empty.", |
| 127 | + "maxLength": 10240, |
| 128 | + "minLength": 1, |
| 129 | + "type": "string" |
| 130 | + }, |
| 131 | + "reason": { |
| 132 | + "description": "reason is the reason for the condition's last transition in CamelCase.\nThe specific API may choose whether or not this field is considered a guaranteed API.\nThis field may be empty.", |
| 133 | + "maxLength": 256, |
| 134 | + "minLength": 1, |
| 135 | + "type": "string" |
| 136 | + }, |
| 137 | + "severity": { |
| 138 | + "description": "severity provides an explicit classification of Reason code, so the users or machines can immediately\nunderstand the current situation and act accordingly.\nThe Severity field MUST be set only when Status=False.", |
| 139 | + "maxLength": 32, |
| 140 | + "type": "string" |
| 141 | + }, |
| 142 | + "status": { |
| 143 | + "description": "status of the condition, one of True, False, Unknown.", |
| 144 | + "type": "string" |
| 145 | + }, |
| 146 | + "type": { |
| 147 | + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions\ncan be useful (see .node.status.conditions), the ability to deconflict is important.", |
| 148 | + "maxLength": 256, |
| 149 | + "minLength": 1, |
| 150 | + "type": "string" |
| 151 | + } |
| 152 | + }, |
| 153 | + "required": [ |
| 154 | + "lastTransitionTime", |
| 155 | + "status", |
| 156 | + "type" |
| 157 | + ], |
| 158 | + "type": "object", |
| 159 | + "additionalProperties": false |
| 160 | + }, |
| 161 | + "type": "array" |
| 162 | + }, |
| 163 | + "failureDomains": { |
| 164 | + "additionalProperties": { |
| 165 | + "description": "FailureDomainSpec is the Schema for Cluster API failure domains.\nIt allows controllers to understand how many failure domains a cluster can optionally span across.", |
| 166 | + "properties": { |
| 167 | + "attributes": { |
| 168 | + "additionalProperties": { |
| 169 | + "type": "string" |
| 170 | + }, |
| 171 | + "description": "attributes is a free form map of attributes an infrastructure provider might use or require.", |
| 172 | + "type": "object" |
| 173 | + }, |
| 174 | + "controlPlane": { |
| 175 | + "description": "controlPlane determines if this failure domain is suitable for use by control plane machines.", |
| 176 | + "type": "boolean" |
| 177 | + } |
| 178 | + }, |
| 179 | + "type": "object", |
| 180 | + "additionalProperties": false |
| 181 | + }, |
| 182 | + "description": "failureDomains don't mean much in CAPD since it's all local, but we can see how the rest of cluster API\nwill use this if we populate it.", |
| 183 | + "type": "object" |
| 184 | + }, |
| 185 | + "ready": { |
| 186 | + "description": "ready denotes that the dev cluster infrastructure is ready.", |
| 187 | + "type": "boolean" |
| 188 | + }, |
| 189 | + "v1beta2": { |
| 190 | + "description": "v1beta2 groups all the fields that will be added or modified in DevCluster's status with the V1Beta2 version.", |
| 191 | + "properties": { |
| 192 | + "conditions": { |
| 193 | + "description": "conditions represents the observations of a DevCluster's current state.", |
| 194 | + "items": { |
| 195 | + "description": "Condition contains details for one aspect of the current state of this API Resource.", |
| 196 | + "properties": { |
| 197 | + "lastTransitionTime": { |
| 198 | + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", |
| 199 | + "format": "date-time", |
| 200 | + "type": "string" |
| 201 | + }, |
| 202 | + "message": { |
| 203 | + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", |
| 204 | + "maxLength": 32768, |
| 205 | + "type": "string" |
| 206 | + }, |
| 207 | + "observedGeneration": { |
| 208 | + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", |
| 209 | + "format": "int64", |
| 210 | + "minimum": 0, |
| 211 | + "type": "integer" |
| 212 | + }, |
| 213 | + "reason": { |
| 214 | + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", |
| 215 | + "maxLength": 1024, |
| 216 | + "minLength": 1, |
| 217 | + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", |
| 218 | + "type": "string" |
| 219 | + }, |
| 220 | + "status": { |
| 221 | + "description": "status of the condition, one of True, False, Unknown.", |
| 222 | + "enum": [ |
| 223 | + "True", |
| 224 | + "False", |
| 225 | + "Unknown" |
| 226 | + ], |
| 227 | + "type": "string" |
| 228 | + }, |
| 229 | + "type": { |
| 230 | + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", |
| 231 | + "maxLength": 316, |
| 232 | + "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])$", |
| 233 | + "type": "string" |
| 234 | + } |
| 235 | + }, |
| 236 | + "required": [ |
| 237 | + "lastTransitionTime", |
| 238 | + "message", |
| 239 | + "reason", |
| 240 | + "status", |
| 241 | + "type" |
| 242 | + ], |
| 243 | + "type": "object", |
| 244 | + "additionalProperties": false |
| 245 | + }, |
| 246 | + "maxItems": 32, |
| 247 | + "type": "array", |
| 248 | + "x-kubernetes-list-map-keys": [ |
| 249 | + "type" |
| 250 | + ], |
| 251 | + "x-kubernetes-list-type": "map" |
| 252 | + } |
| 253 | + }, |
| 254 | + "type": "object", |
| 255 | + "additionalProperties": false |
| 256 | + } |
| 257 | + }, |
| 258 | + "type": "object", |
| 259 | + "additionalProperties": false |
| 260 | + } |
| 261 | + }, |
| 262 | + "type": "object" |
| 263 | +} |
0 commit comments