From ab534d184fcd538f2ba10a6b5bf3a74c28d5fee6 Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Thu, 20 Jun 2024 12:43:47 -0400 Subject: [PATCH] chore: update brew installation note (#1155) Signed-off-by: Rui Chen --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cf9b66b7d9..aa48c53fe7 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/k8sgpt-ai/k8sgpt/release.yaml) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/k8sgpt-ai/k8sgpt) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7272/badge)](https://bestpractices.coreinfrastructure.org/projects/7272) -[![Link to documentation](https://img.shields.io/static/v1?label=%F0%9F%93%96&message=Documentation&color=blue)](https://docs.k8sgpt.ai/) +[![Link to documentation](https://img.shields.io/static/v1?label=%F0%9F%93%96&message=Documentation&color=blue)](https://docs.k8sgpt.ai/) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt?ref=badge_shield) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Go version](https://img.shields.io/github/go-mod/go-version/k8sgpt-ai/k8sgpt.svg)](https://github.com/k8sgpt-ai/k8sgpt) [![codecov](https://codecov.io/github/k8sgpt-ai/k8sgpt/graph/badge.svg?token=ZLR7NG8URE)](https://codecov.io/github/k8sgpt-ai/k8sgpt) -![GitHub last commit (branch)](https://img.shields.io/github/last-commit/k8sgpt-ai/k8sgpt/main) +![GitHub last commit (branch)](https://img.shields.io/github/last-commit/k8sgpt-ai/k8sgpt/main) `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 +```sh +$ brew install k8sgpt ``` + +or + +```sh brew tap k8sgpt-ai/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`: ``` -Default: +Default: > openai -Active: -Unused: +Active: +Unused: > openai > localai > azureopenai @@ -425,7 +431,7 @@ Config file locations: There may be scenarios where caching remotely is preferred. In these scenarios K8sGPT supports AWS S3 or Azure Blob storage Integration. - Remote caching + Remote caching Note: You can only configure and use only one remote cache at a time _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 * Configuration, ``` k8sgpt cache add azure --storageacc --container ``` * 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 * _As a prerequisite `GOOGLE_APPLICATION_CREDENTIALS` are required as environmental variables._ * Configuration, ``` k8sgpt cache add gcs --region --bucket --projectid ``` - * K8sGPT will create the bucket if it does not exist + * K8sGPT will create the bucket if it does not exist _Listing cache items_ ```