This content is part of a third party extension that is not supported by the Cake project.
                        For more information about this extension see Cake.Kubectl.
                            
	
		Summary
             Create and run a particular image in a pod.
            
             
		- Assembly
- Cake.Kubectl .dll 
- Namespace
- Cake.Kubectl 
- Base Types
- 
									- ToolSettings
- AutoToolSettings
 
							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 : AutoToolSettingsExamples
               # Start a nginx pod
               kubectl run nginx --image=nginx
             
               # Start a hazelcast pod and let the container expose port 5701
               kubectl run hazelcast --image=hazelcast/hazelcast --port=5701
             
               # Start a hazelcast pod and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container
               kubectl run hazelcast --image=hazelcast/hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
             
               # Start a hazelcast pod and set labels "app=hazelcast" and "env=prod" in the container
               kubectl run hazelcast --image=hazelcast/hazelcast --labels="app=hazelcast,env=prod"
             
               # Dry run; print the corresponding API objects without creating them
               kubectl run nginx --image=nginx --dry-run=client
             
               # Start a nginx pod, but overload the spec with a partial set of values parsed from JSON
               kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
             
               # Start a busybox pod and keep it in the foreground, don't restart it if it exits
               kubectl run -i -t busybox --image=busybox --restart=Never
             
               # Start the nginx pod using the default command, but use custom arguments (arg1 .. argN) for that command
               kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
             
               # Start the nginx pod using a different command and custom arguments
               kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
             
	Attributes
| Type | Description | 
|---|---|
| Nullable | |
| NullableAttribute | |
| Compiler | 
Constructors
| Name | Summary | 
|---|---|
| KubectlRunSettings | 
Properties
| Name | Value | Summary | 
|---|---|---|
| Allow | Nullable | 
             --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.
              | 
| Annotations | string | 
             --annotations
            
             Annotations to apply to the pod.
              | 
| Attach | Nullable | 
             --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.
              | 
| Command | Nullable | 
             --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 | string | 
             --dry-run
            
             Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.
              | 
| Env | string | 
             --env
            
             Environment variables to set in the container.
              | 
| Expose | Nullable | 
             --expose
            
             If true, create a ClusterIP service associated with the pod.  Requires `--port`.
              | 
| FieldManager | string | 
             --field-manager
            
             Name of the manager used to track field ownership.
              | 
| 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.
              | 
| Labels | string | 
             -l, --labels
            
             Comma separated labels to apply to the pod. Will override previous values.
              | 
| LeaveStdinOpen | Nullable | 
             --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.
              | 
| Output | string | 
             -o, --output
            
             Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, 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.
              | 
| OverrideType | string | 
             --override-type
            
             The method used to override the generated object: json, merge, or strategic.
              | 
| 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.
              | 
| Privileged | Nullable | 
             --privileged
            
             If true, run the container in privileged mode.
              | 
| Quiet | Nullable | 
             -q, --quiet
            
             If true, suppress prompt messages.
              | 
| Restart | string | 
             --restart
            
             The restart policy for this Pod.  Legal values [Always, OnFailure, Never].
              | 
| Rm | Nullable | 
             --rm
            
             If true, delete the pod after it exits.  Only valid when attaching to the container, e.g. with '--attach' or with '-i/--stdin'.
              | 
| SaveConfig | Nullable | 
             --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.
              | 
| ShowManagedFields | Nullable | 
             --show-managed-fields
            
             If true, keep the managedFields when printing objects in JSON or YAML format.
              | 
| Stdin | Nullable | 
             -i, --stdin
            
             Keep stdin open on the container 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].
              | 
| Tty | Nullable | 
             -t, --tty
            
             Allocate a TTY for the container in the pod.
              | 
Extension Methods
| Name | Value | Summary | 
|---|---|---|
| Dump | string | 
             Get a basic string representation of specified object.
              From LoggingExtensions Requires the Cake.Incubator addin | 
| IsIn | bool | 
            Checks if the source is contained in a list
             From EnumerableExtensions Requires the Cake.Incubator addin | 
| NotNull | void | 
            Throws an exception if the specified parameter's value is null.
             From Extensions Requires the Cake.Ftp addin | 
| NotNull | void | 
            Throws an exception if the specified parameter's value is null.
             From IssuesArgumentChecks Requires the Cake.Issues addin | 
| ThrowIfNull | T | 
            Throws a  System.ArgumentNullExceptionwith a specific message if the value is null, otherwise returns the valueFrom AssertExtensions Requires the Cake.Incubator addin | 
| ThrowIfNull | T | 
            Throws a  System.ArgumentNullExceptionif the value is null, otherwise returns the valueFrom AssertExtensions Requires the Cake.Incubator addin | 
| ToDictionary | IDictionary | From ObjectHelpers Requires the Cake.DeployParams addin | 
| To | string | 
            Returns the string value or a  Not set> markup suitable for Spectre.Console.From StringExtensions Requires the Cake.Issues addin | 
