rkubectl-app 0.0.0-alpha.5

The application logic for rkubectl, a Kubernetes CLI tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use super::*;

// Debug cluster resources using interactive debugging containers.

//  'debug' provides automation for common debugging tasks for cluster objects identified by resource and name. Pods will
// be used by default if no resource is specified.

//  The action taken by 'debug' varies depending on what resource is specified. Supported actions include:

//   *  Workload: Create a copy of an existing pod with certain attributes changed, for example changing the image tag to a
// new version.
//   *  Workload: Add an ephemeral container to an already running pod, for example to add debugging utilities without
// restarting the pod.
//   *  Node: Create a new pod that runs in the node's host namespaces and can access the node's filesystem.

//  Note: When a non-root user is configured for the entire target Pod, some capabilities granted by debug profile may not
// work.

// Examples:
//   # Create an interactive debugging session in pod mypod and immediately attach to it.
//   kubectl debug mypod -it --image=busybox

//   # Create an interactive debugging session for the pod in the file pod.yaml and immediately attach to it.
//   # (requires the EphemeralContainers feature to be enabled in the cluster)
//   kubectl debug -f pod.yaml -it --image=busybox

//   # Create a debug container named debugger using a custom automated debugging image.
//   kubectl debug --image=myproj/debug-tools -c debugger mypod

//   # Create a copy of mypod adding a debug container and attach to it
//   kubectl debug mypod -it --image=busybox --copy-to=my-debugger

//   # Create a copy of mypod changing the command of mycontainer
//   kubectl debug mypod -it --copy-to=my-debugger --container=mycontainer -- sh

//   # Create a copy of mypod changing all container images to busybox
//   kubectl debug mypod --copy-to=my-debugger --set-image=*=busybox

//   # Create a copy of mypod adding a debug container and changing container images
//   kubectl debug mypod -it --copy-to=my-debugger --image=debian --set-image=app=app:debug,sidecar=sidecar:debug

//   # Create an interactive debugging session on a node and immediately attach to it.
//   # The container will run in the host namespaces and the host's filesystem will be mounted at /host
//   kubectl debug node/mynode -it --image=busybox

// Options:
//     --arguments-only=false:
// 	If specified, everything after -- will be passed to the new container as Args instead of Command.

//     --attach=false:
// 	If true, wait for the container to start running, and then attach as if 'kubectl attach ...' were called.
// 	Default false, unless '-i/--stdin' is set, in which case the default is true.

//     -c, --container='':
// 	Container name to use for debug container.

//     --copy-to='':
// 	Create a copy of the target Pod with this name.

//     --custom='':
// 	Path to a JSON or YAML file containing a partial container spec to customize built-in debug profiles.

//     --env=[]:
// 	Environment variables to set in the container.

//     -f, --filename=[]:
// 	identifying the resource to debug

//     --image='':
// 	Container image to use for debug container.

//     --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.

//     --keep-annotations=false:
// 	If true, keep the original pod annotations.(This flag only works when used with '--copy-to')

//     --keep-init-containers=true:
// 	Run the init containers for the pod. Defaults to true.(This flag only works when used with '--copy-to')

//     --keep-labels=false:
// 	If true, keep the original pod labels.(This flag only works when used with '--copy-to')

//     --keep-liveness=false:
// 	If true, keep the original pod liveness probes.(This flag only works when used with '--copy-to')

//     --keep-readiness=false:
// 	If true, keep the original pod readiness probes.(This flag only works when used with '--copy-to')

//     --keep-startup=false:
// 	If true, keep the original startup probes.(This flag only works when used with '--copy-to')

//     --profile='legacy':
// 	Options are "legacy", "general", "baseline", "netadmin", "restricted" or "sysadmin".

//     -q, --quiet=false:
// 	If true, suppress informational messages.

//     --replace=false:
// 	When used with '--copy-to', delete the original Pod.

//     --same-node=false:
// 	When used with '--copy-to', schedule the copy of target Pod on the same node.

//     --set-image=[]:
// 	When used with '--copy-to', a list of name=image pairs for changing container images, similar to how 'kubectl
// 	set image' works.

//     --share-processes=true:
// 	When used with '--copy-to', enable process namespace sharing in the copy.

//     -i, --stdin=false:
// 	Keep stdin open on the container(s) in the pod, even if nothing is attached.

//     --target='':
// 	When using an ephemeral container, target processes in this container name.

//     -t, --tty=false:
// 	Allocate a TTY for the debugging container.

// Usage:
//   kubectl debug (POD | TYPE[[.VERSION].GROUP]/NAME) [ -- COMMAND [args...] ] [options]

// Use "kubectl options" for a list of global command-line options (applies to all commands).

/// Debug cluster resources using interactive debugging containers.

#[derive(Clone, Debug, Args)]
pub struct Debug {
    /// Copy the same volumes as the target pod in the debug container
    #[arg(long)]
    copy_volumes: bool,
}