CustomResourceDefinition
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
Create a CustomResourceDefinition Resource
new CustomResourceDefinition(name: string, args: CustomResourceDefinition, opts?: CustomResourceOptions);def CustomResourceDefinition(resource_name, opts=None, metadata=None, spec=None);func NewCustomResourceDefinition(ctx *Context, name string, args CustomResourceDefinitionArgs, opts ...ResourceOption) (*CustomResourceDefinition, error)public CustomResourceDefinition(string name, CustomResourceDefinitionArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args CustomResourceDefinition
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CustomResourceDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomResourceDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
CustomResourceDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The CustomResourceDefinition resource accepts the following input properties:
- Spec
Custom
Resource Definition Spec Args - spec describes how the user wants the resources to appear
- Metadata
Pulumi.
Kubernetes. Meta. V1. Inputs. Object Meta Args
- Spec
Custom
Resource Definition Spec - spec describes how the user wants the resources to appear
- Metadata
Object
Meta
- spec
Custom
Resource Definition Spec - spec describes how the user wants the resources to appear
- metadata
meta.v1.
Object Meta
- spec
Dict[Custom
Resource Definition Spec] - spec describes how the user wants the resources to appear
- metadata
Dict[Object
Meta]
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomResourceDefinition resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Custom
Resource Definition Status - status indicates the actual state of the CustomResourceDefinition
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Custom
Resource Definition Status - status indicates the actual state of the CustomResourceDefinition
- id string
- The provider-assigned unique ID for this managed resource.
- status
Custom
Resource Definition Status - status indicates the actual state of the CustomResourceDefinition
- id str
- The provider-assigned unique ID for this managed resource.
- status
Dict[Custom
Resource Definition Status] - status indicates the actual state of the CustomResourceDefinition
Supporting Types
CustomResourceColumnDefinition
- Json
Path string - 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.
- Name string
- name is a human readable name for the column.
- Type string
- 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.
- Description string
- description is a human readable description of this column.
- Format string
- 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.
- Priority int
- 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.
- Json
Path string - 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.
- Name string
- name is a human readable name for the column.
- Type string
- 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.
- Description string
- description is a human readable description of this column.
- Format string
- 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.
- Priority int
- 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.
- json
Path string - 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.
- name string
- name is a human readable name for the column.
- type string
- 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.
- description string
- description is a human readable description of this column.
- format string
- 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.
- priority number
- 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.
- json_
path str - 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.
- name str
- name is a human readable name for the column.
- type str
- 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.
- description str
- description is a human readable description of this column.
- format str
- 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.
- priority float
- 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.
CustomResourceConversion
- Strategy string
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.- Webhook
Webhook
Conversion Args - webhook describes how to call the conversion webhook. Required when
strategyis set toWebhook.
- Strategy string
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.- Webhook
Webhook
Conversion - webhook describes how to call the conversion webhook. Required when
strategyis set toWebhook.
- strategy string
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.- webhook
Webhook
Conversion - webhook describes how to call the conversion webhook. Required when
strategyis set toWebhook.
- strategy str
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.- webhook
Dict[Webhook
Conversion] - webhook describes how to call the conversion webhook. Required when
strategyis set toWebhook.
CustomResourceDefinitionCondition
See the output API doc for this type.
See the output API doc for this type.
- Status string
- status is the status of the condition. Can be True, False, Unknown.
- Type string
- type is the type of the condition. Types include Established, NamesAccepted and Terminating.
- Last
Transition stringTime - lastTransitionTime last time the condition transitioned from one status to another.
- Message string
- message is a human-readable message indicating details about last transition.
- Reason string
- reason is a unique, one-word, CamelCase reason for the condition’s last transition.
- Status string
- status is the status of the condition. Can be True, False, Unknown.
- Type string
- type is the type of the condition. Types include Established, NamesAccepted and Terminating.
- Last
Transition stringTime - lastTransitionTime last time the condition transitioned from one status to another.
- Message string
- message is a human-readable message indicating details about last transition.
- Reason string
- reason is a unique, one-word, CamelCase reason for the condition’s last transition.
- status string
- status is the status of the condition. Can be True, False, Unknown.
- type string
- type is the type of the condition. Types include Established, NamesAccepted and Terminating.
- last
Transition stringTime - lastTransitionTime last time the condition transitioned from one status to another.
- message string
- message is a human-readable message indicating details about last transition.
- reason string
- reason is a unique, one-word, CamelCase reason for the condition’s last transition.
- status str
- status is the status of the condition. Can be True, False, Unknown.
- type str
- type is the type of the condition. Types include Established, NamesAccepted and Terminating.
- last_
transition_ strtime - lastTransitionTime last time the condition transitioned from one status to another.
- message str
- message is a human-readable message indicating details about last transition.
- reason str
- reason is a unique, one-word, CamelCase reason for the condition’s last transition.
CustomResourceDefinitionNames
- Kind string
- kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the
kindattribute in API calls. - Plural string
- 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. - Categories List<string>
- 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. - List
Kind string - listKind is the serialized kind of the list for this resource. Defaults to “
kindList”. - Short
Names List<string> - 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. - Singular string
- singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased
kind.
- Kind string
- kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the
kindattribute in API calls. - Plural string
- 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. - Categories []string
- 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. - List
Kind string - listKind is the serialized kind of the list for this resource. Defaults to “
kindList”. - Short
Names []string - 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. - Singular string
- singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased
kind.
- kind string
- kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the
kindattribute in API calls. - plural string
- 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. - categories string[]
- 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. - list
Kind string - listKind is the serialized kind of the list for this resource. Defaults to “
kindList”. - short
Names string[] - 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. - singular string
- singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased
kind.
- kind str
- kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the
kindattribute in API calls. - plural str
- 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. - categories List[str]
- 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. - list_
kind str - listKind is the serialized kind of the list for this resource. Defaults to “
kindList”. - short_
names List[str] - 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. - singular str
- singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased
kind.
CustomResourceDefinitionSpec
- Group string
- 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>). - Names
Custom
Resource Definition Names Args - names specify the resource and kind names for the custom resource.
- Scope string
- scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced. - Versions
List<Custom
Resource Definition Version Args> - 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.
- Conversion
Custom
Resource Conversion Args - conversion defines conversion settings for the CRD.
- Preserve
Unknown boolFields - 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-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
- Group string
- 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>). - Names
Custom
Resource Definition Names - names specify the resource and kind names for the custom resource.
- Scope string
- scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced. - Versions
[]Custom
Resource Definition Version - 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.
- Conversion
Custom
Resource Conversion - conversion defines conversion settings for the CRD.
- Preserve
Unknown boolFields - 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-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
- group string
- 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>). - names
Custom
Resource Definition Names - names specify the resource and kind names for the custom resource.
- scope string
- scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced. - versions
Custom
Resource Definition Version[] - 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.
- conversion
Custom
Resource Conversion - conversion defines conversion settings for the CRD.
- preserve
Unknown booleanFields - 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-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
- group str
- 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>). - names
Dict[Custom
Resource Definition Names] - names specify the resource and kind names for the custom resource.
- scope str
- scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced. - versions
List[Custom
Resource Definition Version] - 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.
- conversion
Dict[Custom
Resource Conversion] - conversion defines conversion settings for the CRD.
- preserve_
unknown_ boolfields - 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-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
CustomResourceDefinitionStatus
See the output API doc for this type.
See the output API doc for this type.
- Accepted
Names CustomResource Definition Names Args - acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
- Stored
Versions List<string> - storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from
spec.versionswhile they exist in this list. - Conditions
List<Custom
Resource Definition Condition Args> - conditions indicate state for particular aspects of a CustomResourceDefinition
- Accepted
Names CustomResource Definition Names - acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
- Stored
Versions []string - storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from
spec.versionswhile they exist in this list. - Conditions
[]Custom
Resource Definition Condition - conditions indicate state for particular aspects of a CustomResourceDefinition
- accepted
Names CustomResource Definition Names - acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
- stored
Versions string[] - storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from
spec.versionswhile they exist in this list. - conditions
Custom
Resource Definition Condition[] - conditions indicate state for particular aspects of a CustomResourceDefinition
- accepted_
names Dict[CustomResource Definition Names] - acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
- stored_
versions List[str] - storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from
spec.versionswhile they exist in this list. - conditions
List[Custom
Resource Definition Condition] - conditions indicate state for particular aspects of a CustomResourceDefinition
CustomResourceDefinitionVersion
- Name string
- name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at
/apis/<group>/<version>/...ifservedis true. - Served bool
- served is a flag enabling/disabling this version from being served via REST APIs
- Storage bool
- storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
- Additional
Printer List<CustomColumns Resource Column Definition Args> - 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.
- Schema
Custom
Resource Validation Args - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- Subresources
Custom
Resource Subresources Args - subresources specify what subresources this version of the defined custom resource have.
- Name string
- name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at
/apis/<group>/<version>/...ifservedis true. - Served bool
- served is a flag enabling/disabling this version from being served via REST APIs
- Storage bool
- storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
- Additional
Printer []CustomColumns Resource Column Definition - 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.
- Schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- Subresources
Custom
Resource Subresources - subresources specify what subresources this version of the defined custom resource have.
- name string
- name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at
/apis/<group>/<version>/...ifservedis true. - served boolean
- served is a flag enabling/disabling this version from being served via REST APIs
- storage boolean
- storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
- additional
Printer CustomColumns Resource Column Definition[] - 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.
- schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- subresources
Custom
Resource Subresources - subresources specify what subresources this version of the defined custom resource have.
- name str
- name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at
/apis/<group>/<version>/...ifservedis true. - served bool
- served is a flag enabling/disabling this version from being served via REST APIs
- storage bool
- storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
- additional_
printer_ List[Customcolumns Resource Column Definition] - 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.
- schema
Dict[Custom
Resource Validation] - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- subresources
Dict[Custom
Resource Subresources] - subresources specify what subresources this version of the defined custom resource have.
CustomResourceSubresourceScale
- Spec
Replicas stringPath - 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/scalesubresource will return an error on GET. - Status
Replicas stringPath - 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, thestatus.replicasvalue in the/scalesubresource will default to 0. - Label
Selector stringPath - 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.statusor.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, thestatus.selectorvalue in the/scalesubresource will default to the empty string.
- Spec
Replicas stringPath - 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/scalesubresource will return an error on GET. - Status
Replicas stringPath - 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, thestatus.replicasvalue in the/scalesubresource will default to 0. - Label
Selector stringPath - 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.statusor.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, thestatus.selectorvalue in the/scalesubresource will default to the empty string.
- spec
Replicas stringPath - 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/scalesubresource will return an error on GET. - status
Replicas stringPath - 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, thestatus.replicasvalue in the/scalesubresource will default to 0. - label
Selector stringPath - 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.statusor.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, thestatus.selectorvalue in the/scalesubresource will default to the empty string.
- spec_
replicas_ strpath - 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/scalesubresource will return an error on GET. - status_
replicas_ strpath - 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, thestatus.replicasvalue in the/scalesubresource will default to 0. - label_
selector_ strpath - 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.statusor.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, thestatus.selectorvalue in the/scalesubresource will default to the empty string.
CustomResourceSubresources
- Scale
Custom
Resource Subresource Scale Args - scale indicates the custom resource should serve a
/scalesubresource that returns anautoscaling/v1Scale object. - Status
System.
Text. Json. Json Element - status indicates the custom resource should serve a
/statussubresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatusstanza of the object. 2. requests to the custom resource/statussubresource ignore changes to anything other than thestatusstanza of the object.
- Scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scalesubresource that returns anautoscaling/v1Scale object. - Status interface{}
- status indicates the custom resource should serve a
/statussubresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatusstanza of the object. 2. requests to the custom resource/statussubresource ignore changes to anything other than thestatusstanza of the object.
- scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scalesubresource that returns anautoscaling/v1Scale object. - status any
- status indicates the custom resource should serve a
/statussubresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatusstanza of the object. 2. requests to the custom resource/statussubresource ignore changes to anything other than thestatusstanza of the object.
- scale
Dict[Custom
Resource Subresource Scale] - scale indicates the custom resource should serve a
/scalesubresource that returns anautoscaling/v1Scale object. - status Dict[str, Any]
- status indicates the custom resource should serve a
/statussubresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatusstanza of the object. 2. requests to the custom resource/statussubresource ignore changes to anything other than thestatusstanza of the object.
CustomResourceValidation
- Open
APIV3Schema JSONSchemaProps Args - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- Open
APIV3Schema JSONSchemaProps - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- open
APIV3Schema JSONSchemaProps - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- open_
apiv3_ Dict[JSONSchemaschema Props] - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
ExternalDocumentation
JSONSchemaProps
- Additional
Items Union<JSONSchemaProps Args, bool> - Additional
Properties Union<JSONSchemaProps Args, bool> - All
Of List<JSONSchemaProps Args> - Any
Of List<JSONSchemaProps Args> - Default
System.
Text. Json. Json Element - default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
- Definitions
Dictionary<string, JSONSchema
Props Args> - Dependencies
Dictionary<string, Union<JSONSchema
Props Args, Immutable Array<string>>> - Description string
- Enum
List<System.
Text. Json. Json Element> - Example
System.
Text. Json. Json Element - Exclusive
Maximum bool - Exclusive
Minimum bool - External
Docs ExternalDocumentation Args - Format string
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)1{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)2{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)3{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)4{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like “0321751043” or “978-0321751041” - isbn10: an ISBN10 number string like “0321751043” - isbn13: an ISBN13 number string like “978-0321751041” - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like “#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like “rgb(255,255,2559” - byte: base64 encoded binary data - password: any kind of string - date: a date string like “2006-01-02” as defined by full-date in RFC3339 - duration: a duration string like “22 ns” as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like “2014-12-15T19:30:20.000Z” as defined by date-time in RFC3339.
- Id string
- Items
Union<JSONSchema
Props Args, Immutable Array<System. Text. Json. Json Element>> - Max
Items int - Max
Length int - Max
Properties int - Maximum double
- Min
Items int - Min
Length int - Min
Properties int - Minimum double
- Multiple
Of double - Not
JSONSchema
Props Args - Nullable bool
- One
Of List<JSONSchemaProps Args> - Pattern string
- Pattern
Properties Dictionary<string, JSONSchemaProps Args> - Properties
Dictionary<string, JSONSchema
Props Args> - Ref string
- Required List<string>
- Schema string
- Title string
- Type string
- Unique
Items bool - X_
kubernetes_ boolembedded_ resource - x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- X_
kubernetes_ boolint_ or_ string x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - … zero or more
- X_
kubernetes_ List<string>list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
mapby specifying the keys used as the index of the map.This tag MUST only be used on lists that have the “x-kubernetes-list-type” extension set to “map”. Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- X_
kubernetes_ stringlist_ type x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1)
atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, …). 2)set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-typeatomicor an array with x-kubernetes-list-typeatomic. 3)map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.- X_
kubernetes_ stringmap_ type x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1)
granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2)atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.- X_
kubernetes_ boolpreserve_ unknown_ fields - x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
- $Ref string
- $Schema string
- Additional
Items interface{} - Additional
Properties interface{} - All
Of []JSONSchemaProps - Any
Of []JSONSchemaProps - Default interface{}
- default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
- Definitions
map[string]JSONSchema
Props - Dependencies map[string]interface{}
- Description string
- Enum []interface{}
- Example interface{}
- Exclusive
Maximum bool - Exclusive
Minimum bool - External
Docs ExternalDocumentation - Format string
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)1{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)2{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)3{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)4{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like “0321751043” or “978-0321751041” - isbn10: an ISBN10 number string like “0321751043” - isbn13: an ISBN13 number string like “978-0321751041” - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like “#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like “rgb(255,255,2559” - byte: base64 encoded binary data - password: any kind of string - date: a date string like “2006-01-02” as defined by full-date in RFC3339 - duration: a duration string like “22 ns” as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like “2014-12-15T19:30:20.000Z” as defined by date-time in RFC3339.
- Id string
- Items interface{}
- Max
Items int - Max
Length int - Max
Properties int - Maximum float64
- Min
Items int - Min
Length int - Min
Properties int - Minimum float64
- Multiple
Of float64 - Not
JSONSchema
Props - Nullable bool
- One
Of []JSONSchemaProps - Pattern string
- Pattern
Properties map[string]JSONSchemaProps - Properties
map[string]JSONSchema
Props - Required []string
- Title string
- Type string
- Unique
Items bool - X_
kubernetes_ boolembedded_ resource - x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- X_
kubernetes_ boolint_ or_ string x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - … zero or more
- X_
kubernetes_ []stringlist_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
mapby specifying the keys used as the index of the map.This tag MUST only be used on lists that have the “x-kubernetes-list-type” extension set to “map”. Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- X_
kubernetes_ stringlist_ type x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1)
atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, …). 2)set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-typeatomicor an array with x-kubernetes-list-typeatomic. 3)map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.- X_
kubernetes_ stringmap_ type x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1)
granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2)atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.- X_
kubernetes_ boolpreserve_ unknown_ fields - x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
- $ref string
- $schema string
- additional
Items JSONSchemaProps | boolean - additional
Properties JSONSchemaProps | boolean - all
Of JSONSchemaProps[] - any
Of JSONSchemaProps[] - default any
- default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
- definitions
{[key: string]: JSONSchema
Props} - dependencies
{[key: string]: JSONSchema
Props | string[]} - description string
- enum any[]
- example any
- exclusive
Maximum boolean - exclusive
Minimum boolean - external
Docs ExternalDocumentation - format string
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)1{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)2{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)3{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)4{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like “0321751043” or “978-0321751041” - isbn10: an ISBN10 number string like “0321751043” - isbn13: an ISBN13 number string like “978-0321751041” - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like “#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like “rgb(255,255,2559” - byte: base64 encoded binary data - password: any kind of string - date: a date string like “2006-01-02” as defined by full-date in RFC3339 - duration: a duration string like “22 ns” as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like “2014-12-15T19:30:20.000Z” as defined by date-time in RFC3339.
- id string
- items
JSONSchema
Props | any[] - max
Items number - max
Length number - max
Properties number - maximum number
- min
Items number - min
Length number - min
Properties number - minimum number
- multiple
Of number - not
JSONSchema
Props - nullable boolean
- one
Of JSONSchemaProps[] - pattern string
- pattern
Properties {[key: string]: JSONSchemaProps} - properties
{[key: string]: JSONSchema
Props} - required string[]
- title string
- type string
- unique
Items boolean - x_
kubernetes_ booleanembedded_ resource - x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- x_
kubernetes_ booleanint_ or_ string x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - … zero or more
- x_
kubernetes_ string[]list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
mapby specifying the keys used as the index of the map.This tag MUST only be used on lists that have the “x-kubernetes-list-type” extension set to “map”. Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- x_
kubernetes_ stringlist_ type x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1)
atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, …). 2)set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-typeatomicor an array with x-kubernetes-list-typeatomic. 3)map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.- x_
kubernetes_ stringmap_ type x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1)
granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2)atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.- x_
kubernetes_ booleanpreserve_ unknown_ fields - x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
- _
ref str - _
schema str - additional_
items Dict[JSONSchemaProps] | boolean - additional_
properties Dict[JSONSchemaProps] | boolean - all_
of List[JSONSchemaProps] - any_
of List[JSONSchemaProps] - default Dict[str, Any]
- default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
- definitions
Dict[str, JSONSchema
Props] - dependencies
Dict[JSONSchema
Props] | List[str] - description str
- enum List[Any]
- example Dict[str, Any]
- exclusive_
maximum bool - exclusive_
minimum bool - external_
docs Dict[ExternalDocumentation] - format str
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)1{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)2{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)3{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)4{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like “0321751043” or “978-0321751041” - isbn10: an ISBN10 number string like “0321751043” - isbn13: an ISBN13 number string like “978-0321751041” - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like “#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like “rgb(255,255,2559” - byte: base64 encoded binary data - password: any kind of string - date: a date string like “2006-01-02” as defined by full-date in RFC3339 - duration: a duration string like “22 ns” as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like “2014-12-15T19:30:20.000Z” as defined by date-time in RFC3339.
- id str
- items
Dict[JSONSchema
Props] | List[Any] - max_
items float - max_
length float - max_
properties float - maximum float
- min_
items float - min_
length float - min_
properties float - minimum float
- multiple_
of float - not_
Dict[JSONSchema
Props] - nullable bool
- one_
of List[JSONSchemaProps] - pattern str
- pattern_
properties Dict[str, JSONSchemaProps] - properties
Dict[str, JSONSchema
Props] - required List[str]
- title str
- type str
- unique_
items bool - x_
kubernetes_ boolembedded_ resource - x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- x_
kubernetes_ boolint_ or_ string x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - … zero or more
- x_
kubernetes_ List[str]list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
mapby specifying the keys used as the index of the map.This tag MUST only be used on lists that have the “x-kubernetes-list-type” extension set to “map”. Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- x_
kubernetes_ strlist_ type x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1)
atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, …). 2)set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-typeatomicor an array with x-kubernetes-list-typeatomic. 3)map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.- x_
kubernetes_ strmap_ type x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1)
granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2)atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.- x_
kubernetes_ boolpreserve_ unknown_ fields - x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
ManagedFieldsEntry
- Api
Version string - APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
- Fields
Type string - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
- Fields
V1 System.Text. Json. Json Element - FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
- Manager string
- Manager is an identifier of the workflow managing these fields.
- Operation string
- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
- Time string
- Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
- Api
Version string - APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
- Fields
Type string - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
- Fields
V1 interface{} - FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
- Manager string
- Manager is an identifier of the workflow managing these fields.
- Operation string
- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
- Time string
- Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
- api
Version string - APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
- fields
Type string - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
- fields
V1 any - FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
- manager string
- Manager is an identifier of the workflow managing these fields.
- operation string
- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
- time string
- Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
- api_
version str - APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
- fields_
type str - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
- fields_
v1 Dict[str, Any] - FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
- manager str
- Manager is an identifier of the workflow managing these fields.
- operation str
- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
- time str
- Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
ObjectMeta
- Annotations Dictionary<string, string>
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- Cluster
Name string - The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
- Creation
Timestamp string CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Deletion
Grace intPeriod Seconds - Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- Deletion
Timestamp string DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Finalizers List<string>
- Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- Generate
Name string GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- Generation int
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- Labels Dictionary<string, string>
- Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- Managed
Fields List<Pulumi.Kubernetes. Meta. V1. Inputs. Managed Fields Entry Args> - ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
- Name string
- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- Namespace string
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- Owner
References List<Pulumi.Kubernetes. Meta. V1. Inputs. Owner Reference Args> - List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
- Resource
Version string An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Self
Link string SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- Uid string
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- Annotations map[string]string
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- Cluster
Name string - The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
- Creation
Timestamp string CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Deletion
Grace intPeriod Seconds - Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- Deletion
Timestamp string DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Finalizers []string
- Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- Generate
Name string GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- Generation int
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- Labels map[string]string
- Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- Managed
Fields ManagedFields Entry - ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
- Name string
- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- Namespace string
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- Owner
References OwnerReference - List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
- Resource
Version string An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Self
Link string SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- Uid string
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations {[key: string]: string}
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- cluster
Name string - The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
- creation
Timestamp string CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- deletion
Grace numberPeriod Seconds - Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- deletion
Timestamp string DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- finalizers string[]
- Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- generate
Name string GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- generation number
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels {[key: string]: string}
- Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- managed
Fields meta.v1.Managed Fields Entry[] - ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
- name string
- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- namespace string
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- owner
References meta.v1.Owner Reference[] - List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
- resource
Version string An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self
Link string SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- uid string
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations Dict[str, str]
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
- cluster_
name str - The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
- creation_
timestamp str CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- deletion_
grace_ floatperiod_ seconds - Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- deletion_
timestamp str DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- finalizers List[str]
- Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- generate_
name str GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- generation float
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels Dict[str, str]
- Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
- managed_
fields List[ManagedFields Entry] - ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.
- name str
- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- namespace str
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- owner_
references List[OwnerReference] - List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
- resource_
version str An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self_
link str SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- uid str
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
OwnerReference
- Api
Version string - API version of the referent.
- Kind string
- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- Uid string
- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- Block
Owner boolDeletion - If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- Controller bool
- If true, this reference points to the managing controller.
- Api
Version string - API version of the referent.
- Kind string
- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- Uid string
- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- Block
Owner boolDeletion - If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- Controller bool
- If true, this reference points to the managing controller.
- api
Version string - API version of the referent.
- kind string
- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name string
- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- uid string
- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- block
Owner booleanDeletion - If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- controller boolean
- If true, this reference points to the managing controller.
- api_
version str - API version of the referent.
- kind str
- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name str
- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- uid str
- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- block_
owner_ booldeletion - If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- controller bool
- If true, this reference points to the managing controller.
ServiceReference
- Name string
- name is the name of the service. Required
- Namespace string
- namespace is the namespace of the service. Required
- Path string
- path is an optional URL path at which the webhook will be contacted.
- Port int
- port is an optional service port at which the webhook will be contacted.
portshould be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- Name string
- name is the name of the service. Required
- Namespace string
- namespace is the namespace of the service. Required
- Path string
- path is an optional URL path at which the webhook will be contacted.
- Port int
- port is an optional service port at which the webhook will be contacted.
portshould be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- name string
- name is the name of the service. Required
- namespace string
- namespace is the namespace of the service. Required
- path string
- path is an optional URL path at which the webhook will be contacted.
- port number
- port is an optional service port at which the webhook will be contacted.
portshould be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- name str
- name is the name of the service. Required
- namespace str
- namespace is the namespace of the service. Required
- path str
- path is an optional URL path at which the webhook will be contacted.
- port float
- port is an optional service port at which the webhook will be contacted.
portshould be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
WebhookClientConfig
- Ca
Bundle string - 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.
- Service
Service
Reference Args 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.- Url string
url gives the location of the webhook, in standard URL form (
scheme://host:port/path). Exactly one ofurlorservicemust be specified.The
hostshould not refer to a service running in the cluster; use theservicefield instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiservercannot resolve in-cluster DNS as that would be a layering violation).hostmay also be an IP address.Please note that using
localhostor127.0.0.1as ahostis 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.
- Ca
Bundle string - 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.
- Service
Service
Reference 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.- Url string
url gives the location of the webhook, in standard URL form (
scheme://host:port/path). Exactly one ofurlorservicemust be specified.The
hostshould not refer to a service running in the cluster; use theservicefield instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiservercannot resolve in-cluster DNS as that would be a layering violation).hostmay also be an IP address.Please note that using
localhostor127.0.0.1as ahostis 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.
- ca
Bundle string - 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.
- service
Service
Reference 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.- url string
url gives the location of the webhook, in standard URL form (
scheme://host:port/path). Exactly one ofurlorservicemust be specified.The
hostshould not refer to a service running in the cluster; use theservicefield instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiservercannot resolve in-cluster DNS as that would be a layering violation).hostmay also be an IP address.Please note that using
localhostor127.0.0.1as ahostis 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.
- ca_
bundle str - 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.
- service
Dict[Service
Reference] 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.- url str
url gives the location of the webhook, in standard URL form (
scheme://host:port/path). Exactly one ofurlorservicemust be specified.The
hostshould not refer to a service running in the cluster; use theservicefield instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiservercannot resolve in-cluster DNS as that would be a layering violation).hostmay also be an IP address.Please note that using
localhostor127.0.0.1as ahostis 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.
WebhookConversion
- Conversion
Review List<string>Versions - conversionReviewVersions is an ordered list of preferred
ConversionReviewversions 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. - Client
Config WebhookClient Config Args - clientConfig is the instructions for how to call the webhook if strategy is
Webhook.
- Conversion
Review []stringVersions - conversionReviewVersions is an ordered list of preferred
ConversionReviewversions 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. - Client
Config WebhookClient Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook.
- conversion
Review string[]Versions - conversionReviewVersions is an ordered list of preferred
ConversionReviewversions 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. - client
Config WebhookClient Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook.
- conversion_
review_ List[str]versions - conversionReviewVersions is an ordered list of preferred
ConversionReviewversions 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. - client_
config Dict[WebhookClient Config] - clientConfig is the instructions for how to call the webhook if strategy is
Webhook.
Package Details
- Repository
- https://github.com/pulumi/pulumi-kubernetes
- License
- Apache-2.0