github/k8sgpt
1
0
Fork 0
mirror of https://github.com/k8sgpt-ai/k8sgpt.git synced 2025-09-19 18:16:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add serve & integration to README

Browse Source 
Signed-off-by: Matthis Holleville <matthish29@gmail.com>
This commit is contained in:
Matthis Holleville
2023-04-23 16:24:40 +02:00
parent cf797a6eb6
commit a65ee7fc09
1 changed files with 51 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -156,6 +156,8 @@ you will be able to write your own analyzers.
## Usage ## Usage
``` ```
Kubernetes debugging powered by AI
Usage: Usage:
k8sgpt [command] k8sgpt [command]
@@ -166,14 +168,15 @@ Available Commands:
filters Manage filters for analyzing Kubernetes resources filters Manage filters for analyzing Kubernetes resources
generate Generate Key for your chosen backend (opens browser) generate Generate Key for your chosen backend (opens browser)
help Help about any command help Help about any command
integration Intergrate another tool into K8sGPT
serve Runs k8sgpt as a server
version Print the version number of k8sgpt version Print the version number of k8sgpt
Flags: Flags:
--config string config file (default is $HOME/.k8sgpt.git.yaml) --config string config file (default is $HOME/.k8sgpt.yaml)
-h, --help help for k8sgpt -h, --help help for k8sgpt
--kubeconfig string Path to a kubeconfig. Only required if out-of-cluster. --kubeconfig string Path to a kubeconfig. Only required if out-of-cluster. (default "$HOME/.kube/config")
--master string The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. --kubecontext string Kubernetes context to use. Only required if out-of-cluster.
-t, --toggle Help message for toggle
Use "k8sgpt [command] --help" for more information about a command. Use "k8sgpt [command] --help" for more information about a command.
``` ```
@@ -269,6 +272,49 @@ The Kubernetes system is trying to scale a StatefulSet named fake-deployment usi
</details> </details>
### Additional commands
<details>
_Manage integrations_
_List integrations_
```
k8sgpt integrations list
```
_Activate integrations_
```
k8sgpt integrations activate [integration(s)]
```
_Use integration_
```
k8sgpt analyze --filter=[integration(s)]
```
_Deactivate integrations_
```
k8sgpt integrations deactivate [integration(s)]
```
_Serve mode_
```
k8sgpt serve
```
_Analysis with serve mode_
```
curl -X GET "http://localhost:8080/analyze?namespace=k8sgpt&explain=false"
```
</details>
## Configuration ## Configuration
`k8sgpt` stores config data in the `$XDG_CONFIG_HOME/k8sgpt/k8sgpt.yaml` file. The data is stored in plain text, including your OpenAI key. `k8sgpt` stores config data in the `$XDG_CONFIG_HOME/k8sgpt/k8sgpt.yaml` file. The data is stored in plain text, including your OpenAI key.