Skip to content

Commit bdad267

Browse files
authored
Update README.md to include Tools
Fixes #35 I needed the list of tools and their params, so added to the README. Great job on this, it's exactly what I need!
1 parent baf1595 commit bdad267

File tree

1 file changed

+163
-0
lines changed

1 file changed

+163
-0
lines changed

README.md

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,169 @@ extensions:
9595

9696
```
9797

98+
## Tools
99+
100+
### `configuration_view`
101+
102+
Get the current Kubernetes configuration content as a kubeconfig YAML
103+
104+
**Parameters:**
105+
- `minified` (`boolean`, optional, default: `true`)
106+
- Return a minified version of the configuration
107+
- If `true`, keeps only the current-context and relevant configuration pieces
108+
- If `false`, returns all contexts, clusters, auth-infos, and users
109+
110+
### `events_list`
111+
112+
List all the Kubernetes events in the current cluster from all namespaces
113+
114+
**Parameters:**
115+
- `namespace` (`string`, optional)
116+
- Namespace to retrieve the events from. If not provided, will list events from all namespaces
117+
118+
### `namespaces_list`
119+
120+
List all the Kubernetes namespaces in the current cluster
121+
122+
**Parameters:** None
123+
124+
### `pods_delete`
125+
126+
Delete a Kubernetes Pod in the current or provided namespace with the provided name
127+
128+
**Parameters:**
129+
- `name` (`string`, required)
130+
- Name of the Pod to delete
131+
- `namespace` (`string`, required)
132+
- Namespace to delete the Pod from
133+
134+
### `pods_exec`
135+
136+
Execute a command in a Kubernetes Pod in the current or provided namespace with the provided name and command
137+
138+
**Parameters:**
139+
- `command` (`string[]`, required)
140+
- Command to execute in the Pod container
141+
- First item is the command, rest are arguments
142+
- Example: `["ls", "-l", "/tmp"]`
143+
- `name` (string, required)
144+
- Name of the Pod
145+
- `namespace` (string, required)
146+
- Namespace of the Pod
147+
148+
### `pods_get`
149+
150+
Get a Kubernetes Pod in the current or provided namespace with the provided name
151+
152+
**Parameters:**
153+
- `name` (`string`, required)
154+
- Name of the Pod
155+
- `namespace` (`string`, required)
156+
- Namespace to get the Pod from
157+
158+
### `pods_list`
159+
160+
List all the Kubernetes pods in the current cluster from all namespaces
161+
162+
**Parameters:** None
163+
164+
### `pods_list_in_namespace`
165+
166+
List all the Kubernetes pods in the specified namespace in the current cluster
167+
168+
**Parameters:**
169+
- `namespace` (`string`, required)
170+
- Namespace to list pods from
171+
172+
### `pods_log`
173+
174+
Get the logs of a Kubernetes Pod in the current or provided namespace with the provided name
175+
176+
**Parameters:**
177+
- `name` (`string`, required)
178+
- Name of the Pod to get logs from
179+
- `namespace` (`string`, required)
180+
- Namespace to get the Pod logs from
181+
- `container` (`string`, optional)
182+
- Name of the Pod container to get logs from
183+
184+
### `pods_run`
185+
186+
Run a Kubernetes Pod in the current or provided namespace with the provided container image and optional name
187+
188+
**Parameters:**
189+
- `image` (`string`, required)
190+
- Container Image to run in the Pod
191+
- `namespace` (`string`, required)
192+
- Namespace to run the Pod in
193+
- `name` (`string`, optional)
194+
- Name of the Pod (random name if not provided)
195+
- `port` (`number`, optional)
196+
- TCP/IP port to expose from the Pod container
197+
- No port exposed if not provided
198+
199+
### `resources_create_or_update`
200+
201+
Create or update a Kubernetes resource in the current cluster by providing a YAML or JSON representation of the resource
202+
203+
**Parameters:**
204+
- `resource` (`string`, required)
205+
- A JSON or YAML containing a representation of the Kubernetes resource
206+
- Should include top-level fields such as apiVersion, kind, metadata, and spec
207+
208+
**Common apiVersion and kind include:**
209+
- v1 Pod
210+
- v1 Service
211+
- v1 Node
212+
- apps/v1 Deployment
213+
- networking.k8s.io/v1 Ingress
214+
215+
### `resources_delete`
216+
217+
Delete a Kubernetes resource in the current cluster
218+
219+
**Parameters:**
220+
- `apiVersion` (`string`, required)
221+
- apiVersion of the resource (e.g., `v1`, `apps/v1`, `networking.k8s.io/v1`)
222+
- `kind` (`string`, required)
223+
- kind of the resource (e.g., `Pod`, `Service`, `Deployment`, `Ingress`)
224+
- `name` (`string`, required)
225+
- Name of the resource
226+
- `namespace` (`string`, optional)
227+
- Namespace to delete the namespaced resource from
228+
- Ignored for cluster-scoped resources
229+
- Uses configured namespace if not provided
230+
231+
### `resources_get`
232+
233+
Get a Kubernetes resource in the current cluster
234+
235+
**Parameters:**
236+
- `apiVersion` (`string`, required)
237+
- apiVersion of the resource (e.g., `v1`, `apps/v1`, `networking.k8s.io/v1`)
238+
- `kind` (`string`, required)
239+
- kind of the resource (e.g., `Pod`, `Service`, `Deployment`, `Ingress`)
240+
- `name` (`string`, required)
241+
- Name of the resource
242+
- `namespace` (`string`, optional)
243+
- Namespace to retrieve the namespaced resource from
244+
- Ignored for cluster-scoped resources
245+
- Uses configured namespace if not provided
246+
247+
### `resources_list`
248+
249+
List Kubernetes resources and objects in the current cluster
250+
251+
**Parameters:**
252+
- `apiVersion` (`string`, required)
253+
- apiVersion of the resources (e.g., `v1`, `apps/v1`, `networking.k8s.io/v1`)
254+
- `kind` (`string`, required)
255+
- kind of the resources (e.g., `Pod`, `Service`, `Deployment`, `Ingress`)
256+
- `namespace` (`string`, optional)
257+
- Namespace to retrieve the namespaced resources from
258+
- Ignored for cluster-scoped resources
259+
- Lists resources from all namespaces if not provided
260+
98261
## 🎥 Demos <a id="demos"></a>
99262

100263
### Diagnosing and automatically fixing an OpenShift Deployment

0 commit comments

Comments
 (0)