mirror of
https://github.com/k8sgpt-ai/k8sgpt.git
synced 2025-07-14 15:44:46 +00:00
chore: update brew installation note (#1155)
Signed-off-by: Rui Chen <rui@chenrui.dev>
This commit is contained in:
parent
3f80bbaa1b
commit
ab534d184f
22
README.md
22
README.md
@ -8,12 +8,12 @@
|
|||||||

|

|
||||||

|

|
||||||
[](https://bestpractices.coreinfrastructure.org/projects/7272)
|
[](https://bestpractices.coreinfrastructure.org/projects/7272)
|
||||||
[](https://docs.k8sgpt.ai/)
|
[](https://docs.k8sgpt.ai/)
|
||||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt?ref=badge_shield)
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt?ref=badge_shield)
|
||||||
[](https://opensource.org/licenses/Apache-2.0)
|
[](https://opensource.org/licenses/Apache-2.0)
|
||||||
[](https://github.com/k8sgpt-ai/k8sgpt)
|
[](https://github.com/k8sgpt-ai/k8sgpt)
|
||||||
[](https://codecov.io/github/k8sgpt-ai/k8sgpt)
|
[](https://codecov.io/github/k8sgpt-ai/k8sgpt)
|
||||||

|

|
||||||
|
|
||||||
`k8sgpt` is a tool for scanning your Kubernetes clusters, diagnosing, and triaging issues in simple English.
|
`k8sgpt` is a tool for scanning your Kubernetes clusters, diagnosing, and triaging issues in simple English.
|
||||||
|
|
||||||
@ -30,7 +30,13 @@ _Out of the box integration with OpenAI, Azure, Cohere, Amazon Bedrock, Google G
|
|||||||
|
|
||||||
### Linux/Mac via brew
|
### Linux/Mac via brew
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ brew install k8sgpt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```sh
|
||||||
brew tap k8sgpt-ai/k8sgpt
|
brew tap k8sgpt-ai/k8sgpt
|
||||||
brew install k8sgpt
|
brew install k8sgpt
|
||||||
```
|
```
|
||||||
@ -302,10 +308,10 @@ K8sGPT uses the chosen LLM, generative AI provider when you want to explain the
|
|||||||
You can list available providers using `k8sgpt auth list`:
|
You can list available providers using `k8sgpt auth list`:
|
||||||
|
|
||||||
```
|
```
|
||||||
Default:
|
Default:
|
||||||
> openai
|
> openai
|
||||||
Active:
|
Active:
|
||||||
Unused:
|
Unused:
|
||||||
> openai
|
> openai
|
||||||
> localai
|
> localai
|
||||||
> azureopenai
|
> azureopenai
|
||||||
@ -425,7 +431,7 @@ Config file locations:
|
|||||||
There may be scenarios where caching remotely is preferred.
|
There may be scenarios where caching remotely is preferred.
|
||||||
In these scenarios K8sGPT supports AWS S3 or Azure Blob storage Integration.
|
In these scenarios K8sGPT supports AWS S3 or Azure Blob storage Integration.
|
||||||
|
|
||||||
<summary> Remote caching </summary>
|
<summary> Remote caching </summary>
|
||||||
<em>Note: You can only configure and use only one remote cache at a time</em>
|
<em>Note: You can only configure and use only one remote cache at a time</em>
|
||||||
|
|
||||||
_Adding a remote cache_
|
_Adding a remote cache_
|
||||||
@ -440,11 +446,11 @@ _Adding a remote cache_
|
|||||||
* We support a number of [techniques](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication?tabs=bash#2-authenticate-with-azure) to authenticate against Azure
|
* We support a number of [techniques](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication?tabs=bash#2-authenticate-with-azure) to authenticate against Azure
|
||||||
* Configuration, ``` k8sgpt cache add azure --storageacc <storage account name> --container <container name> ```
|
* Configuration, ``` k8sgpt cache add azure --storageacc <storage account name> --container <container name> ```
|
||||||
* K8sGPT assumes that the storage account already exist and it will create the container if it does not exist
|
* K8sGPT assumes that the storage account already exist and it will create the container if it does not exist
|
||||||
* It is the **user** responsibility have to grant specific permissions to their identity in order to be able to upload blob files and create SA containers (e.g Storage Blob Data Contributor)
|
* It is the **user** responsibility have to grant specific permissions to their identity in order to be able to upload blob files and create SA containers (e.g Storage Blob Data Contributor)
|
||||||
* Google Cloud Storage
|
* Google Cloud Storage
|
||||||
* _As a prerequisite `GOOGLE_APPLICATION_CREDENTIALS` are required as environmental variables._
|
* _As a prerequisite `GOOGLE_APPLICATION_CREDENTIALS` are required as environmental variables._
|
||||||
* Configuration, ``` k8sgpt cache add gcs --region <gcp region> --bucket <name> --projectid <project id>```
|
* Configuration, ``` k8sgpt cache add gcs --region <gcp region> --bucket <name> --projectid <project id>```
|
||||||
* K8sGPT will create the bucket if it does not exist
|
* K8sGPT will create the bucket if it does not exist
|
||||||
|
|
||||||
_Listing cache items_
|
_Listing cache items_
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user