kubernetes.apiextensions.k8s.io/v1.CustomResourceDefinition
Explore with Pulumi AI
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
Create CustomResourceDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomResourceDefinition(name: string, args: CustomResourceDefinition, opts?: CustomResourceOptions);
@overload
def CustomResourceDefinition(resource_name: str,
args: CustomResourceDefinitionInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomResourceDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
spec: Optional[_apiextensions_k8s_io.v1.CustomResourceDefinitionSpecArgs] = None,
metadata: Optional[_meta.v1.ObjectMetaArgs] = None)
func NewCustomResourceDefinition(ctx *Context, name string, args CustomResourceDefinitionArgs, opts ...ResourceOption) (*CustomResourceDefinition, error)
public CustomResourceDefinition(string name, CustomResourceDefinitionArgs args, CustomResourceOptions? opts = null)
public CustomResourceDefinition(String name, CustomResourceDefinitionArgs args)
public CustomResourceDefinition(String name, CustomResourceDefinitionArgs args, CustomResourceOptions options)
type: kubernetes:apiextensions.k8s.io/v1:CustomResourceDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args CustomResourceDefinitionInitArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args CustomResourceDefinitionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var customResourceDefinitionResource = new Kubernetes.ApiExtensions.V1.CustomResourceDefinition("customResourceDefinitionResource", new()
{
Spec = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceDefinitionSpecArgs
{
Group = "string",
Names = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceDefinitionNamesArgs
{
Kind = "string",
Plural = "string",
Categories = new[]
{
"string",
},
ListKind = "string",
ShortNames = new[]
{
"string",
},
Singular = "string",
},
Scope = "string",
Versions = new[]
{
new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceDefinitionVersionArgs
{
Name = "string",
Served = false,
Storage = false,
AdditionalPrinterColumns = new[]
{
new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceColumnDefinitionArgs
{
JsonPath = "string",
Name = "string",
Type = "string",
Description = "string",
Format = "string",
Priority = 0,
},
},
Deprecated = false,
DeprecationWarning = "string",
Schema = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceValidationArgs
{
OpenAPIV3Schema = new Kubernetes.Types.Inputs.ApiExtensions.V1.JSONSchemaPropsArgs
{
Ref = "string",
Schema = "string",
AdditionalItems = false,
AdditionalProperties = false,
AllOf = new[]
{
jsonschemaProps,
},
AnyOf = new[]
{
jsonschemaProps,
},
Default = "{}",
Definitions =
{
{ "string", jsonschemaProps },
},
Dependencies =
{
{ "string", null },
},
Description = "string",
Enum = new[]
{
"{}",
},
Example = "{}",
ExclusiveMaximum = false,
ExclusiveMinimum = false,
ExternalDocs = new Kubernetes.Types.Inputs.ApiExtensions.V1.ExternalDocumentationArgs
{
Description = "string",
Url = "string",
},
Format = "string",
Id = "string",
Items = null,
MaxItems = 0,
MaxLength = 0,
MaxProperties = 0,
Maximum = 0,
MinItems = 0,
MinLength = 0,
MinProperties = 0,
Minimum = 0,
MultipleOf = 0,
Not = jsonschemaProps,
Nullable = false,
OneOf = new[]
{
jsonschemaProps,
},
Pattern = "string",
PatternProperties =
{
{ "string", jsonschemaProps },
},
Properties =
{
{ "string", jsonschemaProps },
},
Required = new[]
{
"string",
},
Title = "string",
Type = "string",
UniqueItems = false,
X_kubernetes_embedded_resource = false,
X_kubernetes_int_or_string = false,
X_kubernetes_list_map_keys = new[]
{
"string",
},
X_kubernetes_list_type = "string",
X_kubernetes_map_type = "string",
X_kubernetes_preserve_unknown_fields = false,
X_kubernetes_validations = new[]
{
new Kubernetes.Types.Inputs.ApiExtensions.V1.ValidationRuleArgs
{
Rule = "string",
FieldPath = "string",
Message = "string",
MessageExpression = "string",
OptionalOldSelf = false,
Reason = "string",
},
},
},
},
SelectableFields = new[]
{
new Kubernetes.Types.Inputs.ApiExtensions.V1.SelectableFieldArgs
{
JsonPath = "string",
},
},
Subresources = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceSubresourcesArgs
{
Scale = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceSubresourceScaleArgs
{
SpecReplicasPath = "string",
StatusReplicasPath = "string",
LabelSelectorPath = "string",
},
Status = "{}",
},
},
},
Conversion = new Kubernetes.Types.Inputs.ApiExtensions.V1.CustomResourceConversionArgs
{
Strategy = "string",
Webhook = new Kubernetes.Types.Inputs.ApiExtensions.V1.WebhookConversionArgs
{
ConversionReviewVersions = new[]
{
"string",
},
ClientConfig = new Kubernetes.Types.Inputs.ApiExtensions.V1.WebhookClientConfigArgs
{
CaBundle = "string",
Service = new Kubernetes.Types.Inputs.ApiExtensions.V1.ServiceReferenceArgs
{
Name = "string",
Namespace = "string",
Path = "string",
Port = 0,
},
Url = "string",
},
},
},
PreserveUnknownFields = false,
},
ApiVersion = "string",
Kind = "string",
Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
{
Annotations =
{
{ "string", "string" },
},
ClusterName = "string",
CreationTimestamp = "string",
DeletionGracePeriodSeconds = 0,
DeletionTimestamp = "string",
Finalizers = new[]
{
"string",
},
GenerateName = "string",
Generation = 0,
Labels =
{
{ "string", "string" },
},
ManagedFields = new[]
{
new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
{
ApiVersion = "string",
FieldsType = "string",
FieldsV1 = "{}",
Manager = "string",
Operation = "string",
Subresource = "string",
Time = "string",
},
},
Name = "string",
Namespace = "string",
OwnerReferences = new[]
{
new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
{
ApiVersion = "string",
Kind = "string",
Name = "string",
Uid = "string",
BlockOwnerDeletion = false,
Controller = false,
},
},
ResourceVersion = "string",
SelfLink = "string",
Uid = "string",
},
});
example, err := apiextensionsv1.NewCustomResourceDefinition(ctx, "customResourceDefinitionResource", &apiextensionsv1.CustomResourceDefinitionArgs{
Spec: &apiextensionsv1.CustomResourceDefinitionSpecArgs{
Group: pulumi.String("string"),
Names: &apiextensionsv1.CustomResourceDefinitionNamesArgs{
Kind: pulumi.String("string"),
Plural: pulumi.String("string"),
Categories: pulumi.StringArray{
pulumi.String("string"),
},
ListKind: pulumi.String("string"),
ShortNames: pulumi.StringArray{
pulumi.String("string"),
},
Singular: pulumi.String("string"),
},
Scope: pulumi.String("string"),
Versions: apiextensionsv1.CustomResourceDefinitionVersionArray{
&apiextensionsv1.CustomResourceDefinitionVersionArgs{
Name: pulumi.String("string"),
Served: pulumi.Bool(false),
Storage: pulumi.Bool(false),
AdditionalPrinterColumns: apiextensionsv1.CustomResourceColumnDefinitionArray{
&apiextensionsv1.CustomResourceColumnDefinitionArgs{
JsonPath: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Description: pulumi.String("string"),
Format: pulumi.String("string"),
Priority: pulumi.Int(0),
},
},
Deprecated: pulumi.Bool(false),
DeprecationWarning: pulumi.String("string"),
Schema: &apiextensionsv1.CustomResourceValidationArgs{
OpenAPIV3Schema: &apiextensionsv1.JSONSchemaPropsArgs{
Ref: pulumi.String("string"),
Schema: pulumi.String("string"),
AdditionalItems: pulumi.Any(false),
AdditionalProperties: pulumi.Any(false),
AllOf: apiextensionsv1.JSONSchemaPropsArray{
jsonschemaProps,
},
AnyOf: apiextensionsv1.JSONSchemaPropsArray{
jsonschemaProps,
},
Default: pulumi.Any("{}"),
Definitions: apiextensionsv1.JSONSchemaPropsMap{
"string": pulumi.Any(jsonschemaProps),
},
Dependencies: pulumi.Map{
"string": nil,
},
Description: pulumi.String("string"),
Enum: pulumi.Array{
pulumi.Any("{}"),
},
Example: pulumi.Any("{}"),
ExclusiveMaximum: pulumi.Bool(false),
ExclusiveMinimum: pulumi.Bool(false),
ExternalDocs: &apiextensionsv1.ExternalDocumentationArgs{
Description: pulumi.String("string"),
Url: pulumi.String("string"),
},
Format: pulumi.String("string"),
Id: pulumi.String("string"),
Items: nil,
MaxItems: pulumi.Int(0),
MaxLength: pulumi.Int(0),
MaxProperties: pulumi.Int(0),
Maximum: pulumi.Float64(0),
MinItems: pulumi.Int(0),
MinLength: pulumi.Int(0),
MinProperties: pulumi.Int(0),
Minimum: pulumi.Float64(0),
MultipleOf: pulumi.Float64(0),
Not: pulumi.Any(jsonschemaProps),
Nullable: pulumi.Bool(false),
OneOf: apiextensionsv1.JSONSchemaPropsArray{
jsonschemaProps,
},
Pattern: pulumi.String("string"),
PatternProperties: apiextensionsv1.JSONSchemaPropsMap{
"string": pulumi.Any(jsonschemaProps),
},
Properties: apiextensionsv1.JSONSchemaPropsMap{
"string": pulumi.Any(jsonschemaProps),
},
Required: pulumi.StringArray{
pulumi.String("string"),
},
Title: pulumi.String("string"),
Type: pulumi.String("string"),
UniqueItems: pulumi.Bool(false),
X_kubernetes_embedded_resource: pulumi.Bool(false),
X_kubernetes_int_or_string: pulumi.Bool(false),
X_kubernetes_list_map_keys: pulumi.StringArray{
pulumi.String("string"),
},
X_kubernetes_list_type: pulumi.String("string"),
X_kubernetes_map_type: pulumi.String("string"),
X_kubernetes_preserve_unknown_fields: pulumi.Bool(false),
X_kubernetes_validations: apiextensionsv1.ValidationRuleArray{
&apiextensionsv1.ValidationRuleArgs{
Rule: pulumi.String("string"),
FieldPath: pulumi.String("string"),
Message: pulumi.String("string"),
MessageExpression: pulumi.String("string"),
OptionalOldSelf: pulumi.Bool(false),
Reason: pulumi.String("string"),
},
},
},
},
SelectableFields: apiextensionsv1.SelectableFieldArray{
&apiextensionsv1.SelectableFieldArgs{
JsonPath: pulumi.String("string"),
},
},
Subresources: &apiextensionsv1.CustomResourceSubresourcesArgs{
Scale: &apiextensionsv1.CustomResourceSubresourceScaleArgs{
SpecReplicasPath: pulumi.String("string"),
StatusReplicasPath: pulumi.String("string"),
LabelSelectorPath: pulumi.String("string"),
},
Status: pulumi.Any("{}"),
},
},
},
Conversion: &apiextensionsv1.CustomResourceConversionArgs{
Strategy: pulumi.String("string"),
Webhook: &apiextensionsv1.WebhookConversionArgs{
ConversionReviewVersions: pulumi.StringArray{
pulumi.String("string"),
},
ClientConfig: &apiextensionsv1.WebhookClientConfigArgs{
CaBundle: pulumi.String("string"),
Service: &apiextensionsv1.ServiceReferenceArgs{
Name: pulumi.String("string"),
Namespace: pulumi.String("string"),
Path: pulumi.String("string"),
Port: pulumi.Int(0),
},
Url: pulumi.String("string"),
},
},
},
PreserveUnknownFields: pulumi.Bool(false),
},
ApiVersion: pulumi.String("string"),
Kind: pulumi.String("string"),
Metadata: &metav1.ObjectMetaArgs{
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
ClusterName: pulumi.String("string"),
CreationTimestamp: pulumi.String("string"),
DeletionGracePeriodSeconds: pulumi.Int(0),
DeletionTimestamp: pulumi.String("string"),
Finalizers: pulumi.StringArray{
pulumi.String("string"),
},
GenerateName: pulumi.String("string"),
Generation: pulumi.Int(0),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
ManagedFields: metav1.ManagedFieldsEntryArray{
&metav1.ManagedFieldsEntryArgs{
ApiVersion: pulumi.String("string"),
FieldsType: pulumi.String("string"),
FieldsV1: pulumi.Any("{}"),
Manager: pulumi.String("string"),
Operation: pulumi.String("string"),
Subresource: pulumi.String("string"),
Time: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Namespace: pulumi.String("string"),
OwnerReferences: metav1.OwnerReferenceArray{
&metav1.OwnerReferenceArgs{
ApiVersion: pulumi.String("string"),
Kind: pulumi.String("string"),
Name: pulumi.String("string"),
Uid: pulumi.String("string"),
BlockOwnerDeletion: pulumi.Bool(false),
Controller: pulumi.Bool(false),
},
},
ResourceVersion: pulumi.String("string"),
SelfLink: pulumi.String("string"),
Uid: pulumi.String("string"),
},
})
var customResourceDefinitionResource = new CustomResourceDefinition("customResourceDefinitionResource", CustomResourceDefinitionArgs.builder()
.spec(CustomResourceDefinitionSpecArgs.builder()
.group("string")
.names(CustomResourceDefinitionNamesArgs.builder()
.kind("string")
.plural("string")
.categories("string")
.listKind("string")
.shortNames("string")
.singular("string")
.build())
.scope("string")
.versions(CustomResourceDefinitionVersionArgs.builder()
.name("string")
.served(false)
.storage(false)
.additionalPrinterColumns(CustomResourceColumnDefinitionArgs.builder()
.jsonPath("string")
.name("string")
.type("string")
.description("string")
.format("string")
.priority(0)
.build())
.deprecated(false)
.deprecationWarning("string")
.schema(CustomResourceValidationArgs.builder()
.openAPIV3Schema(JSONSchemaPropsArgs.builder()
%!v(PANIC=Format method: interface conversion: model.Expression is *model.TemplateExpression, not *model.LiteralValueExpression))
.build())
.selectableFields(SelectableFieldArgs.builder()
.jsonPath("string")
.build())
.subresources(CustomResourceSubresourcesArgs.builder()
.scale(CustomResourceSubresourceScaleArgs.builder()
.specReplicasPath("string")
.statusReplicasPath("string")
.labelSelectorPath("string")
.build())
.status("{}")
.build())
.build())
.conversion(CustomResourceConversionArgs.builder()
.strategy("string")
.webhook(WebhookConversionArgs.builder()
.conversionReviewVersions("string")
.clientConfig(WebhookClientConfigArgs.builder()
.caBundle("string")
.service(ServiceReferenceArgs.builder()
.name("string")
.namespace("string")
.path("string")
.port(0)
.build())
.url("string")
.build())
.build())
.build())
.preserveUnknownFields(false)
.build())
.apiVersion("string")
.kind("string")
.metadata(ObjectMetaArgs.builder()
.annotations(Map.of("string", "string"))
.clusterName("string")
.creationTimestamp("string")
.deletionGracePeriodSeconds(0)
.deletionTimestamp("string")
.finalizers("string")
.generateName("string")
.generation(0)
.labels(Map.of("string", "string"))
.managedFields(ManagedFieldsEntryArgs.builder()
.apiVersion("string")
.fieldsType("string")
.fieldsV1("{}")
.manager("string")
.operation("string")
.subresource("string")
.time("string")
.build())
.name("string")
.namespace("string")
.ownerReferences(OwnerReferenceArgs.builder()
.apiVersion("string")
.kind("string")
.name("string")
.uid("string")
.blockOwnerDeletion(false)
.controller(false)
.build())
.resourceVersion("string")
.selfLink("string")
.uid("string")
.build())
.build());
custom_resource_definition_resource = kubernetes.apiextensions.v1.CustomResourceDefinition("customResourceDefinitionResource",
spec={
"group": "string",
"names": {
"kind": "string",
"plural": "string",
"categories": ["string"],
"listKind": "string",
"shortNames": ["string"],
"singular": "string",
},
"scope": "string",
"versions": [{
"name": "string",
"served": False,
"storage": False,
"additionalPrinterColumns": [{
"jsonPath": "string",
"name": "string",
"type": "string",
"description": "string",
"format": "string",
"priority": 0,
}],
"deprecated": False,
"deprecationWarning": "string",
"schema": {
"openAPIV3Schema": {
"$ref": "string",
"$schema": "string",
"additionalItems": False,
"additionalProperties": False,
"allOf": [jsonschema_props],
"anyOf": [jsonschema_props],
"default": "{}",
"definitions": {
"string": jsonschema_props,
},
"dependencies": {
"string": None,
},
"description": "string",
"enum": ["{}"],
"example": "{}",
"exclusiveMaximum": False,
"exclusiveMinimum": False,
"externalDocs": {
"description": "string",
"url": "string",
},
"format": "string",
"id": "string",
"items": None,
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": jsonschema_props,
"nullable": False,
"oneOf": [jsonschema_props],
"pattern": "string",
"patternProperties": {
"string": jsonschema_props,
},
"properties": {
"string": jsonschema_props,
},
"required": ["string"],
"title": "string",
"type": "string",
"uniqueItems": False,
"x_kubernetes_embedded_resource": False,
"x_kubernetes_int_or_string": False,
"x_kubernetes_list_map_keys": ["string"],
"x_kubernetes_list_type": "string",
"x_kubernetes_map_type": "string",
"x_kubernetes_preserve_unknown_fields": False,
"x_kubernetes_validations": [{
"rule": "string",
"fieldPath": "string",
"message": "string",
"messageExpression": "string",
"optionalOldSelf": False,
"reason": "string",
}],
},
},
"selectableFields": [{
"jsonPath": "string",
}],
"subresources": {
"scale": {
"specReplicasPath": "string",
"statusReplicasPath": "string",
"labelSelectorPath": "string",
},
"status": "{}",
},
}],
"conversion": {
"strategy": "string",
"webhook": {
"conversionReviewVersions": ["string"],
"clientConfig": {
"caBundle": "string",
"service": {
"name": "string",
"namespace": "string",
"path": "string",
"port": 0,
},
"url": "string",
},
},
},
"preserveUnknownFields": False,
},
api_version="string",
kind="string",
metadata={
"annotations": {
"string": "string",
},
"clusterName": "string",
"creationTimestamp": "string",
"deletionGracePeriodSeconds": 0,
"deletionTimestamp": "string",
"finalizers": ["string"],
"generateName": "string",
"generation": 0,
"labels": {
"string": "string",
},
"managedFields": [{
"apiVersion": "string",
"fieldsType": "string",
"fieldsV1": "{}",
"manager": "string",
"operation": "string",
"subresource": "string",
"time": "string",
}],
"name": "string",
"namespace": "string",
"ownerReferences": [{
"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"blockOwnerDeletion": False,
"controller": False,
}],
"resourceVersion": "string",
"selfLink": "string",
"uid": "string",
})
const customResourceDefinitionResource = new kubernetes.apiextensions.v1.CustomResourceDefinition("customResourceDefinitionResource", {
spec: {
group: "string",
names: {
kind: "string",
plural: "string",
categories: ["string"],
listKind: "string",
shortNames: ["string"],
singular: "string",
},
scope: "string",
versions: [{
name: "string",
served: false,
storage: false,
additionalPrinterColumns: [{
jsonPath: "string",
name: "string",
type: "string",
description: "string",
format: "string",
priority: 0,
}],
deprecated: false,
deprecationWarning: "string",
schema: {
openAPIV3Schema: {
$ref: "string",
$schema: "string",
additionalItems: false,
additionalProperties: false,
allOf: [jsonschemaProps],
anyOf: [jsonschemaProps],
"default": "{}",
definitions: {
string: jsonschemaProps,
},
dependencies: {
string: undefined,
},
description: "string",
"enum": ["{}"],
example: "{}",
exclusiveMaximum: false,
exclusiveMinimum: false,
externalDocs: {
description: "string",
url: "string",
},
format: "string",
id: "string",
items: undefined,
maxItems: 0,
maxLength: 0,
maxProperties: 0,
maximum: 0,
minItems: 0,
minLength: 0,
minProperties: 0,
minimum: 0,
multipleOf: 0,
not: jsonschemaProps,
nullable: false,
oneOf: [jsonschemaProps],
pattern: "string",
patternProperties: {
string: jsonschemaProps,
},
properties: {
string: jsonschemaProps,
},
required: ["string"],
title: "string",
type: "string",
uniqueItems: false,
x_kubernetes_embedded_resource: false,
x_kubernetes_int_or_string: false,
x_kubernetes_list_map_keys: ["string"],
x_kubernetes_list_type: "string",
x_kubernetes_map_type: "string",
x_kubernetes_preserve_unknown_fields: false,
x_kubernetes_validations: [{
rule: "string",
fieldPath: "string",
message: "string",
messageExpression: "string",
optionalOldSelf: false,
reason: "string",
}],
},
},
selectableFields: [{
jsonPath: "string",
}],
subresources: {
scale: {
specReplicasPath: "string",
statusReplicasPath: "string",
labelSelectorPath: "string",
},
status: "{}",
},
}],
conversion: {
strategy: "string",
webhook: {
conversionReviewVersions: ["string"],
clientConfig: {
caBundle: "string",
service: {
name: "string",
namespace: "string",
path: "string",
port: 0,
},
url: "string",
},
},
},
preserveUnknownFields: false,
},
apiVersion: "string",
kind: "string",
metadata: {
annotations: {
string: "string",
},
clusterName: "string",
creationTimestamp: "string",
deletionGracePeriodSeconds: 0,
deletionTimestamp: "string",
finalizers: ["string"],
generateName: "string",
generation: 0,
labels: {
string: "string",
},
managedFields: [{
apiVersion: "string",
fieldsType: "string",
fieldsV1: "{}",
manager: "string",
operation: "string",
subresource: "string",
time: "string",
}],
name: "string",
namespace: "string",
ownerReferences: [{
apiVersion: "string",
kind: "string",
name: "string",
uid: "string",
blockOwnerDeletion: false,
controller: false,
}],
resourceVersion: "string",
selfLink: "string",
uid: "string",
},
});
type: kubernetes:apiextensions.k8s.io/v1:CustomResourceDefinition
properties:
apiVersion: string
kind: string
metadata:
annotations:
string: string
clusterName: string
creationTimestamp: string
deletionGracePeriodSeconds: 0
deletionTimestamp: string
finalizers:
- string
generateName: string
generation: 0
labels:
string: string
managedFields:
- apiVersion: string
fieldsType: string
fieldsV1: '{}'
manager: string
operation: string
subresource: string
time: string
name: string
namespace: string
ownerReferences:
- apiVersion: string
blockOwnerDeletion: false
controller: false
kind: string
name: string
uid: string
resourceVersion: string
selfLink: string
uid: string
spec:
conversion:
strategy: string
webhook:
clientConfig:
caBundle: string
service:
name: string
namespace: string
path: string
port: 0
url: string
conversionReviewVersions:
- string
group: string
names:
categories:
- string
kind: string
listKind: string
plural: string
shortNames:
- string
singular: string
preserveUnknownFields: false
scope: string
versions:
- additionalPrinterColumns:
- description: string
format: string
jsonPath: string
name: string
priority: 0
type: string
deprecated: false
deprecationWarning: string
name: string
schema:
openAPIV3Schema:
$ref: string
$schema: string
additionalItems: false
additionalProperties: false
allOf:
- ${jsonschemaProps}
anyOf:
- ${jsonschemaProps}
default: '{}'
definitions:
string: ${jsonschemaProps}
dependencies:
string: null
description: string
enum:
- '{}'
example: '{}'
exclusiveMaximum: false
exclusiveMinimum: false
externalDocs:
description: string
url: string
format: string
id: string
items: null
maxItems: 0
maxLength: 0
maxProperties: 0
maximum: 0
minItems: 0
minLength: 0
minProperties: 0
minimum: 0
multipleOf: 0
not: ${jsonschemaProps}
nullable: false
oneOf:
- ${jsonschemaProps}
pattern: string
patternProperties:
string: ${jsonschemaProps}
properties:
string: ${jsonschemaProps}
required:
- string
title: string
type: string
uniqueItems: false
x_kubernetes_embedded_resource: false
x_kubernetes_int_or_string: false
x_kubernetes_list_map_keys:
- string
x_kubernetes_list_type: string
x_kubernetes_map_type: string
x_kubernetes_preserve_unknown_fields: false
x_kubernetes_validations:
- fieldPath: string
message: string
messageExpression: string
optionalOldSelf: false
reason: string
rule: string
selectableFields:
- jsonPath: string
served: false
storage: false
subresources:
scale:
labelSelectorPath: string
specReplicasPath: string
statusReplicasPath: string
status: '{}'
CustomResourceDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CustomResourceDefinition resource accepts the following input properties:
- Spec
Custom
Resource Definition Spec - spec describes how the user wants the resources to appear
- Metadata
Pulumi.
Kubernetes. Meta. V1. Inputs. Object Meta - Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Spec
Custom
Resource Definition Spec Args - spec describes how the user wants the resources to appear
- Metadata
Object
Meta Args - Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Custom
Resource Definition Spec - spec describes how the user wants the resources to appear
- metadata
Object
Meta - Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Custom
Resource Definition Spec - spec describes how the user wants the resources to appear
- metadata
meta.v1.
Object Meta - Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
apiextensions_
k8s_ io.v1. Custom Resource Definition Spec Args - spec describes how the user wants the resources to appear
- metadata
meta.v1.
Object Meta Args - Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec Property Map
- spec describes how the user wants the resources to appear
- metadata Property Map
- Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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 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
apiextensions_
k8s_ io.v1. Custom Resource Definition Status - status indicates the actual state of the CustomResourceDefinition
- id String
- The provider-assigned unique ID for this managed resource.
- status Property Map
- status indicates the actual state of the CustomResourceDefinition
Supporting Types
CustomResourceColumnDefinition, CustomResourceColumnDefinitionArgs
- 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 Integer
- 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 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.
CustomResourceConversion, CustomResourceConversionArgs
- 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
strategy
is set to"Webhook"
.
- 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
strategy
is set to"Webhook"
.
- 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
strategy
is set to"Webhook"
.
- 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
strategy
is set to"Webhook"
.
- 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
apiextensions_
k8s_ io.v1. Webhook Conversion - webhook describes how to call the conversion webhook. Required when
strategy
is set to"Webhook"
.
- 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 Property Map
- webhook describes how to call the conversion webhook. Required when
strategy
is set to"Webhook"
.
CustomResourceDefinitionCondition, CustomResourceDefinitionConditionArgs
- 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 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.
- 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.
CustomResourceDefinitionNames, CustomResourceDefinitionNamesArgs
- 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
kind
attribute 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 "
kind
List". - 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
kind
attribute 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 "
kind
List". - 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
kind
attribute 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 "
kind
List". - 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
kind
attribute 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 "
kind
List". - 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
kind
attribute 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 Sequence[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 "
kind
List". - short_
names Sequence[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
.
- 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
kind
attribute 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 "
kind
List". - 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
.
CustomResourceDefinitionSpec, CustomResourceDefinitionSpecArgs
- 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
Cluster
andNamespaced
. - 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
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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning 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
Cluster
andNamespaced
. - 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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning 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
Cluster
andNamespaced
. - 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
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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning 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
Cluster
andNamespaced
. - 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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning 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
apiextensions_
k8s_ io.v1. 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
Cluster
andNamespaced
. - versions
Sequence[apiextensions_
k8s_ io.v1. 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
apiextensions_
k8s_ io.v1. 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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning 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 Property Map
- 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
Cluster
andNamespaced
. - versions List<Property Map>
- 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 Property Map
- 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-fields
to true inspec.versions[*].schema.openAPIV3Schema
. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details.
CustomResourceDefinitionStatus, CustomResourceDefinitionStatusArgs
- 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 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.versions
while they exist in this list. - Conditions
List<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.versions
while 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 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.versions
while they exist in this list. - conditions
List<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.versions
while they exist in this list. - conditions
Custom
Resource Definition Condition[] - conditions indicate state for particular aspects of a CustomResourceDefinition
- accepted_
names apiextensions_k8s_ io.v1. Custom Resource 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 Sequence[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.versions
while they exist in this list. - conditions
Sequence[apiextensions_
k8s_ io.v1. Custom Resource Definition Condition] - conditions indicate state for particular aspects of a CustomResourceDefinition
- accepted
Names Property Map - 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.versions
while they exist in this list. - conditions List<Property Map>
- conditions indicate state for particular aspects of a CustomResourceDefinition
CustomResourceDefinitionVersion, CustomResourceDefinitionVersionArgs
- Name string
- name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at
/apis/<group>/<version>/...
ifserved
is 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.
- Deprecated bool
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- Deprecation
Warning string - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - Schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- Selectable
Fields List<SelectableField> - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- 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>/...
ifserved
is 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.
- Deprecated bool
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- Deprecation
Warning string - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - Schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- Selectable
Fields []SelectableField - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- 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>/...
ifserved
is 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 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.
- deprecated Boolean
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- deprecation
Warning String - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- selectable
Fields List<SelectableField> - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- 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>/...
ifserved
is 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.
- deprecated boolean
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- deprecation
Warning string - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - schema
Custom
Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- selectable
Fields SelectableField[] - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- 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>/...
ifserved
is 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_ Sequence[apiextensions_columns k8s_ io.v1. Custom 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.
- deprecated bool
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- deprecation_
warning str - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - schema
apiextensions_
k8s_ io.v1. Custom Resource Validation - schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- selectable_
fields Sequence[apiextensions_k8s_ io.v1. Selectable Field] - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- subresources
apiextensions_
k8s_ io.v1. 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>/...
ifserved
is 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 List<Property Map>Columns - 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.
- deprecated Boolean
- deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- deprecation
Warning String - deprecationWarning overrides the default warning returned to API clients. May only be set when
deprecated
is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. - schema Property Map
- schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
- selectable
Fields List<Property Map> - selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
- subresources Property Map
- subresources specify what subresources this version of the defined custom resource have.
CustomResourceSubresourceScale, CustomResourceSubresourceScaleArgs
- 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource 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/scale
subresource 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.replicas
value in the/scale
subresource 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.status
or.spec
. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, thestatus.selector
value in the/scale
subresource will default to the empty string.
CustomResourceSubresources, CustomResourceSubresourcesArgs
- Scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - Status
System.
Text. Json. Json Element - status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
- Scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - Status interface{}
- status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
- scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - status
Json
Element - status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
- scale
Custom
Resource Subresource Scale - scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - status any
- status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
- scale
apiextensions_
k8s_ io.v1. Custom Resource Subresource Scale - scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - status Any
- status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
- scale Property Map
- scale indicates the custom resource should serve a
/scale
subresource that returns anautoscaling/v1
Scale object. - status JSON
- status indicates the custom resource should serve a
/status
subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to thestatus
stanza of the object. 2. requests to the custom resource/status
subresource ignore changes to anything other than thestatus
stanza of the object.
CustomResourceValidation, CustomResourceValidationArgs
- 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
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_ apiextensions_schema k8s_ io.v1. JSONSchema Props - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- open
APIV3Schema Property Map - openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
ExternalDocumentation, ExternalDocumentationArgs
- Description string
- Url string
- Description string
- Url string
- description String
- url String
- description string
- url string
- description str
- url str
- description String
- url String
JSONSchemaProps, JSONSchemaPropsArgs
- Additional
Items JSONSchemaProps | bool - Additional
Properties JSONSchemaProps | bool - All
Of List<JSONSchemaProps> - Any
Of List<JSONSchemaProps> - 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> - Dependencies
Dictionary<string, Union<JSONSchema
Props, 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 - 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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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 | List<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 - Nullable bool
- One
Of List<JSONSchemaProps> - Pattern string
- Pattern
Properties Dictionary<string, JSONSchemaProps> - Properties
Dictionary<string, JSONSchema
Props> - 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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- X_
kubernetes_ List<string>list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- X_
kubernetes_ List<Validationvalidations Rule> - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
- $Ref string
- $Schema string
- Additional
Items JSONSchemaProps | bool - Additional
Properties JSONSchemaProps | bool - 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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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 | []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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- X_
kubernetes_ []stringlist_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- X_
kubernetes_ []Validationvalidations Rule - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
- $ref String
- $schema String
- additional
Items JSONSchemaProps | Boolean - additional
Properties JSONSchemaProps | Boolean - all
Of List<JSONSchemaProps> - any
Of List<JSONSchemaProps> - default_
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
Map<String,JSONSchema
Props> - dependencies
Map<String,Either<JSONSchema
Props,List<String>>> - description String
- enum_
List<Json
Element> - example
Json
Element - 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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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 | List<JsonElement> - max
Items Integer - max
Length Integer - max
Properties Integer - maximum Double
- min
Items Integer - min
Length Integer - min
Properties Integer - minimum Double
- multiple
Of Double - not
JSONSchema
Props - nullable Boolean
- one
Of List<JSONSchemaProps> - pattern String
- pattern
Properties Map<String,JSONSchemaProps> - properties
Map<String,JSONSchema
Props> - required List<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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- x_
kubernetes_ List<String>list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- x_
kubernetes_ List<Validationvalidations Rule> - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
- $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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- x_
kubernetes_ string[]list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- x_
kubernetes_ Validationvalidations Rule[] - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
- _
ref str - _
schema str - additional_
items apiextensions_k8s_ | boolio.v1. JSONSchema Props - additional_
properties apiextensions_k8s_ | boolio.v1. JSONSchema Props - all_
of Sequence[apiextensions_k8s_ io.v1. JSONSchema Props] - any_
of Sequence[apiextensions_k8s_ io.v1. JSONSchema Props] - 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
Mapping[str, apiextensions_
k8s_ io.v1. JSONSchema Props] - dependencies
Mapping[str, Union[apiextensions_
k8s_ io.v1. JSONSchema Props, Sequence[str]]] - description str
- enum Sequence[Any]
- example Any
- exclusive_
maximum bool - exclusive_
minimum bool - external_
docs apiextensions_k8s_ io.v1. External Documentation - 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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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
apiextensions_
k8s_ | Sequence[Any]io.v1. JSONSchema Props - max_
items int - max_
length int - max_
properties int - maximum float
- min_
items int - min_
length int - min_
properties int - minimum float
- multiple_
of float - not_
apiextensions_
k8s_ io.v1. JSONSchema Props - nullable bool
- one_
of Sequence[apiextensions_k8s_ io.v1. JSONSchema Props] - pattern str
- pattern_
properties Mapping[str, apiextensions_k8s_ io.v1. JSONSchema Props] - properties
Mapping[str, apiextensions_
k8s_ io.v1. JSONSchema Props] - required Sequence[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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- x_
kubernetes_ Sequence[str]list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- x_
kubernetes_ Sequence[apiextensions_validations k8s_ io.v1. Validation Rule] - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
- $ref String
- $schema String
- additional
Items Property Map | Boolean - additional
Properties Property Map | Boolean - all
Of List<Property Map> - any
Of List<Property Map> - default JSON
- 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<Property Map>
- dependencies Map<Property Map | List<String>>
- description String
- enum List<JSON>
- example JSON
- exclusive
Maximum Boolean - exclusive
Minimum Boolean - external
Docs Property Map - 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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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)^[0-9a-f]{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 Property Map | List<JSON>
- 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 Property Map
- nullable Boolean
- one
Of List<Property Map> - pattern String
- pattern
Properties Map<Property Map> - properties Map<Property Map>
- required List<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:
- anyOf:
- type: integer
- type: string
- allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- anyOf:
- anyOf:
- x_
kubernetes_ List<String>list_ map_ keys x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type
map
by 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:
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, ...).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-typeatomic
or an array with x-kubernetes-list-typeatomic
.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:
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.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.
- x_
kubernetes_ List<Property Map>validations - x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
ManagedFieldsEntry, ManagedFieldsEntryArgs
- 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'.
- Subresource string
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- Time string
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- 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'.
- Subresource string
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- Time string
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- 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 JsonElement - 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'.
- subresource String
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- time String
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- 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'.
- subresource string
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- time string
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- 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 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'.
- subresource str
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- time str
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- 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 JSON - 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'.
- subresource String
- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- time String
- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
ObjectMeta, ObjectMetaArgs
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 return a 409.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
- Managed
Fields List<Pulumi.Kubernetes. Meta. V1. Inputs. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- Namespace string
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
- Owner
References List<Pulumi.Kubernetes. Meta. V1. Inputs. 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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 return a 409.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- Namespace string
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 IntegerPeriod 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 return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- generation Integer
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- namespace String
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 return a 409.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- namespace string
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- annotations Mapping[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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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_ 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 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 Sequence[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 return a 409.
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 Mapping[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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
- managed_
fields Sequence[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 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- namespace str
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
- owner_
references Sequence[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 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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- annotations Map<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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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 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 return a 409.
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 Map<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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
- managed
Fields List<Property Map> - 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- namespace String
Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
- owner
References List<Property Map> - 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 - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
OwnerReference, OwnerReferenceArgs
- 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- Uid string
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- Uid string
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- uid String
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- uid string
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- uid str
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- uid String
- UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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.
SelectableField, SelectableFieldArgs
- Json
Path string - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- Json
Path string - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- json
Path String - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- json
Path string - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- json_
path str - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- json
Path String - jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
ServiceReference, ServiceReferenceArgs
- 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.
port
should 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.
port
should 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 Integer
- port is an optional service port at which the webhook will be contacted.
port
should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- 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.
port
should 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 int
- port is an optional service port at which the webhook will be contacted.
port
should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- 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.
port
should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
ValidationRule, ValidationRuleArgs
- Rule string
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- Field
Path string - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- Message string
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- Message
Expression string - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- Optional
Old boolSelf optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- Reason string
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
- Rule string
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- Field
Path string - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- Message string
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- Message
Expression string - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- Optional
Old boolSelf optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- Reason string
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
- rule String
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- field
Path String - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- message String
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- message
Expression String - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- optional
Old BooleanSelf optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- reason String
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
- rule string
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- field
Path string - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- message string
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- message
Expression string - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- optional
Old booleanSelf optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- reason string
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
- rule str
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- field_
path str - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- message str
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- message_
expression str - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- optional_
old_ boolself optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- reason str
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
- rule String
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The
self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"}If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via
self.field
and field presence can be checked viahas(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible viaself[mapKey]
, map containment can be checked viamapKey in self
and all entries of the map are accessible via CEL macros and functions such asself.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible viaself[i]
and also by macros and functions. If the Rule is scoped to a scalar,self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}The
apiVersion
,kind
,metadata.name
andmetadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form
[a-zA-Z_.-/][a-zA-Z0-9_.-/]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:- Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set':
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - 'map':
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If
rule
makes use of theoldSelf
variable it is implicitly atransition rule
.By default, the
oldSelf
variable is the same type asself
. WhenoptionalOldSelf
is true, theoldSelf
variable is a CEL optional variable whose value() is the same type asself
. See the documentation for theoptionalOldSelf
field for details.Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting
optionalOldSelf
to true.- field
Path String - fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute
foo
under a maptestMap
, the fieldPath could be set to.testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g..testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info. Numeric index of array is not supported. For field name which contains special characters, use['specialName']
to refer the field name. e.g. for attributefoo.34$
appears in a listtestList
, the fieldPath could be set to.testList['foo.34$']
- message String
- Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- message
Expression String - MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- optional
Old BooleanSelf optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled
oldSelf
will be a CEL optional whose value will beNone
if there is no old value, or when the object is initially created.You may check for presence of oldSelf using
oldSelf.hasValue()
and unwrap it after checking usingoldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypesMay not be set unless
oldSelf
is used inrule
.- reason String
- reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
WebhookClientConfig, WebhookClientConfigArgs
- 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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- 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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- 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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- 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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- 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
apiextensions_
k8s_ io.v1. 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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- 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 Property Map
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 ofurl
orservice
must be specified.The
host
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address.Please note that using
localhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
WebhookConversion, WebhookConversionArgs
- Conversion
Review List<string>Versions - conversionReviewVersions is an ordered list of preferred
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - Client
Config WebhookClient Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook
.
- Conversion
Review []stringVersions - conversionReviewVersions is an ordered list of preferred
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - Client
Config WebhookClient Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook
.
- conversion
Review List<String>Versions - conversionReviewVersions is an ordered list of preferred
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - 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
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - client
Config WebhookClient Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook
.
- conversion_
review_ Sequence[str]versions - conversionReviewVersions is an ordered list of preferred
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - client_
config apiextensions_k8s_ io.v1. Webhook Client Config - clientConfig is the instructions for how to call the webhook if strategy is
Webhook
.
- conversion
Review List<String>Versions - conversionReviewVersions is an ordered list of preferred
ConversionReview
versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. - client
Config Property Map - clientConfig is the instructions for how to call the webhook if strategy is
Webhook
.
Package Details
- Repository
- Kubernetes pulumi/pulumi-kubernetes
- License
- Apache-2.0