docs
docs copied to clipboard
[Feature]: Documentation Missing Cache Provider
Checklist
- [X] I've searched for similar issues and couldn't find anything matching
- [X] I've discussed this feature request in the K8sGPT Slack and got positive feedback
Is this feature request related to a problem?
Yes
Problem Description
The docs currently does not list all the AI Cache Provider that are available in K8sGPT: https://docs.k8sgpt.ai/explanation/caching/
The following backends are missing:
Microsoft Azure blob Google Cloud Storage
Solution Description
I will create a pull request and link it to this issue, which will include the documentation for the missing cache providers.
Benefits
People will also know what to do for other cache providers as well.
Potential Drawbacks
N/A
Additional Information
N/A
And
- The doc doesn't explicitly explain how
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYapplied to the command. Doc should explain these are set andrequired as environmental variablesin CLI. - The same issue with the CLI tool: in the
k8sgpt cache add --help, it doesn't tell you how to passACCESS_KEY&SECRET_ACCESS - The CLI command itself doesn't show available correct keys in help
k8sgpt cache add --helpthey are simply not there:
k8sgpt cache add --help
This command allows you to add a remote cache to store the results of an analysis.
The supported cache types are:
- Azure Blob storage
- Google Cloud storage
- S3
Documentation should have this info from the README:
Adding a remote cache
- AWS S3
- As a prerequisite
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYare required as environmental variables. - Configuration,
k8sgpt cache add s3 --region <aws region> --bucket <name>- K8sGPT will create the bucket if it does not exist
- As a prerequisite
- Azure Storage
- We support a number of techniques to authenticate against Azure
- 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
- 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_CREDENTIALSare required as environmental variables. - Configuration,
k8sgpt cache add gcs --region <gcp region> --bucket <name> --projectid <project id>- K8sGPT will create the bucket if it does not exist
- As a prerequisite
This is a really good point thanks