optional - the event name (e.g. `example`)
optional - the event source type (e.g. `webhook`)
AMQPConsumeConfig holds the configuration to immediately starts delivering queued messages +k8s:openapi-gen=true
AutoAck when true, the server will acknowledge deliveries to this consumer prior to writing the delivery to the network +optional
ConsumerTag is the identity of the consumer included in every delivery +optional
Exclusive when true, the server will ensure that this is the sole consumer from this queue +optional
NoLocal flag is not supported by RabbitMQ +optional
NowWait when true, do not wait for the server to confirm the request and immediately begin deliveries +optional
AMQPEventSource refers to an event-source for AMQP stream events
Auth hosts secret selectors for username and password +optional
Backoff holds parameters applied to connection. +optional
Consume holds the configuration to immediately starts delivering queued messages For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume +optional
ExchangeDeclare holds the configuration for the exchange on the server For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare +optional
ExchangeName is the exchange name For more information, visit https://www.rabbitmq.com/tutorials/amqp-concepts.html
ExchangeType is rabbitmq exchange type
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
QueueBind holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind +optional
QueueDeclare holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn't already exist, or ensures that an existing queue matches the same parameters For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare +optional
Routing key for bindings
TLS configuration for the amqp client. +optional
URL for rabbitmq service
URLSecret is secret reference for rabbitmq service URL
AMQPExchangeDeclareConfig holds the configuration for the exchange on the server +k8s:openapi-gen=true
AutoDelete removes the exchange when no bindings are active +optional
Durable keeps the exchange also after the server restarts +optional
Internal when true does not accept publishings +optional
NowWait when true does not wait for a confirmation from the server +optional
AMQPQueueBindConfig holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key +k8s:openapi-gen=true
NowWait false and the queue could not be bound, the channel will be closed with an error +optional
AMQPQueueDeclareConfig holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn't already exist, or ensures that an existing queue matches the same parameters +k8s:openapi-gen=true
Arguments of a queue (also known as "x-arguments") used for optional features and plugins +optional
AutoDelete removes the queue when no consumers are active +optional
Durable keeps the queue also after the server restarts +optional
Exclusive sets the queues to be accessible only by the connection that declares them and will be deleted wgen the connection closes +optional
Name of the queue. If empty the server auto-generates a unique name for this queue +optional
NowWait when true, the queue assumes to be declared on the server +optional
AWSLambdaTrigger refers to specification of the trigger to invoke an AWS Lambda function
AccessKey refers K8s secret containing aws access key +optional
FunctionName refers to the name of the function to invoke.
Choose from the following options.
* RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
* Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.
* DryRun - Validate parameter values and verify that the user or role has permission to invoke the function. +optional
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
Region is AWS region
RoleARN is the Amazon Resource Name (ARN) of the role to assume. +optional
SecretKey refers K8s secret containing aws secret key +optional
Amount represent a numeric amount.
ArgoWorkflowTrigger is the trigger for the Argo Workflow
Operation refers to the type of operation performed on the argo workflow resource. Default value is Submit. +optional
Parameters is the list of parameters to pass to resolved Argo Workflow object
Source of the K8s resource file(s)
ArtifactLocation describes the source location for an external artifact
Configmap that stores the artifact
File artifact is artifact stored in a file
Git repository hosting the artifact
Inline artifact is embedded in sensor spec as a string
Resource is generic template for K8s resource
S3 compliant artifact
URL to fetch the artifact from
AzureEventHubsTrigger refers to specification of the Azure Event Hubs Trigger
FQDN refers to the namespace dns of Azure Event Hubs to be used i.e. <namespace>.servicebus.windows.net
HubName refers to the Azure Event Hub to send events to
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
SharedAccessKey refers to a K8s secret containing the primary key for the
SharedAccessKeyName refers to the name of the Shared Access Key
AzureEventsHubEventSource describes the event source for azure events hub More info at https://docs.microsoft.com/en-us/azure/event-hubs/
Filter +optional
FQDN of the EventHubs namespace you created More info at https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string
Event Hub path/name
SharedAccessKey is the generated value of the key. If both this field and SharedAccessKeyName are not provided it will try to access via Azure AD with DefaultAzureCredential, FQDN and HubName. +optional
SharedAccessKeyName is the name you chose for your application's SAS keys. If both this field and SharedAccessKey are not provided it will try to access via Azure AD with DefaultAzureCredential, FQDN and HubName. +optional
AzureQueueStorageEventSource describes the event source for azure queue storage more info at https://learn.microsoft.com/en-us/azure/storage/queues/
ConnectionString is the connection string to access Azure Queue Storage. If this fields is not provided it will try to access via Azure AD with StorageAccountName. +optional
DecodeMessage specifies if all the messages should be base64 decoded. If set to true the decoding is done before the evaluation of JSONBody +optional
DLQ specifies if a dead-letter queue is configured for messages that can't be processed successfully. If set to true, messages with invalid payload won't be acknowledged to allow to forward them farther to the dead-letter queue. The default value is false. +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
QueueName is the name of the queue
StorageAccountName is the name of the storage account where the queue is. This field is necessary to access via Azure AD (managed identity) and it is ignored if ConnectionString is set. +optional
WaitTimeInSeconds is the duration (in seconds) for which the event source waits between empty results from the queue. The default value is 3 seconds. +optional
AzureServiceBusEventSource describes the event source for azure service bus More info at https://docs.microsoft.com/en-us/azure/service-bus-messaging/
ConnectionString is the connection string for the Azure Service Bus. If this fields is not provided it will try to access via Azure AD with DefaultAzureCredential and FullyQualifiedNamespace. +optional
Filter +optional
FullyQualifiedNamespace is the Service Bus namespace name (ex: myservicebus.servicebus.windows.net). This field is necessary to access via Azure AD (managed identity) and it is ignored if ConnectionString is set. +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
QueueName is the name of the Azure Service Bus Queue
SubscriptionName is the name of the Azure Service Bus Topic Subscription
TLS configuration for the service bus client +optional
TopicName is the name of the Azure Service Bus Topic
ConnectionString is the connection string for the Azure Service Bus
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
QueueName is the name of the Azure Service Bus Queue
SubscriptionName is the name of the Azure Service Bus Topic Subscription
TLS configuration for the service bus client +optional
TopicName is the name of the Azure Service Bus Topic
Backoff for an operation
The initial duration in nanoseconds or strings like "1s", "3m" +optional
Duration is multiplied by factor each iteration +optional
The amount of jitter applied each iteration +optional
Exit with error after this many steps +optional
BasicAuth contains the reference to K8s secrets that holds the username and password
Password refers to the Kubernetes secret that holds the password required for basic auth.
Username refers to the Kubernetes secret that holds the username required for basic auth.
BitbucketAuth holds the different auth strategies for connecting to Bitbucket
Basic is BasicAuth auth strategy. +optional
OAuthToken refers to the K8s secret that holds the OAuth Bearer token. +optional
BitbucketBasicAuth holds the information required to authenticate user via basic auth mechanism
Password refers to the K8s secret that holds the password.
Username refers to the K8s secret that holds the username.
BitbucketEventSource describes the event source for Bitbucket
Auth information required to connect to Bitbucket.
DeleteHookOnFinish determines whether to delete the defined Bitbucket hook once the event source is stopped. +optional
Filter +optional
DeprecatedOwner is the owner of the repository. Deprecated: use Repositories instead. Will be unsupported in v1.9 +optional
DeprecatedProjectKey is the key of the project to which the repository relates Deprecated: use Repositories instead. Will be unsupported in v1.9 +optional
Repositories holds a list of repositories for which integration needs to set up +optional
DeprecatedRepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL Deprecated: use Repositories instead. Will be unsupported in v1.9 +optional
Webhook refers to the configuration required to run an http server
Owner is the owner of the repository
RepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL
BitbucketServerEventSource refers to event-source related to Bitbucket Server events
AccessToken is reference to K8s secret which holds the bitbucket api access information. +optional
BitbucketServerBaseURL is the base URL for API requests to a custom endpoint.
CheckInterval is a duration in which to wait before checking that the webhooks exist, e.g. 1s, 30m, 2h... (defaults to 1m) +optional
DeleteHookOnFinish determines whether to delete the Bitbucket Server hook for the project once the event source is stopped. +optional
Events are bitbucket event to listen to. Refer https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html +optional
Filter +optional
OneEventPerChange controls whether to process each change in a repo:refs_changed webhook event as a separate io.argoproj.workflow.v1alpha1. This setting is useful when multiple tags are pushed simultaneously for the same commit, and each tag needs to independently trigger an action, such as a distinct workflow in Argo Workflows. When enabled, the BitbucketServerEventSource publishes an individual BitbucketServerEventData for each change, ensuring independent processing of each tag or reference update in a single webhook event. +optional
DeprecatedProjectKey is the key of project for which integration needs to set up. Deprecated: use Repositories instead. Will be unsupported in v1.8. +optional
Repositories holds a list of repositories for which integration needs to set up. +optional
DeprecatedRepositorySlug is the slug of the repository for which integration needs to set up. Deprecated: use Repositories instead. Will be unsupported in v1.8. +optional
SkipBranchRefsChangedOnOpenPR bypasses the event repo:refs_changed for branches whenever there's an associated open pull request. This helps in optimizing the event handling process by avoiding unnecessary triggers for branch reference changes that are already part of a pull request under review. +optional
TLS configuration for the bitbucketserver client. +optional
Webhook holds configuration to run a http server.
WebhookSecret is reference to K8s secret which holds the bitbucket webhook secret (for HMAC validation). +optional
ProjectKey is the key of project for which integration needs to set up.
RepositorySlug is the slug of the repository for which integration needs to set up.
CalendarEventSource describes a time based dependency. One of the fields (schedule, interval, or recurrence) must be passed. Schedule takes precedence over interval; interval takes precedence over recurrence
ExclusionDates defines the list of DATE-TIME exceptions for recurring events.
Filter +optional
Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h... +optional
Persistence hold the configuration for event persistence
Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron +optional
Timezone in which to run the schedule +optional
Enabled enables to triggered the missed schedule when eventsource restarts
MaxDuration holds max catchup duration
Condition contains details about resource state
Last time the condition transitioned from one status to another. +optional
Human-readable message indicating details about last transition. +optional
Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. For example, "ImageNotFound" +optional
Condition status, True, False or Unknown. +required
Condition type. +required
Cron is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron
+optional
Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron
CreateIfNotExist will create configmap if it doesn't exists
Name of the configmap
Container defines customized spec for a container
+optional
+optional
+optional
+optional
CustomTrigger refers to the specification of the custom trigger.
CertSecret refers to the secret that contains cert for secure connection between sensor and custom trigger gRPC server.
Parameters is the list of parameters that is applied to resolved custom trigger trigger object.
Secure refers to type of the connection between sensor to custom trigger gRPC
ServerNameOverride for the secure connection between sensor and custom trigger gRPC server.
ServerURL is the url of the gRPC server that executes custom trigger
DataFilter describes constraints and filters for event data Regular Expressions are purposefully not a feature as they are overkill for our uses here See Rob Pike's Post: https://commandcenter.blogspot.com/2011/08/regular-expressions-in-lexing-and.html
Comparator compares the event data with a user given value. Can be ">=", ">", "=", "!=", "<", or "<=". Is optional, and if left blank treated as equality "=".
Path is the JSONPath of the event's (JSON decoded) data key Path is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\'. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
Template is a go-template for extracting a string from the event's data. A Template is evaluated with provided path, type and value. The templating follows the standard go-template syntax as well as sprig's extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/
Type contains the JSON type of the data
EmailTrigger refers to the specification of the email notification trigger.
Body refers to the body/content of the email send. +optional
From refers to the address from which the email is send from. +optional
Host refers to the smtp host url to which email is send.
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
Port refers to the smtp server port to which email is send. Defaults to 0. +optional
SMTPPassword refers to the Kubernetes secret that holds the smtp password used to connect to smtp server. +optional
Subject refers to the subject line for the email send. +optional
Username refers to the username used to connect to the smtp server. +optional
EmitterEventSource describes the event source for emitter More info at https://emitter.io/develop/getting-started/
Broker URI to connect to.
ChannelKey refers to the channel key
ChannelName refers to the channel name
Backoff holds parameters applied to connection. +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
Password to use to connect to broker +optional
TLS configuration for the emitter client. +optional
Username to use to connect to broker +optional
EventContext holds the context of the cloudevent received from an event source. +protobuf.options.(gogoproto.goproto_stringer)=false
DataContentType - A MIME (RFC2046) string describing the media type of `data`.
ID of the event; must be non-empty and unique within the scope of the producer.
Source - A URI describing the event producer.
SpecVersion - The version of the CloudEvents specification used by the io.argoproj.workflow.v1alpha1.
Subject - The subject of the event in the context of the event producer
Time - A Timestamp when the event happened.
Type - The type of the occurrence which has happened.
EventDependency describes a dependency
EventName is the name of the event
EventSourceName is the name of EventSource that Sensor depends on
Filters and rules governing toleration of success and constraints on the context and data of an event
FiltersLogicalOperator defines how different filters are evaluated together. Available values: and (&&), or (||) Is optional and if left blank treated as and (&&).
Name is a unique name of this dependency
Transform transforms the event data
EventDependencyFilter defines filters and constraints for a io.argoproj.workflow.v1alpha1.
Context filter constraints
DataLogicalOperator defines how multiple Data filters (if defined) are evaluated together. Available values: and (&&), or (||) Is optional and if left blank treated as and (&&).
ExprLogicalOperator defines how multiple Exprs filters (if defined) are evaluated together. Available values: and (&&), or (||) Is optional and if left blank treated as and (&&).
Script refers to a Lua script evaluated to determine the validity of an io.argoproj.workflow.v1alpha1.
Time filter on the event with escalation
Catchup enables to triggered the missed schedule when eventsource restarts
ConfigMap holds configmap details for persistence
EventSource is the definition of a eventsource resource +genclient +kubebuilder:resource:shortName=es +kubebuilder:subresource:status +k8s:deepcopy-gen:interfaces=io.k8s.apimachinery/pkg/runtime.Object +k8s:openapi-gen=true
+optional
EventSourceList is the list of eventsource resources +k8s:deepcopy-gen:interfaces=io.k8s.apimachinery/pkg/runtime.Object
EventSourceSpec refers to specification of event-source resource
AzureEventsHub event sources
AzureQueueStorage event source
Azure Service Bus event source
Bitbucket event sources
Bitbucket Server event sources
EventBusName references to a EventBus name. By default the value is "default"
Redis stream source
Replicas is the event source deployment replicas
Service is the specifications of the service to expose the event source +optional
StorageGrid event sources
Template is the pod specification for the event source +optional
EventSourceStatus holds the status of the event-source resource
Expr refers to the expression that determines the outcome of the filter.
FileArtifact contains information about an artifact in a filesystem
FileEventSource describes an event-source for file related events.
Type of file operations to watch Refer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information
Filter +optional
Use polling instead of inotify
WatchPathConfig contains configuration about the file path to watch
GenericEventSource refers to a generic event source. It can be used to implement a custom event source.
AuthSecret holds a secret selector that contains a bearer token for authentication +optional
Config is the event source configuration
Filter +optional
Insecure determines the type of connection.
JSONBody specifies that all event body payload coming from this source will be JSON +optional
URL of the gRPC server that implements the event source.
GerritEventSource refers to event-source related to gerrit events
Auth hosts secret selectors for username and password +optional
DeleteHookOnFinish determines whether to delete the Gerrit hook for the project once the event source is stopped. +optional
Events are gerrit event to listen to. Refer https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events
Filter +optional
GerritBaseURL is the base URL for API requests to a custom endpoint
HookName is the name of the webhook
SslVerify to enable ssl verification +optional
Webhook holds configuration to run a http server
GitArtifact contains information about an artifact stored in git
Branch to use to pull trigger resource +optional
Directory to clone the repository. We clone complete directory because GitArtifact is not limited to any specific Git service providers. Hence we don't use any specific git provider client.
Creds contain reference to git username and password +optional
Path to file that contains trigger resource definition
Whether to ignore host key +optional
Ref to use to pull trigger resource. Will result in a shallow clone and fetch. +optional
Remote to manage set of tracked repositories. Defaults to "origin". Refer https://git-scm.com/docs/git-remote +optional
SSHKeySecret refers to the secret that contains SSH key
Tag to use to pull trigger resource +optional
Git URL
AppID refers to the GitHub App ID for the application you created
InstallationID refers to the Installation ID of the GitHub app you created and installed
PrivateKey refers to a K8s secret containing the GitHub app private key
GithubEventSource refers to event-source for github related events
Active refers to status of the webhook for event deliveries. https://developer.github.com/webhooks/creating/#active +optional
APIToken refers to a K8s secret containing github api token +optional
ContentType of the event delivery
DeleteHookOnFinish determines whether to delete the GitHub hook for the repository once the event source is stopped. +optional
Filter +optional
GitHubApp holds the GitHub app credentials +optional
GitHub base URL (for GitHub Enterprise) +optional
GitHub upload URL (for GitHub Enterprise) +optional
Id is the webhook's id Deprecated: This is not used at all, will be removed in v1.6 +optional
Insecure tls verification
Organizations holds the names of organizations (used for organization level webhooks). Not required if Repositories is set.
DeprecatedOwner refers to GitHub owner name i.e. argoproj Deprecated: use Repositories instead. Will be unsupported in v 1.6 +optional
Repositories holds the information of repositories, which uses repo owner as the key, and list of repo names as the value. Not required if Organizations is set.
DeprecatedRepository refers to GitHub repo name i.e. argo-events Deprecated: use Repositories instead. Will be unsupported in v 1.6 +optional
Webhook refers to the configuration required to run a http server
WebhookSecret refers to K8s secret containing GitHub webhook secret https://developer.github.com/webhooks/securing/ +optional
GitlabEventSource refers to event-source related to Gitlab events
AccessToken references to k8 secret which holds the gitlab api access information
DeleteHookOnFinish determines whether to delete the GitLab hook for the project once the event source is stopped. +optional
EnableSSLVerification to enable ssl verification +optional
Events are gitlab event to listen to. Refer https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794.
Filter +optional
GitlabBaseURL is the base URL for API requests to a custom endpoint
DeprecatedProjectID is the id of project for which integration needs to setup Deprecated: use Projects instead. Will be unsupported in v 1.7 +optional
SecretToken references to k8 secret which holds the Secret Token used by webhook config
Webhook holds configuration to run a http server
HDFSEventSource refers to event-source for HDFS related events
CheckInterval is a string that describes an interval duration to check the directory state, e.g. 1s, 30m, 2h... (defaults to 1m)
Filter +optional
HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
Type of file operations to watch
HTTPTrigger is the trigger for the HTTP request
BasicAuth configuration for the http request. +optional
Method refers to the type of the HTTP request. Refer https://golang.org/src/net/http/method.go for more io.argoproj.workflow.v1alpha1. Default value is POST. +optional
Parameters is the list of key-value extracted from event's payload that are applied to the HTTP trigger resource.
Secure Headers stored in Kubernetes Secrets for the HTTP requests. +optional
Timeout refers to the HTTP request timeout in seconds. Default value is 60 seconds. +optional
TLS configuration for the HTTP client. +optional
URL refers to the URL to send HTTP request to.
K8SResource represent arbitrary structured data.
K8SResourcePolicy refers to the policy used to check the state of K8s based triggers using labels
Backoff before checking resource state
ErrorOnBackoffTimeout determines whether sensor should transition to error state if the trigger policy is unable to determine the state of the resource
The name for the consumer group to use
When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false +optional
Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default. +optional
KafkaEventSource refers to event-source for Kafka related events
Yaml format Sarama config for Kafka connection. It follows the struct of sarama.Config. See https://github.com/IBM/sarama/blob/main/config.go e.g.
consumer: fetch: min: 1 net: MaxOpenRequests: 5
+optional
Backoff holds parameters applied to connection.
Consumer group for kafka client +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
Sets a limit on how many events get read from kafka per second. +optional
Partition name +optional
SASL configuration for the kafka client +optional
TLS configuration for the kafka client. +optional
Topic name
URL to kafka cluster, multiple URLs separated by comma
Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0 +optional
KafkaTrigger refers to the specification of the Kafka trigger.
Compress determines whether to compress message or not. Defaults to false. If set to true, compresses message using snappy compression. +optional
FlushFrequency refers to the frequency in milliseconds to flush batches. Defaults to 500 milliseconds. +optional
Parameters is the list of parameters that is applied to resolved Kafka trigger object.
+optional DEPRECATED
The partitioning key for the messages put on the Kafka topic. +optional.
RequiredAcks used in producer to tell the broker how many replica acknowledgements Defaults to 1 (Only wait for the leader to ack). +optional.
SASL configuration for the kafka client +optional
Schema Registry configuration to producer message with avro format +optional
Secure Headers stored in Kubernetes Secrets for the Kafka messages. +optional
TLS configuration for the Kafka producer. +optional
Name of the topic. More info at https://kafka.apache.org/documentation/#intro_topics
URL of the Kafka broker, multiple URLs separated by comma.
Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0 +optional
Only print messages every interval. Useful to prevent logging too much data for busy events. +optional
MQTTEventSource refers to event-source for MQTT related events
Auth hosts secret selectors for username and password +optional
ClientID is the id of the client
ConnectionBackoff holds backoff applied to connection.
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
TLS configuration for the mqtt client. +optional
Topic name
URL to connect to broker
Metadata holds the annotations and labels of an event source pod
NATSAuth refers to the auth info for NATS EventSource
Baisc auth with username and password +optional
credential used to connect +optional
NKey used to connect +optional
Token used to connect +optional
NATSEventsSource refers to event-source for NATS related events
Auth information +optional
ConnectionBackoff holds backoff applied to connection.
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
Queue is the name of the queue group to subscribe as if specified. Uses QueueSubscribe logic to subscribe as queue group. If the queue is empty, uses default Subscribe logic. +optional
Subject holds the name of the subject onto which messages are published
TLS configuration for the nats client. +optional
URL to connect to NATS cluster
NATSTrigger refers to the specification of the NATS trigger.
AuthInformation +optional
Name of the subject to put message on.
TLS configuration for the NATS producer. +optional
URL of the NATS cluster.
NSQEventSource describes the event source for NSQ PubSub More info at https://godoc.org/github.com/nsqio/go-nsq
Channel used for subscription
Backoff holds parameters applied to connection. +optional
Filter +optional
HostAddress is the address of the host for NSQ lookup
JSONBody specifies that all event body payload coming from this source will be JSON +optional
TLS configuration for the nsq client. +optional
Topic to subscribe to.
OpenWhiskTrigger refers to the specification of the OpenWhisk trigger.
Name of the action/function.
AuthToken for authentication. +optional
Host URL of the OpenWhisk.
Namespace for the action. Defaults to "_". +optional.
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
Version for the API. Defaults to v1. +optional
PayloadField binds a value at path within the event payload against a name.
Name acts as key that holds the value at the path.
Path is the JSONPath of the event's (JSON decoded) data key Path is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\'. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
PubSubEventSource refers to event-source for GCP PubSub related events.
CredentialSecret references to the secret that contains JSON credentials to access GCP. If it is missing, it implicitly uses Workload Identity to access. https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity +optional
DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub subscription once the event source is stopped. +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
ProjectID is GCP project ID for the subscription. Required if you run Argo Events outside of GKE/GCE. (otherwise, the default value is its project) +optional
SubscriptionID is ID of subscription. Required if you use existing subscription. The default value will be auto generated hash based on this eventsource setting, so the subscription might be recreated every time you update the setting, which has a possibility of event loss. +optional
Topic to which the subscription should belongs. Required if you want the eventsource to create a new subscription. If you specify this field along with an existing subscription, it will be verified whether it actually belongs to the specified topic. +optional
TopicProjectID is GCP project ID for the topic. By default, it is same as ProjectID. +optional
PulsarEventSource describes the event source for Apache Pulsar
Authentication athenz parameters for the pulsar client. Refer https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go Either token or athenz can be set to use auth. +optional
Authentication athenz privateKey secret for the pulsar client. AuthAthenzSecret must be set if AuthAthenzParams is used. +optional
Authentication token for the pulsar client. Either token or athenz can be set to use auth. +optional
Backoff holds parameters applied to connection. +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
TLS configuration for the pulsar client. +optional
Whether the Pulsar client accept untrusted TLS certificate from broker. +optional
Trusted TLS certificate secret. +optional
Whether the Pulsar client verify the validity of the host name from broker. +optional
Type of the subscription. Only "exclusive" and "shared" is supported. Defaults to exclusive. +optional
Configure the service URL for the Pulsar service. +required
PulsarTrigger refers to the specification of the Pulsar trigger.
Authentication athenz parameters for the pulsar client. Refer https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go Either token or athenz can be set to use auth. +optional
Authentication athenz privateKey secret for the pulsar client. AuthAthenzSecret must be set if AuthAthenzParams is used. +optional
Authentication token for the pulsar client. Either token or athenz can be set to use auth. +optional
Backoff holds parameters applied to connection. +optional
Parameters is the list of parameters that is applied to resolved Kafka trigger object.
TLS configuration for the pulsar client. +optional
Whether the Pulsar client accept untrusted TLS certificate from broker. +optional
Trusted TLS certificate secret. +optional
Whether the Pulsar client verify the validity of the host name from broker. +optional
Name of the topic. See https://pulsar.apache.org/docs/en/concepts-messaging/
Configure the service URL for the Pulsar service. +required
Defaults to Second
RedisEventSource describes an event source for the Redis PubSub. More info at https://godoc.org/github.com/go-redis/redis#example-PubSub
DB to use. If not specified, default DB 0 will be used. +optional
Filter +optional
HostAddress refers to the address of the Redis host/server
JSONBody specifies that all event body payload coming from this source will be JSON +optional
Namespace to use to retrieve the password from. It should only be specified if password is declared +optional
Password required for authentication if any. +optional
TLS configuration for the redis client. +optional
Username required for ACL style authentication if any. +optional
RedisStreamEventSource describes an event source for Redis streams (https://redis.io/topics/streams-intro)
ConsumerGroup refers to the Redis stream consumer group that will be created on all redis streams. Messages are read through this group. Defaults to 'argo-events-cg' +optional
DB to use. If not specified, default DB 0 will be used. +optional
Filter +optional
HostAddress refers to the address of the Redis host/server (master instance)
MaxMsgCountPerRead holds the maximum number of messages per stream that will be read in each XREADGROUP of all streams Example: if there are 2 streams and MaxMsgCountPerRead=10, then each XREADGROUP may read upto a total of 20 messages. Same as COUNT option in XREADGROUP(https://redis.io/topics/streams-intro). Defaults to 10 +optional
Password required for authentication if any. +optional
TLS configuration for the redis client. +optional
Username required for ACL style authentication if any. +optional
ResourceEventSource refers to a event-source for K8s resource related events.
EventTypes is the list of event type to watch. Possible values are - ADD, UPDATE and DELETE.
Filter is applied on the metadata of the resource If you apply filter, then the internal event informer will only monitor objects that pass the filter. +optional
Group of the resource
Namespace where resource is deployed
ResourceFilter contains K8s ObjectMeta information to further filter resource event objects
If the resource is created after the start time then the event is treated as valid. +optional
If resource is created before the specified time then the event is treated as valid. +optional
Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like "spec.serviceAccountName", and the value could be a string or a regex. Same as K8s field selector, operator "=", "==" and "!=" are supported. +optional
Labels provide listing options to K8s API to watch resource/s. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/ for more io.argoproj.workflow.v1alpha1. Unlike K8s field selector, multiple values are passed as comma separated values instead of list of values. Eg: value: value1,value2. Same as K8s label selector, operator "=", "==", "!=", "exists", "!", "notin", "in", "gt" and "lt" are supported +optional
Prefix filter is applied on the resource name. +optional
S3Artifact contains information about an S3 connection and bucket
SASLConfig refers to SASL configuration for a client
SASLMechanism is the name of the enabled SASL mechanism. Possible values: OAUTHBEARER, PLAIN (defaults to PLAIN). +optional
Password for SASL/PLAIN authentication
User is the authentication identity (authcid) to present for SASL/PLAIN or SASL/SCRAM authentication
SFTPEventSource describes an event-source for sftp related events.
Address sftp address.
Type of file operations to watch Refer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information
Filter +optional
Password required for authentication if any.
PollIntervalDuration the interval at which to poll the SFTP server defaults to 10 seconds +optional
SSHKeySecret refers to the secret that contains SSH key. Key needs to contain private key and public key.
Username required for authentication if any.
WatchPathConfig contains configuration about the file path to watch
SNSEventSource refers to event-source for AWS SNS related events
AccessKey refers K8s secret containing aws access key
Endpoint configures connection to a specific SNS endpoint instead of Amazons servers +optional
Filter +optional
Region is AWS region
RoleARN is the Amazon Resource Name (ARN) of the role to assume. +optional
SecretKey refers K8s secret containing aws secret key
TopicArn
ValidateSignature is boolean that can be set to true for SNS signature verification +optional
Webhook configuration for http server
SQSEventSource refers to event-source for AWS SQS related events
AccessKey refers K8s secret containing aws access key
DLQ specifies if a dead-letter queue is configured for messages that can't be processed successfully. If set to true, messages with invalid payload won't be acknowledged to allow to forward them farther to the dead-letter queue. The default value is false. +optional
Endpoint configures connection to a specific SQS endpoint instead of Amazons servers +optional
Filter +optional
JSONBody specifies that all event body payload coming from this source will be JSON +optional
Queue is AWS SQS queue to listen to for messages
QueueAccountID is the ID of the account that created the queue to monitor +optional
Region is AWS region
RoleARN is the Amazon Resource Name (ARN) of the role to assume. +optional
SecretKey refers K8s secret containing aws secret key
SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token +optional
WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.
SecureHeader refers to HTTP Headers with auth tokens as values
Values can be read from either secrets or configmaps
Selector represents conditional operation to select K8s objects.
Key name
Supported operations like ==, != etc. Defaults to ==. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors for more io.argoproj.workflow.v1alpha1. +optional
Value
Sensor is the definition of a sensor resource +genclient +genclient:noStatus +kubebuilder:resource:shortName=sn +kubebuilder:subresource:status +k8s:deepcopy-gen:interfaces=io.k8s.apimachinery/pkg/runtime.Object +k8s:openapi-gen=true
+optional
SensorList is the list of Sensor resources +k8s:deepcopy-gen:interfaces=io.k8s.apimachinery/pkg/runtime.Object
SensorSpec represents desired sensor state
Dependencies is a list of the events that this sensor is dependent on.
ErrorOnFailedRound if set to true, marks sensor state as `error` if the previous trigger round fails. Once sensor state is set to `error`, no further triggers will be processed.
EventBusName references to a EventBus name. By default the value is "default"
LoggingFields add additional key-value pairs when logging happens +optional
Replicas is the sensor deployment replicas
RevisionHistoryLimit specifies how many old deployment revisions to retain +optional
Template is the pod specification for the sensor +optional
SensorStatus contains information about the status of a sensor.
Service holds the service information eventsource exposes
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional
Metadata sets the pods's metadata, i.e. annotations and labels default={annotations: {}, labels: {}}
SlackEventSource refers to event-source for Slack related events
Filter +optional
Slack App signing secret
Token for URL verification handshake
Webhook holds configuration for a REST endpoint
Icon is the Slack application's icon, e.g. :robot_face: or https://example.com/image.png +optional
Username is the Slack application's username +optional
BroadcastMessageToChannel allows to also broadcast the message from the thread to the channel +optional
MessageAggregationKey allows to aggregate the messages to a thread by some key. +optional
SlackTrigger refers to the specification of the slack notification trigger.
Attachments is a JSON format string that represents an array of Slack attachments according to the attachments API: https://api.slack.com/reference/messaging/attachments . +optional
Blocks is a JSON format string that represents an array of Slack blocks according to the blocks API: https://api.slack.com/reference/block-kit/blocks . +optional
Channel refers to which Slack channel to send Slack message. +optional
Message refers to the message to send to the Slack channel. +optional
Parameters is the list of key-value extracted from event's payload that are applied to the trigger resource. +optional
Sender refers to additional configuration of the Slack application that sends the message. +optional
SlackToken refers to the Kubernetes secret that holds the slack token required to send messages.
Thread refers to additional options for sending messages to a Slack thread. +optional
StandardK8STrigger is the standard Kubernetes resource trigger
LiveObject specifies whether the resource should be directly fetched from K8s instead of being marshaled from the resource artifact. If set to true, the resource artifact must contain the information required to uniquely identify the resource in the cluster, that is, you must specify "apiVersion", "kind" as well as "name" and "namespace" meta data. Only valid for operation type `update` +optional
Operation refers to the type of operation performed on the k8s resource. Default value is Create. +optional
Parameters is the list of parameters that is applied to resolved K8s trigger object.
PatchStrategy controls the K8s object patching strategy when the trigger operation is specified as patch. possible values: "application/json-patch+json" "application/merge-patch+json" "application/strategic-merge-patch+json" "application/apply-patch+yaml". Defaults to "application/merge-patch+json" +optional
Source of the K8s resource file(s)
Status is a common structure which can be used for Status field.
Conditions are the latest available observations of a resource's current state. +optional +patchMergeKey=type +patchStrategy=merge
StorageGridEventSource refers to event-source for StorageGrid related events
APIURL is the url of the storagegrid api.
Auth token for storagegrid api
Name of the bucket to register notifications for.
Filter on object key which caused the notification.
S3 region. Defaults to us-east-1 +optional
TopicArn
Webhook holds configuration for a REST endpoint
StripeEventSource describes the event source for stripe webhook notifications More info at https://stripe.com/docs/webhooks
APIKey refers to K8s secret that holds Stripe API key. Used only if CreateWebhook is enabled. +optional
CreateWebhook if specified creates a new webhook programmatically. +optional
EventFilter describes the type of events to listen to. If not specified, all types of events will be processed. More info at https://stripe.com/docs/api/events/list +optional
Webhook holds configuration for a REST endpoint
TLSConfig refers to TLS configuration for a client.
CACertSecret refers to the secret that contains the CA cert
ClientCertSecret refers to the secret that contains the client cert
ClientKeySecret refers to the secret that contains the client key
If true, skips creation of TLSConfig with certs and creates an empty TLSConfig. (Defaults to false) +optional
Template holds the information of a deployment template
If specified, the pod's scheduling constraints +optional
Container is the main container image to run in the sensor pod +optional
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +optional +patchMergeKey=name +patchStrategy=merge
Metadata sets the pods's metadata, i.e. annotations and labels
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +optional
The priority value. Various system components use this field to find the priority of the EventSource pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ +optional
If specified, indicates the EventSource pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ +optional
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. +optional
ServiceAccountName is the name of the ServiceAccount to use to run sensor pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ +optional
If specified, the pod's tolerations. +optional
TimeFilter describes a window in time. It filters out events that occur outside the time limits. In other words, only events that occur after Start and before Stop will pass this filter.
Start is the beginning of a time window in UTC. Before this time, events for this dependency are ignored. Format is hh:mm:ss.
Stop is the end of a time window in UTC. After or equal to this time, events for this dependency are ignored and Format is hh:mm:ss. If it is smaller than Start, it is treated as next day of Start (e.g.: 22:00:00-01:00:00 means 22:00:00-25:00:00).
Trigger is an action taken, output produced, an event created, a message sent
AtLeastOnce determines the trigger execution semantics. Defaults to false. Trigger execution will use at-most-once semantics. If set to true, Trigger execution will switch to at-least-once semantics. +kubebuilder:default=false +optional
If the trigger fails, it will retry up to the configured number of retries. If the maximum retries are reached and the trigger is set to execute atLeastOnce, the dead letter queue (DLQ) trigger will be invoked if specified. Invoking the dead letter queue trigger helps prevent data loss. +optional
Parameters is the list of parameters applied to the trigger template definition
Policy to configure backoff and execution criteria for the trigger +optional
Rate limit, default unit is Second +optional
Retry strategy, defaults to no retry +optional
Template describes the trigger specification.
TriggerParameter indicates a passed parameter to a service template
Dest is the JSONPath of a resource key. A path is a series of keys separated by a dot. The colon character can be escaped with '.' The -1 key can be used to append a value to an existing array. See https://github.com/tidwall/sjson#path-syntax for more information about how this is used.
Operation is what to do with the existing value at Dest, whether to 'prepend', 'overwrite', or 'append' it.
Src contains a source reference to the value of the parameter from a dependency
TriggerParameterSource defines the source for a parameter from a event event
ContextKey is the JSONPath of the event's (JSON decoded) context key ContextKey is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\'. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
ContextTemplate is a go-template for extracting a string from the event's context. If a ContextTemplate is provided with a ContextKey, the template will be evaluated first and fallback to the ContextKey. The templating follows the standard go-template syntax as well as sprig's extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/
DataKey is the JSONPath of the event's (JSON decoded) data key DataKey is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\'. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
DataTemplate is a go-template for extracting a string from the event's data. If a DataTemplate is provided with a DataKey, the template will be evaluated first and fallback to the DataKey. The templating follows the standard go-template syntax as well as sprig's extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/
DependencyName refers to the name of the dependency. The event which is stored for this dependency is used as payload for the parameterization. Make sure to refer to one of the dependencies you have defined under Dependencies list.
UseRawData indicates if the value in an event at data key should be used without converting to string. When true, a number, boolean, json or string parameter may be extracted. When the field is unspecified, or explicitly false, the behavior is to turn the extracted field into a string. (e.g. when set to true, the parameter 123 will resolve to the numerical type, but when false, or not provided, the string "123" will be resolved) +optional
Value is the default literal value to use for this parameter source This is only used if the DataKey is invalid. If the DataKey is invalid and this is not defined, this param source will produce an error.
TriggerPolicy dictates the policy for the trigger retries
K8SResourcePolicy refers to the policy used to check the state of K8s based triggers using using labels
Status refers to the policy used to check the state of the trigger using response status
TriggerTemplate is the template that describes trigger specification.
ArgoWorkflow refers to the trigger that can perform various operations on an Argo io.argoproj.workflow.v1alpha1. +optional
AWSLambda refers to the trigger designed to invoke AWS Lambda function with with on-the-fly constructable payload. +optional
AzureEventHubs refers to the trigger send an event to an Azure Event Hub. +optional
AzureServiceBus refers to the trigger designed to place messages on Azure Service Bus +optional
Conditions is the conditions to execute the trigger. For example: "(dep01 || dep02) && dep04" +optional
Criteria to reset the conditons +optional
CustomTrigger refers to the trigger designed to connect to a gRPC trigger server and execute a custom trigger. +optional
Email refers to the trigger designed to send an email notification +optional
HTTP refers to the trigger designed to dispatch a HTTP request with on-the-fly constructable payload. +optional
StandardK8STrigger refers to the trigger designed to create or update a generic Kubernetes resource. +optional
Kafka refers to the trigger designed to place messages on Kafka topic. +optional.
Log refers to the trigger designed to invoke log the io.argoproj.workflow.v1alpha1. +optional
Name is a unique name of the action to take.
NATS refers to the trigger designed to place message on NATS subject. +optional.
OpenWhisk refers to the trigger designed to invoke OpenWhisk action. +optional
Pulsar refers to the trigger designed to place messages on Pulsar topic. +optional
Slack refers to the trigger designed to send slack notification message. +optional
URLArtifact contains information about an artifact at an http endpoint.
Path is the complete URL
VerifyCert decides whether the connection is secure or not
ValueFromSource allows you to reference keys from either a Configmap or Secret
Directory to watch for events
Path is relative path of object to watch with respect to the directory
PathRegexp is regexp of relative path of object to watch with respect to the directory
WebhookContext holds a general purpose REST API context
AuthSecret holds a secret selector that contains a bearer token for authentication +optional
REST API endpoint
MaxPayloadSize is the maximum webhook payload size that the server will accept. Requests exceeding that limit will be rejected with "request too large" response. Default value: 1048576 (1MB). +optional
Method is HTTP request method that indicates the desired action to be performed for a given resource. See RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
Port on which HTTP server is listening for incoming events.
ServerCertPath refers the file that contains the cert.
ServerKeyPath refers the file that contains private key
URL is the url of the server.
CalendarEventSource describes an HTTP based EventSource
Filter +optional
Amount represent a numeric amount.
Arguments to a template
Artifacts is the list of artifacts to pass to the template or workflow
Parameters is the list of parameters to pass to the template or workflow
ArtGCStatus maintains state related to ArtifactGC
if this is true, we already checked to see if we need to do it and we don't
have completed Pods been processed? (mapped by Pod name) used to prevent re-processing the Status of a Pod more than once
have Pods been started to perform this strategy? (enables us not to re-process what we've already done)
Artifact indicates an artifact to place at a specified path
Archive controls how the artifact will be saved to the artifact repository.
ArchiveLogs indicates if the container logs should be archived
ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows
Artifactory contains artifactory artifact location details
Azure contains Azure Storage artifact location details
Has this been deleted?
From allows an artifact to reference an artifact from a previous step
FromExpression, if defined, is evaluated to specify the value for the artifact
GCS contains GCS artifact location details
Git contains git artifact location details
GlobalName exports an output artifact to the global scope, making it available as io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX and in workflow.status.outputs.artifacts
HDFS contains HDFS artifact location details
HTTP contains HTTP artifact location details
mode bits to use on this file, must be a value between 0 and 0777. Set when loading input artifacts. It is recommended to set the mode value to ensure the artifact has the expected permissions in your container.
name of the artifact. must be unique within a template's inputs/outputs.
Make Artifacts optional, if Artifacts doesn't generate or exist
OSS contains OSS artifact location details
Path is the container path to the artifact
Plugin contains plugin artifact location details
Raw contains raw artifact location details
If mode is set, apply the permission recursively into the artifact if it is a folder
S3 contains S3 artifact location details
SubPath allows an artifact to be sourced from a subpath within the specified source
ArtifactGC describes how to delete artifacts from completed Workflows - this is embedded into the WorkflowLevelArtifactGC, and also used for individual Artifacts to override that as needed
PodMetadata is an optional field for specifying the Labels and Annotations that should be assigned to the Pod doing the deletion
ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion
Strategy is the strategy to use.
ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files.
ArchiveLogs indicates if the container logs should be archived
Artifactory contains artifactory artifact location details
Azure contains Azure Storage artifact location details
GCS contains GCS artifact location details
Git contains git artifact location details
HDFS contains HDFS artifact location details
HTTP contains HTTP artifact location details
OSS contains OSS artifact location details
Plugin contains plugin artifact location details
Raw contains raw artifact location details
S3 contains S3 artifact location details
ArtifactPaths expands a step from a collection of artifacts
Archive controls how the artifact will be saved to the artifact repository.
ArchiveLogs indicates if the container logs should be archived
ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows
Artifactory contains artifactory artifact location details
Azure contains Azure Storage artifact location details
Has this been deleted?
From allows an artifact to reference an artifact from a previous step
FromExpression, if defined, is evaluated to specify the value for the artifact
GCS contains GCS artifact location details
Git contains git artifact location details
GlobalName exports an output artifact to the global scope, making it available as io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX and in workflow.status.outputs.artifacts
HDFS contains HDFS artifact location details
HTTP contains HTTP artifact location details
mode bits to use on this file, must be a value between 0 and 0777. Set when loading input artifacts. It is recommended to set the mode value to ensure the artifact has the expected permissions in your container.
name of the artifact. must be unique within a template's inputs/outputs.
Make Artifacts optional, if Artifacts doesn't generate or exist
OSS contains OSS artifact location details
Path is the container path to the artifact
Plugin contains plugin artifact location details
Raw contains raw artifact location details
If mode is set, apply the permission recursively into the artifact if it is a folder
S3 contains S3 artifact location details
SubPath allows an artifact to be sourced from a subpath within the specified source
ArtifactRepository represents an artifact repository in which a controller will store its artifacts
ArchiveLogs enables log archiving
Artifactory stores artifacts to JFrog Artifactory
Azure stores artifact in an Azure Storage account
GCS stores artifact in a GCS object store
HDFS stores artifacts in HDFS
OSS stores artifact in a OSS-compliant object store
Plugin stores artifact in a plugin-specific artifact repository
S3 stores artifact in a S3-compliant object store
The name of the config map. Defaults to "artifact-repositories".
The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.
The repository the workflow will use. This maybe empty before v3.1.
The name of the config map. Defaults to "artifact-repositories".
If this ref represents the default artifact repository, rather than a config map.
The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.
The namespace of the config map. Defaults to the workflow's namespace, or the controller's namespace (if found).
ArtifactoryArtifact is the location of an artifactory artifact
PasswordSecret is the secret selector to the repository password
URL of the artifact
UsernameSecret is the secret selector to the repository username
ArtifactoryArtifactRepository defines the controller configuration for an artifactory artifact repository
KeyFormat defines the format of how to store keys and can reference workflow variables.
PasswordSecret is the secret selector to the repository password
RepoURL is the url for artifactory repo.
UsernameSecret is the secret selector to the repository username
AzureArtifact is the location of an Azure Storage artifact
AccountKeySecret is the secret selector to the Azure Blob Storage account access key
Blob is the blob name (i.e., path) in the container where the artifact resides
Container is the container where resources will be stored
Endpoint is the service url associated with an account. It is most likely "https://<ACCOUNT_NAME>.blob.core.windows.net"
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
AzureArtifactRepository defines the controller configuration for an Azure Blob Storage artifact repository
AccountKeySecret is the secret selector to the Azure Blob Storage account access key
BlobNameFormat is defines the format of how to store blob names. Can reference workflow variables
Container is the container where resources will be stored
Endpoint is the service url associated with an account. It is most likely "https://<ACCOUNT_NAME>.blob.core.windows.net"
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
Backoff is a backoff strategy to use within retryStrategy
Cap is a limit on revised values of the duration parameter. If a multiplication by the factor parameter would make the duration exceed the cap then the duration is set to the cap
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
Factor is a factor to multiply the base duration after each failed retry
MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy. It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds. However, when the workflow fails, the pod's deadline is then overridden by maxDuration. This ensures that the workflow does not exceed the specified maximum duration when retries are involved.
BasicAuth describes the secret selectors required for basic authentication
PasswordSecret is the secret selector to the repository password
UsernameSecret is the secret selector to the repository username
Cache is the configuration for the type of cache to be used
ConfigMap sets a ConfigMap-based cache
ClientCertAuth holds necessary information for client authentication via certificates
ClusterWorkflowTemplate is the definition of a workflow template resource in cluster scope
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
ClusterWorkflowTemplateList is list of ClusterWorkflowTemplate resources
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Resources resize policy for the container.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices is the list of block devices to be used by the container.
Pod volumes to mount into the container's filesystem. Cannot be updated.
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
ContainerSetRetryStrategy provides controls on how to retry a container set
Duration is the time between each retry, examples values are "300ms", "1s" or "5m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
Retries is the maximum number of retry attempts for each container. It does not include the first, original attempt; the maximum number of total attempts will be `retries + 1`.
RetryStrategy describes how to retry container nodes if the container set fails. Note that this works differently from the template-level `retryStrategy` as it is a process-level retry that does not create new Pods or containers.
Counter is a Counter prometheus metric
Value is the value of the metric
CreateS3BucketOptions options used to determine automatic automatic bucket-creation process
ObjectLocking Enable object locking
CronWorkflow is the definition of a scheduled workflow resource
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
CronWorkflowList is list of CronWorkflow resources
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
CronWorkflowSpec is the specification of a CronWorkflow
ConcurrencyPolicy is the K8s-style concurrency policy that will be used
FailedJobsHistoryLimit is the number of failed jobs to be kept at a time
v3.6 and after: Schedules is a list of schedules to run the Workflow in Cron format
StartingDeadlineSeconds is the K8s-style deadline that will limit the time a CronWorkflow will be run after its original scheduled time if it is missed.
v3.6 and after: StopStrategy defines if the CronWorkflow should stop scheduling based on a condition
SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time
Suspend is a flag that will stop new CronWorkflows from running if set to true
Timezone is the timezone against which the cron schedule will be calculated, e.g. "Asia/Tokyo". Default is machine's local time.
v3.6 and after: When is an expression that determines if a run should be scheduled.
WorkflowMetadata contains some metadata of the workflow to be run
WorkflowSpec is the spec of the workflow to be run
CronWorkflowStatus is the status of a CronWorkflow
Conditions is a list of conditions the CronWorkflow may have
v3.6 and after: Failed counts how many times child workflows failed
LastScheduleTime is the last time the CronWorkflow was scheduled
v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true
v3.6 and after: Succeeded counts how many times child workflows succeeded
DAGTask represents a node in the graph during DAG execution Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnknownFields) fields.
Arguments are the parameter and artifact arguments to the template
ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified
Dependencies are name of other targets which this depends on
Depends are name of other targets which this depends on
Inline is the template. Template must be empty if this is declared (and vice-versa). Note: As mentioned in the corresponding definition in WorkflowStep, this struct is defined recursively, so we need "x-kubernetes-preserve-unknown-fields: true" in the validation schema.
Name is the name of the target
OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead.
Name of template to execute
TemplateRef is the reference to the template resource to execute.
When is an expression in which the task should conditionally execute
WithItems expands a task into multiple parallel tasks from the items in the list Note: The structure of WithItems is free-form, so we need "x-kubernetes-preserve-unknown-fields: true" in the validation schema.
WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected to be a JSON list.
WithSequence expands a task into a numeric sequence
DAGTemplate is a template subtype for directed acyclic graph templates
This flag is for DAG logic. The DAG logic has a built-in "fail fast" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442
Target are one or more names of targets to execute in a DAG
Data is a data template
Source sources external data into a data template
Transformation applies a set of transformations
DataSource sources external data into a data template
ArtifactPaths is a data transformation that collects a list of artifact paths
Selector (https://github.com/expr-lang/expr) that we must must match the io.argoproj.workflow.v1alpha1. E.g. `payload.message == "test"`
ExecutorConfig holds configurations of an executor container.
ServiceAccountName specifies the service account name of the executor container.
GCSArtifact is the location of a GCS artifact
Bucket is the name of the bucket
Key is the path in the bucket where the artifact resides
ServiceAccountKeySecret is the secret selector to the bucket's service account key
GCSArtifactRepository defines the controller configuration for a GCS artifact repository
Bucket is the name of the bucket
KeyFormat defines the format of how to store keys and can reference workflow variables.
ServiceAccountKeySecret is the secret selector to the bucket's service account key
Gauge is a Gauge prometheus metric
Operation defines the operation to apply with value and the metrics' current value
Realtime emits this metric in real time if applicable
Value is the value to be used in the operation with the metric's current value. If no operation is set, value is the value of the metric MaxLength is an artificial limit to limit CEL validation costs - see note at top of file
GitArtifact is the location of a git artifact
Branch is the branch to fetch when `SingleBranch` is enabled
Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip
DisableSubmodules disables submodules during git clone
InsecureIgnoreHostKey disables SSH strict host key checking during git clone
InsecureSkipTLS disables server certificate verification resulting in insecure HTTPS connections
PasswordSecret is the secret selector to the repository password
Repo is the git repository
Revision is the git commit, tag, branch to checkout
SingleBranch enables single branch clone, using the `branch` parameter
SSHPrivateKeySecret is the secret selector to the repository ssh private key
UsernameSecret is the secret selector to the repository username
HDFSArtifact is the location of an HDFS artifact
Addresses is accessible addresses of HDFS name nodes
DataTransferProtection is the protection level for HDFS data transfer. It corresponds to the dfs.data.transfer.protection configuration in HDFS.
Force copies a file forcibly even if it exists
HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
Path is a file path in HDFS
HDFSArtifactRepository defines the controller configuration for an HDFS artifact repository
Addresses is accessible addresses of HDFS name nodes
DataTransferProtection is the protection level for HDFS data transfer. It corresponds to the dfs.data.transfer.protection configuration in HDFS.
Force copies a file forcibly even if it exists
HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
PathFormat is defines the format of path to store a file. Can reference workflow variables
Body is content of the HTTP Request
BodyFrom is content of the HTTP Request as Bytes
InsecureSkipVerify is a bool when if set to true will skip TLS verification for the HTTP client
Method is HTTP methods for HTTP Request
SuccessCondition is an expression if evaluated to true is considered successful
TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds
URL of the HTTP Request
HTTPBodySource contains the source of the HTTP body.
Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another
Artifact are a list of artifacts passed as inputs
Parameters are a list of parameters passed as inputs MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
Item expands a single workflow step into multiple parallel steps The value of Item can be a map, string, bool, or number
Arguments hold arguments to the template
Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored
Template is the name of the template to execute by the hook
TemplateRef is the reference to the template resource to execute by the hook
A link to another app.
The name of the link, E.g. "Workflow Logs" or "Pod Logs"
"workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs", "workflow-list" or "chat"
Target attribute specifies where a linked document will be opened when a user clicks on a link. E.g. "_blank", "_self". If the target is _blank, it will open in a new tab.
The URL. Can contain "${metadata.namespace}", "${metadata.name}", "${status.startedAt}", "${status.finishedAt}" or any other element in workflow yaml, e.g. "${io.argoproj.workflow.v1alpha1.metadata.annotations.userDefinedKey}"
Artifact contains the artifact to use
MemoizationStatus is the status of this memoized node
Cache is the name of the cache that was used
Hit indicates whether this node was created from a cache entry
Key is the name of the key used for this node's cache
Memoization enables caching for the Outputs of the template
Cache sets and configures the kind of cache
Key is the key to use as the caching key
MaxAge is the maximum age (e.g. "180s", "24h") of an entry that is still considered valid. If an entry is older than the MaxAge, it will be ignored.
Metrics are a list of metrics emitted from a Workflow/Template
Prometheus is a list of prometheus metrics to be emitted MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
Mutex holds Mutex configuration
Database specifies this is database controlled if this is set true
name of the mutex
Namespace is the namespace of the mutex, default: [namespace of workflow]
MutexHolding describes the mutex and the object which is holding it.
Holder is a reference to the object which holds the Mutex. Holding Scenario: 1. Current workflow's NodeID which is holding the lock. e.g: ${NodeID} Waiting Scenario: 1. Current workflow or other workflow NodeID which is holding the lock. e.g: ${WorkflowName}/${NodeID}
Reference for the mutex e.g: ${namespace}/mutex/${mutexName}
MutexStatus contains which objects hold mutex locks, and which objects this workflow is waiting on to release locks.
NodeStatus contains status information about an individual node in the workflow
BoundaryID indicates the node ID of the associated template root node in which this node belongs to
Daemoned tracks whether or not this node was daemoned and need to be terminated
DisplayName is a human readable representation of the node. Unique within a template boundary
EstimatedDuration in seconds.
FailedPodRestarts tracks the number of times the pod for this node was restarted due to infrastructure failures before the main container started.
Time at which this node completed
HostNodeName name of the Kubernetes node on which the Pod is running, if applicable
ID is a unique identifier of a node within the worklow It is implemented as a hash of the node name, which makes the ID deterministic
Inputs captures input parameter values and artifact locations supplied to this template invocation
MemoizationStatus holds information about cached nodes
A human readable message indicating details about why the node is in this condition.
Name is unique name in the node tree used to generate the node ID
NodeFlag tracks some history of node. e.g.) hooked, retried, etc.
OutboundNodes tracks the node IDs which are considered "outbound" nodes to a template invocation. For every invocation of a template, there are nodes which we considered as "outbound". Essentially, these are last nodes in the execution sequence to run, before the template is considered completed. These nodes are then connected as parents to a following step.
In the case of single pod steps (i.e. container, script, resource templates), this list will be nil since the pod itself is already considered the "outbound" node. In the case of DAGs, outbound nodes are the "target" tasks (tasks with no children). In the case of steps, outbound nodes are all the containers involved in the last step group. NOTE: since templates are composable, the list of outbound nodes are carried upwards when a DAG/steps template invokes another DAG/steps template. In other words, the outbound nodes of a template, will be a superset of the outbound nodes of its last children.
Outputs captures output parameter values and artifact locations produced by this template invocation
Phase a simple, high-level summary of where the node is in its lifecycle. Can be used as a state machine. Will be one of these values "Pending", "Running" before the node is completed, or "Succeeded", "Skipped", "Failed", "Error", or "Omitted" as a final state.
PodIP captures the IP of the pod for daemoned steps
Progress to completion
ResourcesDuration is indicative, but not accurate, resource duration. This is populated when the nodes completes.
RestartingPodUID tracks the UID of the pod that is currently being restarted. This prevents duplicate restart attempts when the controller processes the same failed pod multiple times. Cleared when the replacement pod starts running.
Time at which this node started
SynchronizationStatus is the synchronization status of the node
TaskResultSynced is used to determine if the node's output has been received
TemplateName is the template name which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)
TemplateRef is the reference to the template resource which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)
TemplateScope is the template scope in which the template of this node was retrieved.
Type indicates type of node
NodeSynchronizationStatus stores the status of a node
Waiting is the name of the lock that this node is waiting for
NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately.
OAuth2Auth holds all information for client authentication via OAuth2 tokens
OSSArtifact is the location of an Alibaba Cloud OSS artifact
AccessKeySecret is the secret selector to the bucket's access key
Bucket is the name of the bucket
CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist
Endpoint is the hostname of the bucket endpoint
Key is the path in the bucket where the artifact resides
LifecycleRule specifies how to manage bucket's lifecycle
SecretKeySecret is the secret selector to the bucket's secret key
SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
OSSArtifactRepository defines the controller configuration for an OSS artifact repository
AccessKeySecret is the secret selector to the bucket's access key
Bucket is the name of the bucket
CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist
Endpoint is the hostname of the bucket endpoint
KeyFormat defines the format of how to store keys and can reference workflow variables.
LifecycleRule specifies how to manage bucket's lifecycle
SecretKeySecret is the secret selector to the bucket's secret key
SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
OSSLifecycleRule specifies how to manage bucket's lifecycle
MarkDeletionAfterDays is the number of days before we delete objects in the bucket
MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type
Outputs hold parameters, artifacts, and results from a step
Artifacts holds the list of output artifacts produced by a step
ExitCode holds the exit code of a script template
Parameters holds the list of output parameters produced by a step
Result holds the result (stdout) of a script or container template, or the response body of an HTTP template
Parameter indicate a passed string parameter to a service template with an optional default value
Default is the default value to use for an input parameter if a value was not supplied
Description is the parameter description
GlobalName exports an output parameter to the global scope, making it available as io.argoproj.workflow.v1alpha1.outputs.parameters.XXXX and in workflow.status.outputs.parameters
Name is the parameter name
Value is the literal value to use for the parameter. If specified in the context of an input parameter, any passed values take precedence over the specified value
ValueFrom is the source for the output parameter's value
Plugin is an Object with exactly one key
PluginArtifact is the location of a plugin artifact
Configuration is the plugin defined configuration for the artifact driver plugin
ConnectionTimeoutSeconds is the timeout for the artifact driver connection, overriding the driver's timeout
Key is the path in the artifact repository where the artifact resides
Name is the name of the artifact driver plugin
PluginArtifactRepository defines the controller configuration for a plugin artifact repository
PodGC describes how to delete completed pods as they complete
DeleteDelayDuration specifies the duration before pods in the GC queue get deleted.
LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue.
Strategy is the strategy to use. One of "OnPodCompletion", "OnPodSuccess", "OnWorkflowCompletion", "OnWorkflowSuccess". If unset, does not delete Pods
Prometheus is a prometheus metric to be emitted
Counter is a counter metric
Gauge is a gauge metric
Help is a string that describes the metric
Histogram is a histogram metric
Name is the name of the metric
When is a conditional statement that decides when to emit the metric
RawArtifact allows raw string content to be placed as an artifact in a container
Data is the string contents of the artifact
ResourceTemplate is a template subtype to manipulate kubernetes resources
Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch
FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed
Manifest contains the kubernetes manifest
ManifestFrom is the source for a single kubernetes manifest
MergeStrategy is the strategy used to merge a patch. It defaults to "strategic" Must be one of: strategic, merge, json
SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource.
SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step
RetryAffinity prevents running steps on the same host.
RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses "kubernetes.io/hostname".
RetryStrategy provides controls on how to retry a workflow step
Affinity prevents running workflow's step on the same host
Backoff is a backoff strategy
Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored
Limit is the maximum number of retry attempts when retrying a container. It does not include the original container; the maximum number of total attempts will be `limit + 1`.
RetryPolicy is a policy of NodePhase statuses that will be retried
S3Artifact is the location of an S3 artifact
AccessKeySecret is the secret selector to the bucket's access key
Bucket is the name of the bucket
CASecret specifies the secret that contains the CA, used to verify the TLS connection
CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.
Endpoint is the hostname of the bucket endpoint
Insecure will connect to the service with TLS
Key is the key in the bucket where the artifact resides
Region contains the optional bucket region
RoleARN is the Amazon Resource Name (ARN) of the role to assume.
SecretKeySecret is the secret selector to the bucket's secret key
SessionTokenSecret is used for ephemeral credentials like an IAM assume role or S3 access grant
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
S3ArtifactRepository defines the controller configuration for an S3 artifact repository
AccessKeySecret is the secret selector to the bucket's access key
Bucket is the name of the bucket
CASecret specifies the secret that contains the CA, used to verify the TLS connection
CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.
Endpoint is the hostname of the bucket endpoint
Insecure will connect to the service with TLS
KeyFormat defines the format of how to store keys and can reference workflow variables.
KeyPrefix is prefix used as part of the bucket key in which the controller will store artifacts. DEPRECATED. Use KeyFormat instead
Region contains the optional bucket region
RoleARN is the Amazon Resource Name (ARN) of the role to assume.
SecretKeySecret is the secret selector to the bucket's secret key
SessionTokenSecret is used for ephemeral credentials like an IAM assume role or S3 access grant
UseSDKCreds tells the driver to figure out credentials based on sdk defaults.
S3EncryptionOptions used to determine encryption options during s3 operations
EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used
KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information
KMSKeyId tells the driver to encrypt the object using the specified KMS Key.
ServerSideCustomerKeySecret tells the driver to encrypt the output artifacts using SSE-C with the specified secret.
ScriptTemplate is a template subtype to enable scripting through code steps
Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Resources resize policy for the container.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Source contains the source code of the script to execute
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices is the list of block devices to be used by the container.
Pod volumes to mount into the container's filesystem. Cannot be updated.
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
Semaphore stores the semaphore name.
SemaphoreRef is a reference of Semaphore
ConfigMapKeyRef is a configmap selector for Semaphore configuration
SyncDatabaseRef is a database reference for Semaphore configuration
Namespace is the namespace of the configmap, default: [namespace of workflow]
Sequence expands a workflow step into numeric range
Count is number of elements in the sequence (default: 0). Not to be used with end
Number at which to end the sequence (default: 0). Not to be used with Count
Format is a printf format string to format the value in the sequence
Number at which to start the sequence (default: 0)
StopStrategy defines if the CronWorkflow should stop scheduling based on an expression. v3.6 and after
v3.6 and after: Expression is an expression that stops scheduling workflows when true. Use the variables `cronworkflow`.`failed` or `cronworkflow`.`succeeded` to access the number of failed or successful child workflows.
Arguments extracted from the event and then set as arguments to the workflow created.
Metadata optional means to customize select fields of the workflow metadata
WorkflowTemplateRef the workflow template to submit
SubmitOpts are workflow submission options
Annotations adds to metadata.labels
DryRun validates the workflow on the client-side without creating it. This option is not supported in API
Entrypoint overrides spec.entrypoint
GenerateName overrides metadata.generateName
Labels adds to metadata.labels
Name overrides metadata.name
OwnerReference creates a metadata.ownerReference
Parameters passes input parameters to workflow
Set the podPriorityClassName of the workflow
Priority is used if controller is configured to process limited number of workflows in parallel, higher priority workflows are processed first.
ServerDryRun validates the workflow on the server-side without creating it
ServiceAccount runs all pods in the workflow using specified ServiceAccount.
SuppliedValueFrom is a placeholder for a value to be filled in directly, either through the CLI, API, etc.
SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time
Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"
Synchronization holds synchronization lock configuration
v3.6 and after: Semaphores holds the list of Semaphores configuration
SynchronizationStatus stores the status of semaphore and mutex.
Mutex stores this workflow's mutex holder details
Semaphore stores this workflow's Semaphore holder details
TTLStrategy is the strategy for the time to live depending on if the workflow succeeded or failed
SecondsAfterCompletion is the number of seconds to live after completion
SecondsAfterFailure is the number of seconds to live after failure
SecondsAfterSuccess is the number of seconds to live after success
TarStrategy will tar and gzip the file or directory when saving
CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression.
Template is a reusable and composable unit of execution in a workflow
Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.
Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)
Annotations is a list of annotations to add to the template at runtime
Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the <workflowname>/<nodename> in the key.
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.
Container is the main container image to run in the pod
ContainerSet groups multiple containers within a single pod.
Daemon will allow a workflow to proceed to the next step so long as the container reaches readiness
DAG template subtype which runs a DAG
Data is a data template
Executor holds configurations of the executor container.
FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this template is expanded with `withItems`, etc.
HostAliases is an optional list of hosts and IPs that will be injected into the pod spec
HTTP makes a HTTP request
InitContainers is a list of containers which run before the main container.
Inputs describe what inputs parameters and artifacts are supplied to this template
Memoize allows templates to use outputs generated from already executed templates
Metadata sets the pods's metadata, i.e. annotations and labels
Metrics are a list of metrics emitted from this template
Name is the name of the template
NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level.
Outputs describe the parameters and artifacts that this template produces
Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total.
Plugin is a plugin template Note: the structure of a plugin template is free-form, so we need to have "x-kubernetes-preserve-unknown-fields: true" in the validation schema.
PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).
PriorityClassName to apply to workflow pods.
Resource template subtype which can run k8s resources
RetryStrategy describes how to retry a template when it fails
If specified, the pod will be dispatched by specified scheduler. Or it will be dispatched by workflow scope scheduler if specified. If neither specified, the pod will be dispatched by default scheduler.
Script runs a portion of code against an interpreter
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
ServiceAccountName to apply to workflow pods
Suspend template subtype which can suspend a workflow when reaching the step
Synchronization holds synchronization lock configuration for this template
Timeout allows to set the total node execution timeout duration counting from the node's start time. This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates.
Tolerations to apply to workflow pods.
TemplateRef is a reference of template resource.
ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).
Name is the resource name of the template.
Template is the name of referred template in the resource.
Expression defines an expr expression to apply
DEPRECATED: This field is ignored.
UserContainer is a container specified by a user.
Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
MirrorVolumeMounts will mount the same volumes specified in the main container to the container (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Resources resize policy for the container.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices is the list of block devices to be used by the container.
Pod volumes to mount into the container's filesystem. Cannot be updated.
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
ValueFrom describes a location in which to obtain the value to a parameter
ConfigMapKeyRef is configmap selector for input parameter configuration
Default specifies a value to be used if retrieving the value from the specified source fails
Selector (https://github.com/expr-lang/expr) that is evaluated against the event to get the value of the parameter. E.g. `payload.message`
Expression, if defined, is evaluated to specify the value for the parameter
JQFilter expression against the resource object in resource templates
JSONPath of a resource to retrieve an output parameter value from in resource templates
Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. steps.mystep.outputs.myparam)
Path in the container to retrieve an output parameter value from in container templates
Supplied value to be filled in directly, either through the CLI, API, etc.
VolumeClaimGC describes how to delete volumes from completed Workflows
Strategy is the strategy to use. One of "OnWorkflowCompletion", "OnWorkflowSuccess". Defaults to "OnWorkflowSuccess"
Workflow is the definition of a workflow resource
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
This field is no longer used.
WorkflowEventBinding is the definition of an event resource
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
WorkflowEventBindingList is list of event resources
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
WorkflowLevelArtifactGC describes how to delete artifacts from completed Workflows - this spec is used on the Workflow level
ForceFinalizerRemoval: if set to true, the finalizer will be removed in the case that Artifact GC fails
PodMetadata is an optional field for specifying the Labels and Annotations that should be assigned to the Pod doing the deletion
PodSpecPatch holds strategic merge patch to apply against the artgc pod spec.
ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion
Strategy is the strategy to use.
WorkflowList is list of Workflow resources
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
WorkflowSpec is the specification of a Workflow.
Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the io.argoproj.workflow.v1alpha1. A value of zero is used to terminate a Running workflow
Affinity sets the scheduling constraints for all pods in the io.argoproj.workflow.v1alpha1. Can be overridden by an affinity specified in the template
ArchiveLogs indicates if the container logs should be archived
Arguments contain the parameters and artifacts sent to the workflow entrypoint Parameters are referencable globally using the 'workflow' variable prefix. e.g. io.argoproj.workflow.v1alpha1.parameters.myparam
ArtifactGC describes the strategy to use when deleting artifacts from completed or deleted workflows (applies to all output Artifacts unless Artifact.ArtifactGC is specified, which overrides this)
ArtifactRepositoryRef specifies the configMap name and key containing the artifact repository config.
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
Set DNS policy for workflow pods. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1.
Executor holds configurations of executor containers of the io.argoproj.workflow.v1alpha1.
Host networking requested for this workflow pod. Default to false.
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
Metrics are a list of metrics emitted from this Workflow
NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template.
OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary io.argoproj.workflow.v1alpha1.
Parallelism limits the max total parallel pods that can execute at the same time in a workflow
PodDisruptionBudget holds the number of concurrent disruptions that you allow for Workflow's Pods. Controller will automatically add the selector with workflow name, if selector is empty. Optional: Defaults to empty.
PodGC describes the strategy to use when deleting completed pods
PodMetadata defines additional metadata that should be applied to workflow pods
PriorityClassName to apply to workflow pods.
PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).
Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.
RetryStrategy for all templates in the io.argoproj.workflow.v1alpha1.
Set scheduler name for all pods. Will be overridden if container/script template's scheduler name is set. Default scheduler will be used if neither specified.
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.
Shutdown will shutdown the workflow according to its ShutdownStrategy
Suspend will suspend the workflow and prevent execution of any future steps in the workflow
Synchronization holds synchronization lock configuration for this Workflow
TemplateDefaults holds default template values that will apply to all templates in the Workflow, unless overridden on the template-level
Templates is a list of workflow templates used in a workflow MaxItems is an artificial limit to limit CEL validation costs - see note at top of file
Tolerations to apply to workflow pods.
TTLStrategy limits the lifetime of a Workflow that has finished execution depending on if it Succeeded or Failed. If this struct is set, once the Workflow finishes, it will be deleted after the time to live expires. If this field is unset, the controller config map will hold the default values.
VolumeClaimGC describes the strategy to use when deleting volumes from completed workflows
VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow
WorkflowMetadata contains some metadata of the workflow to refer to
WorkflowTemplateRef holds a reference to a WorkflowTemplate for execution
WorkflowStatus contains overall status information about a workflow
ArtifactGCStatus maintains the status of Artifact Garbage Collection
ArtifactRepositoryRef is used to cache the repository to use so we do not need to determine it everytime we reconcile.
Compressed and base64 decoded Nodes map
Conditions is a list of conditions the Workflow may have
EstimatedDuration in seconds.
Time at which this workflow completed
A human readable message indicating details about why the workflow is in this condition.
Whether on not node status has been offloaded to a database. If exists, then Nodes and CompressedNodes will be empty. This will actually be populated with a hash of the offloaded data.
Outputs captures output values and artifact locations produced by the workflow via global outputs
PersistentVolumeClaims tracks all PVCs that were created as part of the io.argoproj.workflow.v1alpha1. The contents of this list are drained at the end of the workflow.
Phase a simple, high-level summary of where the workflow is in its lifecycle. Will be "" (Unknown), "Pending", or "Running" before the workflow is completed, and "Succeeded", "Failed" or "Error" once the workflow has completed.
Progress to completion
ResourcesDuration is the total for the workflow
Time at which this workflow started
StoredTemplates is a mapping between a template ref and the node's status.
StoredWorkflowSpec stores the WorkflowTemplate spec for future execution.
Synchronization stores the status of synchronization locks
TaskResultsCompletionStatus tracks task result completion status (mapped by node ID). Used to prevent premature archiving and garbage collection.
WorkflowStep is a reference to a template to execute in a series of step Note: CEL validation cannot check withItems (Schemaless) or inline (PreserveUnknownFields) fields.
Arguments hold arguments to the template
ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified
Inline is the template. Template must be empty if this is declared (and vice-versa). Note: This struct is defined recursively, since the inline template can potentially contain steps/DAGs that also has an "inline" field. Kubernetes doesn't allow recursive types, so we need "x-kubernetes-preserve-unknown-fields: true" in the validation schema.
Name of the step
OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead.
Template is the name of the template to execute as the step
TemplateRef is the reference to the template resource to execute as the step.
When is an expression in which the step should conditionally execute
WithItems expands a step into multiple parallel steps from the items in the list Note: The structure of WithItems is free-form, so we need "x-kubernetes-preserve-unknown-fields: true" in the validation schema.
WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected to be a JSON list.
WithSequence expands a step into a numeric sequence
WorkflowTemplate is the definition of a workflow template resource
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
WorkflowTemplateList is list of WorkflowTemplate resources
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
WorkflowTemplateRef is a reference to a WorkflowTemplate resource.
ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).
Name is the resource name of the workflow template.
DEPRECATED: This field is ignored.
ZipStrategy will unzip zipped input artifacts
Represents a Persistent Disk resource in AWS.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
Affinity is a group of affinity scheduling rules.
Describes node affinity scheduling rules for the pod.
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
AppArmorProfile defines a pod or container's AppArmor settings.
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
cachingMode is the Host Caching mode: None, Read Only, Read Write.
diskName is the Name of the data disk in the blob storage
diskURI is the URI of data disk in the blob storage
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName is the name of secret that contains Azure Storage Account Name and Key
shareName is the azure share Name
Represents a source location of a volume to mount, managed by an external CSI driver
driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
Relative path from the volume root to write the bundle.
Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the ConfigMap must be defined
Selects a key from a ConfigMap.
The key to select.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the ConfigMap or its key must be defined
Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional specify whether the ConfigMap or its keys must be defined
Adapts a ConfigMap into a volume.
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional specify whether the ConfigMap or its keys must be defined
A single application container that you want to run within a pod.
Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Resources resize policy for the container.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices is the list of block devices to be used by the container.
Pod volumes to mount into the container's filesystem. Cannot be updated.
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
ContainerPort represents a network port in a single container.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
ContainerResizePolicy represents resource resize policy for the container.
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
DownwardAPIVolumeFile represents information to create the file containing the pod field
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
EnvFromSource represents the source of a set of ConfigMaps or Secrets
The ConfigMap to select from
Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
The Secret to select from
EnvVar represents an environment variable present in a Container.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
Source for the environment variable's value. Cannot be used if value is not empty.
EnvVarSource represents a source for the value of an EnvVar.
Selects a key of a ConfigMap.
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Selects a key of a secret in the pod's namespace
Represents an ephemeral volume that is handled by a normal storage driver.
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
What action was taken/failed regarding to the Regarding object.
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
The number of times this event has occurred.
Time when this Event was first observed.
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
The object that this event is about.
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
The time at which the most recent occurrence of this event was recorded.
A human-readable description of the status of this operation.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
Optional secondary object for more complex actions.
Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
ID of the controller instance, e.g. `kubelet-xyzf`.
Data about the Event series this event represents or nil if it's a singleton Event.
The component reporting this event. Should be a short machine understandable string.
Type of this event (Normal, Warning), new types could be added in the future
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
Number of occurrences in this series up to the last heartbeat time
Time of the last occurrence observed
EventSource contains information for an event.
Component from which the event is generated.
Node name on which the event is generated.
ExecAction describes a "run in container" action.
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lun is Optional: FC target lun number
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs is Optional: FC target worldwide names (WWNs)
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
driver is the name of the driver to use for this volume.
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
Represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
GRPCAction specifies an action involving a GRPC service.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository is the URL
revision is the commit hash for the specified revision.
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
HTTPGetAction describes an action based on HTTP Get requests.
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
Custom headers to set in the request. HTTP allows repeated headers.
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
Scheme to use for connecting to the host. Defaults to HTTP.
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
Hostnames for the above IP address.
IP address of the host file entry.
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSession defines whether support iSCSI Session CHAP authentication
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn is the target iSCSI Qualified Name.
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun represents iSCSI Target Lun number.
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef is the CHAP Secret for iSCSI target and initiator authentication
targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
ImageVolumeSource represents a image volume resource.
Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
Maps a string key to a path within a volume.
key is the key to project.
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
Exec specifies a command to execute in the container.
HTTPGet specifies an HTTP GET request to perform.
Sleep represents a duration that the container should sleep.
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation
status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Node affinity is a group of node affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
Required. A list of node selector terms. The terms are ORed.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
The label key that the selector applies to.
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
A list of node selector requirements by node's labels.
A list of node selector requirements by node's fields.
ObjectFieldSelector selects an APIVersioned field of an object.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
ObjectReference contains enough information to let you inspect or modify the referred object.
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
PersistentVolumeClaim is a user's request for and claim to a persistent volume
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
PersistentVolumeClaimCondition contains details about state of pvc
lastProbeTime is the time we probed the condition.
lastTransitionTime is the time the condition transitioned from one status to another.
message is the human-readable message indicating details about last transition.
reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.
Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector is a label query over volumes to consider for binding.
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName is the binding reference to the PersistentVolume backing this claim.
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.
ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC.
A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.
Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.
A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
phase represents the current phase of PersistentVolumeClaim.
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
Represents a Photon Controller persistent disk resource.
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
pdID is the ID that identifies Photon Controller persistent disk
Pod affinity is a group of inter pod affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
PortworxVolumeSource represents a Portworx volume resource.
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID uniquely identifies a Portworx volume
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
A node selector term, associated with the corresponding weight.
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Exec specifies a command to execute in the container.
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
GRPC specifies a GRPC HealthCheckRequest.
HTTPGet specifies an HTTP GET request to perform.
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
TCPSocket specifies a connection to a TCP port.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Represents a projected volume source
defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
group to map volume access to Default is no group
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
user to map volume access to Defaults to serivceaccount user
volume is a string that references an already created Quobyte volume by name.
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
ResourceClaim references one entry in PodSpec.ResourceClaims.
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
ResourceFieldSelector represents container resources (cpu, memory) and their output format
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
ResourceRequirements describes the compute resource requirements.
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
SELinuxOptions are the labels to be applied to the container
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
ScaleIOVolumeSource represents a persistent ScaleIO volume
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
gateway is the host address of the ScaleIO API Gateway.
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled Flag enable/disable SSL communication with Gateway, default false
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool is the ScaleIO Storage Pool associated with the protection domain.
system is the name of the storage system as configured in ScaleIO.
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret must be defined
SecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Specify whether the Secret or its key must be defined
Adapts a secret into a projected volume.
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional field specify whether the Secret or its key must be defined
Adapts a Secret into a volume.
The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optional field specify whether the Secret or its keys must be defined
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).
audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path is the path relative to the mount point of the file to project the token into.
ServicePort contains information on service's port.
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
The port that will be exposed by this service.
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
SleepAction describes a "sleep" action.
Seconds is the number of seconds to sleep.
Represents a StorageOS persistent volume resource.
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
TCPSocketAction describes an action based on opening a socket
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
Kind is the type of resource being referenced
Name is the name of resource being referenced
TypedObjectReference contains enough information to let you locate the typed referenced object
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
Kind is the type of resource being referenced
Name is the name of resource being referenced
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
Volume represents a named volume in a pod that may be accessed by any container in the pod.
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
configMap represents a configMap that should populate this volume
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
downwardAPI represents downward API about the pod that should populate this volume
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).
Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.
A pod can use both types of ephemeral volumes and persistent volumes at the same time.
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
projected items for all in one resources secrets, configmaps, and downward API
quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
volumeDevice describes a mapping of a raw block device within a container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
VolumeMount describes a mounting of a Volume within a container.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file.
Alpha, gated by the ClusterTrustBundleProjection feature gate.
ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.
Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
configMap information about the configMap data to project
downwardAPI information about the downwardAPI data to project
secret information about the secret data to project
serviceAccountToken is information about the serviceAccountToken data to project
VolumeResourceRequirements describes the storage resource requirements for a volume.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Represents a vSphere volume resource.
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
volumePath is the path that identifies vSphere volume vmdk
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
Required. A pod affinity term, associated with the corresponding weight.
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
WindowsSecurityContextOptions contain Windows-specific options and credentials.
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True".
Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.
IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.
AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.
Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.
The serialization format is:
``` <quantity> ::= <signedNumber><suffix>
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)
<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
<decimalSI> ::= m | "" | k | M | G | T | P | E
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> ```
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:
- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.
The sign will be omitted unless the number is negative.
Examples:
- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"
Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)
This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
CreateOptions may be provided when creating an API object.
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional +listType=atomic
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +optional
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. +optional
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
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.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
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 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 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.
MicroTime is version of Time with microsecond level precision.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
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
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
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.
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
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.
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
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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
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 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 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
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.
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
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
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 contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
API version of the referent.
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.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
structured log entry
optional - trigger dependency name
optional - Cloud Event context
optional - any trigger name
structured log entry