mirror of https://github.com/crossplane/docs.git
513 lines
27 KiB
YAML
513 lines
27 KiB
YAML
---
|
|
apiVersion: apiextensions.k8s.io/v1
|
|
kind: CustomResourceDefinition
|
|
metadata:
|
|
annotations:
|
|
controller-gen.kubebuilder.io/version: v0.18.0
|
|
name: managedresourcedefinitions.apiextensions.crossplane.io
|
|
spec:
|
|
group: apiextensions.crossplane.io
|
|
names:
|
|
categories:
|
|
- crossplane
|
|
kind: ManagedResourceDefinition
|
|
listKind: ManagedResourceDefinitionList
|
|
plural: managedresourcedefinitions
|
|
shortNames:
|
|
- mrd
|
|
- mrds
|
|
singular: managedresourcedefinition
|
|
scope: Cluster
|
|
versions:
|
|
- additionalPrinterColumns:
|
|
- jsonPath: .spec.state
|
|
name: STATE
|
|
type: string
|
|
- jsonPath: .status.conditions[?(@.type=='Established')].status
|
|
name: ESTABLISHED
|
|
type: string
|
|
- jsonPath: .metadata.creationTimestamp
|
|
name: AGE
|
|
type: date
|
|
name: v1alpha1
|
|
schema:
|
|
openAPIV3Schema:
|
|
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.
|
|
Servers should convert recognized schemas to the latest internal value, and
|
|
may reject unrecognized values.
|
|
More 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.
|
|
Servers may infer this from the endpoint the client submits requests to.
|
|
Cannot be updated.
|
|
In CamelCase.
|
|
More 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
|
|
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:
|
|
- `"None"`: The converter only change the apiVersion and would not touch any other field in the custom resource.
|
|
- `"Webhook"`: API Server will call to an external webhook to do the conversion. Additional information
|
|
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.
|
|
If 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
|
|
service or url must be specified.
|
|
|
|
If the webhook is running within the cluster, then you should use `service`.
|
|
properties:
|
|
name:
|
|
description: |-
|
|
name is the name of the service.
|
|
Required
|
|
type: string
|
|
namespace:
|
|
description: |-
|
|
namespace is the namespace of the service.
|
|
Required
|
|
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.
|
|
`port` should be a valid port number (1-65535, inclusive).
|
|
Defaults to 443 for backward compatibility.
|
|
format: int32
|
|
type: integer
|
|
required:
|
|
- name
|
|
- namespace
|
|
type: object
|
|
url:
|
|
description: |-
|
|
url gives the location of the webhook, in standard URL form
|
|
(`scheme://host:port/path`). Exactly one of `url` or `service`
|
|
must be specified.
|
|
|
|
The `host` should not refer to a service running in the cluster; use
|
|
the `service` field instead. The host might be resolved via external
|
|
DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
|
|
in-cluster DNS as that would be a layering violation). `host` may
|
|
also be an IP address.
|
|
|
|
Please note that using `localhost` or `127.0.0.1` as a `host` is
|
|
risky unless you take great care to run this webhook on all hosts
|
|
which run an apiserver which might need to make calls to this
|
|
webhook. Such installs are likely to be non-portable, i.e., not easy
|
|
to turn up in a new cluster.
|
|
|
|
The scheme must be "https"; the URL must begin with "https://".
|
|
|
|
A path is optional, and if present may be any string permissible in
|
|
a URL. You may use the path to pass an arbitrary string to the
|
|
webhook, for example, a cluster identifier.
|
|
|
|
Attempting to use a user or basic auth e.g. "user:password@" is not
|
|
allowed. Fragments ("#...") and query parameters ("?...") are not
|
|
allowed, either.
|
|
type: string
|
|
type: object
|
|
conversionReviewVersions:
|
|
description: |-
|
|
conversionReviewVersions is an ordered list of preferred `ConversionReview`
|
|
versions the Webhook expects. The API server will use the first version in
|
|
the list which it supports. If none of the versions specified in this list
|
|
are supported by API server, conversion will fail for the custom resource.
|
|
If a persisted Webhook configuration specifies allowed versions and does not
|
|
include 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
|
|
required:
|
|
- strategy
|
|
type: object
|
|
group:
|
|
description: |-
|
|
Group is the API group of the defined custom resource.
|
|
The custom resources are served under `/apis/<group>/...`.
|
|
Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
|
|
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').
|
|
This is published in API discovery documents, and used by clients to support invocations like
|
|
`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.
|
|
Custom 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.
|
|
The custom resources are served under `/apis/<group>/<version>/.../<plural>`.
|
|
Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
|
|
Must be all lowercase.
|
|
type: string
|
|
shortNames:
|
|
description: |-
|
|
shortNames are short names for the resource, exposed in API discovery documents,
|
|
and used by clients to support invocations like `kubectl get <shortname>`.
|
|
It 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()'
|
|
preserveUnknownFields:
|
|
description: |-
|
|
PreserveUnknownFields indicates that object fields which are not specified
|
|
in the OpenAPI schema should be preserved when persisting to storage.
|
|
apiVersion, kind, metadata and known fields inside metadata are always preserved.
|
|
This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`.
|
|
See 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.
|
|
Allowed 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.
|
|
Version names are used to compute the order in which served versions are listed in API discovery.
|
|
If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered
|
|
lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version),
|
|
then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first
|
|
by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing
|
|
major version, then minor version. An example sorted list of versions:
|
|
v10, 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.
|
|
See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details.
|
|
If 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
|
|
to the primary identifier column to assist in clients identifying column is the resource name.
|
|
See 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
|
|
each 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
|
|
numbers are considered higher priority. Columns that may be omitted in limited space scenarios
|
|
should be given a priority greater than 0.
|
|
format: int32
|
|
type: integer
|
|
type:
|
|
description: |-
|
|
type is an OpenAPI type definition for this column.
|
|
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
|
|
type: string
|
|
required:
|
|
- jsonPath
|
|
- name
|
|
- type
|
|
type: object
|
|
type: array
|
|
x-kubernetes-list-type: atomic
|
|
deprecated:
|
|
description: |-
|
|
Deprecated indicates this version of the custom resource API is deprecated.
|
|
When set to true, API requests to this version receive a warning header in the server response.
|
|
Defaults to false.
|
|
type: boolean
|
|
deprecationWarning:
|
|
description: |-
|
|
DeprecationWarning overrides the default warning returned to API clients.
|
|
May only be set when `deprecated` is true.
|
|
The default warning indicates this version is deprecated and recommends use
|
|
of the newest served version of equal or greater stability, if one exists.
|
|
type: string
|
|
name:
|
|
description: |-
|
|
Name is the version name, e.g. “v1”, “v2beta1”, etc.
|
|
The custom resources are served under this version at `/apis/<group>/<version>/...` 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
|
|
pruning.
|
|
type: object
|
|
x-kubernetes-preserve-unknown-fields: true
|
|
type: object
|
|
selectableFields:
|
|
description: |-
|
|
SelectableFields specifies paths to fields that may be used as field selectors.
|
|
A maximum of 8 selectable fields are allowed.
|
|
See 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
|
|
field selector value.
|
|
Only JSON paths without the array notation are allowed.
|
|
Must point to a field of type string, boolean or integer. Types with enum values
|
|
and strings with formats are allowed.
|
|
If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string.
|
|
Must not point to metdata fields.
|
|
Required.
|
|
type: string
|
|
required:
|
|
- jsonPath
|
|
type: object
|
|
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.
|
|
There 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`.
|
|
Only JSON paths without the array notation are allowed.
|
|
Must be a JSON Path under `.status` or `.spec`.
|
|
Must be set to work with HorizontalPodAutoscaler.
|
|
The field pointed by this JSON path must be a string field (not a complex selector struct)
|
|
which contains a serialized label selector in string form.
|
|
More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource
|
|
If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale`
|
|
subresource 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`.
|
|
Only JSON paths without the array notation are allowed.
|
|
Must be a JSON Path under `.spec`.
|
|
If 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`.
|
|
Only JSON paths without the array notation are allowed.
|
|
Must be a JSON Path under `.status`.
|
|
If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource
|
|
will default to 0.
|
|
type: string
|
|
required:
|
|
- specReplicasPath
|
|
- statusReplicasPath
|
|
type: object
|
|
status:
|
|
description: |-
|
|
status indicates the custom resource should serve a `/status` subresource.
|
|
When enabled:
|
|
1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object.
|
|
2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
|
|
type: object
|
|
type: object
|
|
required:
|
|
- name
|
|
- served
|
|
- storage
|
|
type: object
|
|
type: array
|
|
x-kubernetes-list-type: atomic
|
|
required:
|
|
- group
|
|
- names
|
|
- scope
|
|
- versions
|
|
type: object
|
|
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
|
|
status to another.
|
|
format: date-time
|
|
type: string
|
|
message:
|
|
description: |-
|
|
A Message containing details about this condition's last transition from
|
|
one status to another, if any.
|
|
type: string
|
|
observedGeneration:
|
|
description: |-
|
|
ObservedGeneration represents the .metadata.generation that the condition was set based upon.
|
|
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
|
|
with 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
|
|
a resource at any point in time.
|
|
type: string
|
|
required:
|
|
- lastTransitionTime
|
|
- reason
|
|
- status
|
|
- type
|
|
type: object
|
|
type: array
|
|
x-kubernetes-list-map-keys:
|
|
- type
|
|
x-kubernetes-list-type: map
|
|
type: object
|
|
type: object
|
|
served: true
|
|
storage: true
|
|
subresources:
|
|
status: {}
|