{ "description": "A ManagedResourceDefinition defines the schema for a new custom Kubernetes API.", "properties": { "apiVersion": { "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", "type": "string" }, "kind": { "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", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "ManagedResourceDefinitionSpec specifies the desired state of the resource definition.", "properties": { "connectionDetails": { "description": "ConnectionDetails is an array of connection detail keys and descriptions.", "items": { "description": "ConnectionDetail holds keys and descriptions of connection secrets.", "properties": { "description": { "description": "Description of how the key is used.", "type": "string" }, "name": { "description": "Name of the key.", "type": "string" } }, "required": [ "description", "name" ], "type": "object", "additionalProperties": false }, "type": "array" }, "conversion": { "description": "Conversion defines conversion settings for the CRD.", "properties": { "strategy": { "description": "strategy specifies how custom resources are converted between versions. Allowed values are:\n- `\"None\"`: The converter only change the apiVersion and would not touch any other field in the custom resource.\n- `\"Webhook\"`: API Server will call to an external webhook to do the conversion. Additional information\n is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.", "type": "string" }, "webhook": { "description": "webhook describes how to call the conversion webhook. Required when `strategy` is set to `\"Webhook\"`.", "properties": { "clientConfig": { "description": "clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.", "properties": { "caBundle": { "description": "caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.", "format": "byte", "type": "string" }, "service": { "description": "service is a reference to the service for this webhook. Either\nservice or url must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`.", "properties": { "name": { "description": "name is the name of the service.\nRequired", "type": "string" }, "namespace": { "description": "namespace is the namespace of the service.\nRequired", "type": "string" }, "path": { "description": "path is an optional URL path at which the webhook will be contacted.", "type": "string" }, "port": { "description": "port is an optional service port at which the webhook will be contacted.\n`port` should be a valid port number (1-65535, inclusive).\nDefaults to 443 for backward compatibility.", "format": "int32", "type": "integer" } }, "required": [ "name", "namespace" ], "type": "object", "additionalProperties": false }, "url": { "description": "url gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.\n\nThe `host` should not refer to a service running in the cluster; use\nthe `service` field instead. The host might be resolved via external\nDNS in some apiservers (e.g., `kube-apiserver` cannot resolve\nin-cluster DNS as that would be a layering violation). `host` may\nalso be an IP address.\n\nPlease note that using `localhost` or `127.0.0.1` as a `host` is\nrisky unless you take great care to run this webhook on all hosts\nwhich run an apiserver which might need to make calls to this\nwebhook. Such installs are likely to be non-portable, i.e., not easy\nto turn up in a new cluster.\n\nThe scheme must be \"https\"; the URL must begin with \"https://\".\n\nA path is optional, and if present may be any string permissible in\na URL. You may use the path to pass an arbitrary string to the\nwebhook, for example, a cluster identifier.\n\nAttempting to use a user or basic auth e.g. \"user:password@\" is not\nallowed. Fragments (\"#...\") and query parameters (\"?...\") are not\nallowed, either.", "type": "string" } }, "type": "object", "additionalProperties": false }, "conversionReviewVersions": { "description": "conversionReviewVersions is an ordered list of preferred `ConversionReview`\nversions the Webhook expects. The API server will use the first version in\nthe list which it supports. If none of the versions specified in this list\nare supported by API server, conversion will fail for the custom resource.\nIf a persisted Webhook configuration specifies allowed versions and does not\ninclude any versions known to the API Server, calls to the webhook will fail.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "conversionReviewVersions" ], "type": "object", "additionalProperties": false } }, "required": [ "strategy" ], "type": "object", "additionalProperties": false }, "group": { "description": "Group is the API group of the defined custom resource.\nThe custom resources are served under `/apis//...`.\nMust match the name of the CustomResourceDefinition (in the form `.`).", "type": "string", "x-kubernetes-validations": [ { "message": "Value is immutable", "rule": "self == oldSelf" } ] }, "names": { "description": "Names specify the resource and kind names for the custom resource.", "properties": { "categories": { "description": "categories is a list of grouped resources this custom resource belongs to (e.g. 'all').\nThis is published in API discovery documents, and used by clients to support invocations like\n`kubectl get all`.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "kind": { "description": "kind is the serialized kind of the resource. It is normally CamelCase and singular.\nCustom resource instances will use this value as the `kind` attribute in API calls.", "type": "string" }, "listKind": { "description": "listKind is the serialized kind of the list for this resource. Defaults to \"`kind`List\".", "type": "string" }, "plural": { "description": "plural is the plural name of the resource to serve.\nThe custom resources are served under `/apis///.../`.\nMust match the name of the CustomResourceDefinition (in the form `.`).\nMust be all lowercase.", "type": "string" }, "shortNames": { "description": "shortNames are short names for the resource, exposed in API discovery documents,\nand used by clients to support invocations like `kubectl get `.\nIt must be all lowercase.", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "singular": { "description": "singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.", "type": "string" } }, "required": [ "kind", "plural" ], "type": "object", "x-kubernetes-validations": [ { "message": "Value is immutable", "rule": "self == oldSelf" }, { "message": "Plural name must be lowercase", "rule": "self.plural == self.plural.lowerAscii()" }, { "message": "Singular name must be lowercase", "rule": "!has(self.singular) || self.singular == self.singular.lowerAscii()" } ], "additionalProperties": false }, "preserveUnknownFields": { "description": "PreserveUnknownFields indicates that object fields which are not specified\nin the OpenAPI schema should be preserved when persisting to storage.\napiVersion, kind, metadata and known fields inside metadata are always preserved.\nThis field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`.\nSee https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details.", "type": "boolean" }, "scope": { "default": "Namespaced", "description": "Scope indicates whether the defined custom resource is cluster- or namespace-scoped.\nAllowed values are `Cluster` and `Namespaced`.", "enum": [ "Namespaced", "Cluster" ], "type": "string", "x-kubernetes-validations": [ { "message": "Value is immutable", "rule": "self == oldSelf" } ] }, "state": { "default": "Inactive", "description": "State toggles whether the underlying CRD is created or not.", "enum": [ "Active", "Inactive" ], "type": "string", "x-kubernetes-validations": [ { "message": "state cannot be changed once it becomes Active", "rule": "self == oldSelf || oldSelf != 'Active'" } ] }, "versions": { "description": "Versions is the list of all API versions of the defined custom resource.\nVersion names are used to compute the order in which served versions are listed in API discovery.\nIf the version string is \"kube-like\", it will sort above non \"kube-like\" version strings, which are ordered\nlexicographically. \"Kube-like\" versions start with a \"v\", then are followed by a number (the major version),\nthen optionally the string \"alpha\" or \"beta\" and another number (the minor version). These are sorted first\nby GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing\nmajor version, then minor version. An example sorted list of versions:\nv10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.", "items": { "description": "CustomResourceDefinitionVersion describes a version for CRD.", "properties": { "additionalPrinterColumns": { "description": "AdditionalPrinterColumns specifies additional columns returned in Table output.\nSee https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details.\nIf no columns are specified, a single column displaying the age of the custom resource is used.", "items": { "description": "CustomResourceColumnDefinition specifies a column for server side printing.", "properties": { "description": { "description": "description is a human readable description of this column.", "type": "string" }, "format": { "description": "format is an optional OpenAPI type definition for this column. The 'name' format is applied\nto the primary identifier column to assist in clients identifying column is the resource name.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.", "type": "string" }, "jsonPath": { "description": "jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against\neach custom resource to produce the value for this column.", "type": "string" }, "name": { "description": "name is a human readable name for the column.", "type": "string" }, "priority": { "description": "priority is an integer defining the relative importance of this column compared to others. Lower\nnumbers are considered higher priority. Columns that may be omitted in limited space scenarios\nshould be given a priority greater than 0.", "format": "int32", "type": "integer" }, "type": { "description": "type is an OpenAPI type definition for this column.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.", "type": "string" } }, "required": [ "jsonPath", "name", "type" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "deprecated": { "description": "Deprecated indicates this version of the custom resource API is deprecated.\nWhen set to true, API requests to this version receive a warning header in the server response.\nDefaults to false.", "type": "boolean" }, "deprecationWarning": { "description": "DeprecationWarning overrides the default warning returned to API clients.\nMay only be set when `deprecated` is true.\nThe default warning indicates this version is deprecated and recommends use\nof the newest served version of equal or greater stability, if one exists.", "type": "string" }, "name": { "description": "Name is the version name, e.g. \u201cv1\u201d, \u201cv2beta1\u201d, etc.\nThe custom resources are served under this version at `/apis///...` if `served` is true.", "type": "string" }, "schema": { "description": "Schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.", "properties": { "openAPIV3Schema": { "description": "OpenAPIV3Schema is the OpenAPI v3 schema to use for validation and\npruning.", "type": "object", "x-kubernetes-preserve-unknown-fields": true } }, "type": "object", "additionalProperties": false }, "selectableFields": { "description": "SelectableFields specifies paths to fields that may be used as field selectors.\nA maximum of 8 selectable fields are allowed.\nSee https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors", "items": { "description": "SelectableField specifies the JSON path of a field that may be used with field selectors.", "properties": { "jsonPath": { "description": "jsonPath is a simple JSON path which is evaluated against each custom resource to produce a\nfield selector value.\nOnly JSON paths without the array notation are allowed.\nMust point to a field of type string, boolean or integer. Types with enum values\nand strings with formats are allowed.\nIf jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string.\nMust not point to metdata fields.\nRequired.", "type": "string" } }, "required": [ "jsonPath" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" }, "served": { "description": "Served is a flag enabling/disabling this version from being served via REST APIs", "type": "boolean" }, "storage": { "description": "Storage indicates this version should be used when persisting custom resources to storage.\nThere must be exactly one version with storage=true.", "type": "boolean" }, "subresources": { "description": "Subresources specify what subresources this version of the defined custom resource have.", "properties": { "scale": { "description": "scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.", "properties": { "labelSelectorPath": { "description": "labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`.\nOnly JSON paths without the array notation are allowed.\nMust be a JSON Path under `.status` or `.spec`.\nMust be set to work with HorizontalPodAutoscaler.\nThe field pointed by this JSON path must be a string field (not a complex selector struct)\nwhich contains a serialized label selector in string form.\nMore info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource\nIf there is no value under the given path in the custom resource, the `status.selector` value in the `/scale`\nsubresource will default to the empty string.", "type": "string" }, "specReplicasPath": { "description": "specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`.\nOnly JSON paths without the array notation are allowed.\nMust be a JSON Path under `.spec`.\nIf there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.", "type": "string" }, "statusReplicasPath": { "description": "statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`.\nOnly JSON paths without the array notation are allowed.\nMust be a JSON Path under `.status`.\nIf there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource\nwill default to 0.", "type": "string" } }, "required": [ "specReplicasPath", "statusReplicasPath" ], "type": "object", "additionalProperties": false }, "status": { "description": "status indicates the custom resource should serve a `/status` subresource.\nWhen enabled:\n1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object.\n2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.", "type": "object" } }, "type": "object", "additionalProperties": false } }, "required": [ "name", "served", "storage" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "group", "names", "scope", "versions" ], "type": "object", "additionalProperties": false }, "status": { "description": "ManagedResourceDefinitionStatus shows the observed state of the resource definition.", "properties": { "conditions": { "description": "Conditions of the resource.", "items": { "description": "A Condition that may apply to a resource.", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time this condition transitioned from one\nstatus to another.", "format": "date-time", "type": "string" }, "message": { "description": "A Message containing details about this condition's last transition from\none status to another, if any.", "type": "string" }, "observedGeneration": { "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.", "format": "int64", "type": "integer" }, "reason": { "description": "A Reason for this condition's last transition from one status to another.", "type": "string" }, "status": { "description": "Status of this condition; is it currently True, False, or Unknown?", "type": "string" }, "type": { "description": "Type of this condition. At most one of each condition type may apply to\na resource at any point in time.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" } }, "type": "object", "additionalProperties": false } }, "type": "object" }