Skip to content

Commit c2d10f1

Browse files
authored
Add readme for kubernetes module (#987)
Add readme content for kubernetes module
1 parent 4784669 commit c2d10f1

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

modules/README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,45 @@ Installation:
158158
2. Import this module in your `config.nu`: `import ~/.local/share/nu_scripts/modules/jc/`
159159

160160
## [kubernetes](./kubernetes/)
161-
???
162-
161+
162+
| Category | Command | Description | Options |
163+
|----------|---------|-------------|----------|
164+
| File Operations | `kaf <file>` | kubectl apply -f | |
165+
| | `kdf <file>` | kubectl diff -f | |
166+
| | `kdelf <file>` | kubectl delete -f | |
167+
| | `kak <file>` | kubectl apply -k (kustomize) | |
168+
| | `kdk <file>` | kubectl diff -k (kustomize) | |
169+
| | `kdelk <file>` | kubectl delete -k (kustomize) | |
170+
| | `kk <file>` | kubectl kustomize (template) | |
171+
| Context & Namespace | `kcc <context>` | change context | |
172+
| | `kn <namespace>` | change namespace | |
173+
| | `kccc <name>` | clone context to ~/.kube/config.d/ | |
174+
| Resource Management | `kg <kind> [resource]` | get resources | `-n/--namespace`: specify namespace<br>`-p/--jsonpath`: use jsonpath<br>`-l/--selector`: label selector<br>`-v/--verbose`: detailed output<br>`-w/--watch`: watch resources<br>`-W/--wide`: wide output<br>`-a/--all`: all namespaces |
175+
| | `kd <kind> <resource>` | describe resource | |
176+
| | `kc <kind> <name>` | create resource | |
177+
| | `ky <kind> <resource>` | get yaml output | |
178+
| | `ke <kind> [resource]` | edit resource | |
179+
| | `kdel <kind> <resource>` | delete resource | |
180+
| Pods | `kgp` | get pods | |
181+
| | `kdp <pod>` | describe pod | |
182+
| | `kdelp <pod>` | delete pod | |
183+
| | `kep <pod>` | edit pod | |
184+
| | `kl <pod>` | logs from pod | `-n/--namespace`: specify namespace<br>`-c/--container`: specify container<br>`-f/--follow`: follow logs<br>`-p/--previous`: show previous logs |
185+
| | `kep <pod>` | exec into pod | |
186+
| Services | `kgs` | get services | |
187+
| | `kds <svc>` | describe service | |
188+
| | `kdels <svc>` | delete service | |
189+
| | `kes <svc>` | edit service | |
190+
| Deployments | `kgd` | get deployments | |
191+
| | `kdel deployment <deploy>` | delete deployment | |
192+
| | `ked <deploy>` | edit deployment | |
193+
| | `ksd <deploy> <num>` | scale deployment | |
194+
| | `ksdr <deploy> <num>` | scale deployment with reset | |
195+
| | `krhd <deploy>` | rollout history deployment | |
196+
| | `krud <deploy>` | rollout undo deployment | |
197+
| Config & Utils | `kube-config` | get kubeconfig info | |
198+
| | `kube-refine [namespace] -k [kind]` | extract structured info from resources | |
199+
163200
## [make_release](../make_release/)
164201
???
165202

0 commit comments

Comments
 (0)