KubectlRunSettings Class

Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlRunSettings"] class Type type-node

Syntax

public sealed class KubectlRunSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Name Summary
KubectlRunSettings()

Properties

Name Value Summary
AllowMissingTemplateKeys Nullable<bool>
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
Attach Nullable<bool>
--attach If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned.
Cascade Nullable<bool>
--cascade If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true.
Command Nullable<bool>
--command If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default.
DryRun Nullable<bool>
--dry-run If true, only print the object that would be sent, without sending it.
Env string
--env Environment variables to set in the container
Expose Nullable<bool>
--expose If true, a public, external service is created for the container(s) which are run
Filename string
-f, --filename to use to replace the resource.
Force Nullable<bool>
--force Only used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
Generator string
--generator The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list.
GracePeriod Nullable<int>
--grace-period Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).
Hostport Nullable<int>
--hostport The host port mapping for the container port. To demonstrate a single-machine container.
Image string
--image The image for the container to run.
ImagePullPolicy string
--image-pull-policy The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server
Kustomize string
-k, --kustomize Process a kustomization directory. This flag can't be used together with -f or -R.
Labels string
-l, --labels Comma separated labels to apply to the pod(s). Will override previous values.
LeaveStdinOpen Nullable<bool>
--leave-stdin-open If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes.
Limits string
--limits The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges.
Output string
-o, --output Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
Overrides string
--overrides An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
PodRunningTimeout string
--pod-running-timeout The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running
Port string
--port The port that this container exposes. If --expose is true, this is also the port used by the service that is created.
Quiet Nullable<bool>
--quiet If true, suppress prompt messages.
Record Nullable<bool>
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
Recursive Nullable<bool>
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
Replicas string
-r, --replicas Number of replicas to create for this container. Default is 1.
Requests string
--requests The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
Restart string
--restart The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always', for CronJobs `Never`.
Rm Nullable<bool>
--rm If true, delete resources created in this command for attached containers.
SaveConfig Nullable<bool>
--save-config If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
Schedule string
--schedule A schedule in the Cron format the job should be run with.
Serviceaccount string
--serviceaccount Service account to set in the pod spec
ServiceGenerator string
--service-generator The name of the generator to use for creating a service. Only used if --expose is true
ServiceOverrides string
--service-overrides An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true.
Stdin Nullable<bool>
-i, --stdin Keep stdin open on the container(s) in the pod, even if nothing is attached.
Template string
--template Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
Timeout string
--timeout The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
Tty Nullable<bool>
-t, --tty Allocated a TTY for each container in the pod.
Wait Nullable<bool>
--wait If true, wait for resources to be gone before returning. This waits for finalizers.

Extension Methods

Name Value Summary
Dump<KubectlRunSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlRunSettings>(KubectlRunSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlRunSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlRunSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin