docs: added azure and gcs cache integration guide #91
Conversation
Signed-off-by: amitamrutiya2210 <amitamrutiya2210@gmail.com> Signed-off-by: amitamrutiya2210 <amitamrutiya2210@gmail.com>
✅ Deploy Preview for meek-marigold-103c48 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -38,7 +38,80 @@ _Removing the Remote Cache_: | |||
| If users wish to remove the remote cache without deleting the associated AWS S3 bucket, they can use the following command: | |||
|
|
|||
| ``` | |||
| k8sgpt cache remove --bucket <name> | |||
| k8sgpt cache remove | |||
There was a problem hiding this comment.
users don't need to specify the resource?
There was a problem hiding this comment.
Yes, without specifying any resource, it will select the current active cache and convert it into a file-based cache. I have also checked the K8sGPT code and confirmed that there are no other flags present like --bucket on the cache remove command.
|
|
||
| To view the items stored in the remote cache, users can use the following command: | ||
|
|
||
| ```g |
| Users can add a remote cache to the K8sGPT CLI by executing the following command: | ||
|
|
||
| ``` | ||
| k8sgpt cache add --azure --storage <azure storage account name> --container <container name> |
There was a problem hiding this comment.
Maybe add where to find both the and the container
It might be obvious but better to be 100% clear which information we need here
There was a problem hiding this comment.
Also, here, could you please add what the user is supposed to see once they have run the command?
| ### Prerequisites | ||
| Before using the remote caching feature with Google Cloud Storage in K8sGPT, ensure you have the following prerequisites set up: | ||
|
|
||
| - `GOOGLE_CLOUD_STORAGE_ACCOUNT`: An Google Cloud Storage Account is required to authenticate with gcloud CLI programmatically. |
There was a problem hiding this comment.
Once I run the K8s GPT command that will trigger the authentication with the the glcloud CLI?
k8sgpt cache add --gcs --bucket --region --projectid
Could we add a verification step -- e.g. describing in a few words what users are supposed to see?
| If users wish to remove the remote cache without deleting the associated Azure Blob Storage container, they can use the following command: | ||
|
|
||
| ``` | ||
| k8sgpt cache remove |
There was a problem hiding this comment.
Can you add what the user is supposed to see e.g. is there a confirmation message?
Closes #90
📑 Description
In this pull request, I've implemented all the necessary steps to configure other cache providers as well.
✅ Checks
ℹ Additional Information
Merging this PR in one go might be challenging, so please don't hesitate to point out any mistakes or suggest enhancements. Your feedback is greatly appreciated.