Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Documentation for S3 cache for k8sgpt operator missing secret keys expected. #96

Open
1 task done
qdrddr opened this issue Mar 20, 2024 · 0 comments
Open
1 task done

Comments

@qdrddr
Copy link

qdrddr commented Mar 20, 2024

Checklist

  • I've searched for similar issues and couldn't find anything matching
  • [] I've discussed this feature request in the K8sGPT Slack and got positive feedback

Is this feature request related to a problem?

None

Problem Description

On this doc page, no Cache S3 is mentioned at all.
https://docs.k8sgpt.ai/getting-started/in-cluster-operator/

On this README.md file

In the Remote Cache section you should explain that the secret: k8sgpt-sample-cache-secret expects these kyes to be present for s3: aws_access_key_id & aws_secret_access_key:

  1. Apply the K8sGPT configuration object:
kubectl apply -f - << EOF
apiVersion: core.k8sgpt.ai/v1alpha1
kind: K8sGPT
metadata:
  name: k8sgpt-sample
  namespace: k8sgpt-operator-system
spec:
  ai:
    model: gpt-3.5-turbo
    backend: openai
    enabled: true
    secret:
      name: k8sgpt-sample-secret
      key: openai-api-key
  noCache: false
  repository: ghcr.io/k8sgpt-ai/k8sgpt
  version: v0.3.8
  remoteCache:
    credentials:
      name: k8sgpt-sample-cache-secret
    s3:
      bucketName: foo
      region: us-west-1
EOF

Solution Description

Modify to:

  1. Apply the K8sGPT configuration object:
kubectl apply -f - << EOF
apiVersion: core.k8sgpt.ai/v1alpha1
kind: K8sGPT
metadata:
  name: k8sgpt-sample
  namespace: k8sgpt-operator-system
spec:
  ai:
    model: gpt-3.5-turbo
    backend: openai
    enabled: true
    secret:
      name: k8sgpt-sample-secret
      key: openai-api-key
  noCache: false
  repository: ghcr.io/k8sgpt-ai/k8sgpt
  version: v0.3.8
  remoteCache:
    credentials:
      name: k8sgpt-sample-cache-secret
      #!These kyes should be present in the secret for s3!
      #aws_access_key_id
      #aws_secret_access_key
    s3:
      bucketName: foo
      region: us-west-1
EOF

Benefits

easy to understand

Potential Drawbacks

n/a

Additional Information

No response

@qdrddr qdrddr changed the title [Feature]: Documentation foe S3 cache for k8sgpt operator missing secret keys expected. [Feature]: Documentation for S3 cache for k8sgpt operator missing secret keys expected. Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant