k8sgpt-ai / k8sgpt-operator

Automatic SRE Superpowers within your Kubernetes cluster
https://k8sgpt.ai
Apache License 2.0
276 stars 74 forks source link

docs: syntax issue in README #429

Closed billabongrob closed 2 months ago

billabongrob commented 2 months ago

📑 Description

There was a misplaced details block causing the Bedrock section not to function as expected.

✅ Checks

ℹ Additional Information

AlexsJones commented 2 months ago

Thanks @billabongrob I think the issue is the details are the wrong way around Do you want to make the below changes?

</details>  <---- SHOULD be <details>
1. Install the operator from the [Installation](#installation) section.

2. Create secret:
```sh 
kubectl create secret generic bedrock-sample-secret --from-literal=AWS_ACCESS_KEY_ID="$(echo $AWS_ACCESS_KEY_ID)" --from-literal=AWS_SECRET_ACCESS_KEY="$(echo $AWS_SECRET_ACCESS_KEY)" -n k8sgpt-operator-system
  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:
    enabled: true
    secret:
      name: bedrock-sample-secret
    model: anthropic.claude-v2
    region: eu-central-1
    backend: amazonbedrock
    noCache: false
    repository: ghcr.io/k8sgpt-ai/k8sgpt
    version: v0.3.29
    EOF
. <---- SHOULD be
JuHyung-Son commented 2 months ago

This fix is correct. Currently, bedrock

does not contain yaml, so it is not possible to use the triangle point.

CleanShot 2024-04-30 at 17 02 16@2x