Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JuHyung-Son committed Dec 21, 2023
1 parent db07c73 commit 8b38b55
Showing 1 changed file with 37 additions and 14 deletions.
51 changes: 37 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ spec:
noCache: false
repository: ghcr.io/k8sgpt-ai/k8sgpt
version: v0.3.8
imagePullSecrets:
- name: aws-cred
#integrations:
# trivy:
# enabled: true
Expand Down Expand Up @@ -115,8 +113,6 @@ spec:
noCache: false
repository: ghcr.io/k8sgpt-ai/k8sgpt
version: v0.3.8
imagePullSecrets:
- name: aws-cred
remoteCache:
credentials:
name: k8sgpt-sample-cache-secret
Expand Down Expand Up @@ -159,10 +155,8 @@ spec:
name: k8sgpt-sample-secret
key: openai-api-key
noCache: false
repository: ghcr.io/k8sgpt-ai/k8gpt
repository: ghcr.io/k8sgpt-ai/k8sgpt
version: v0.3.8
imagePullSecrets:
- name: aws-cred
remoteCache:
credentials:
name: k8sgpt-sample-cache-secret
Expand Down Expand Up @@ -206,10 +200,8 @@ spec:
baseUrl: https://k8sgpt.openai.azure.com/
engine: llm
noCache: false
repository: ghcr.io/k8sgpt-ai/k8gpt
repository: ghcr.io/k8sgpt-ai/k8sgpt
version: v0.3.8
imagePullSecrets:
- name: aws-cred
EOF
```
Expand Down Expand Up @@ -239,10 +231,8 @@ spec:
backend: localai
baseUrl: http://local-ai.local-ai.svc.cluster.local:8080/v1
noCache: false
repository: ghcr.io/k8sgpt-ai/k8gpt
repository: ghcr.io/k8sgpt-ai/k8sgpt
version: v0.3.8
imagePullSecrets:
- name: aws-cred
EOF
```
Note: ensure that the value of `baseUrl` is a properly constructed [DNS name](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#services) for the LocalAI Service. It should take the form: `http://local-ai.<namespace_local_ai_was_installed_in>.svc.cluster.local:8080/v1`.
Expand All @@ -251,10 +241,43 @@ EOF
</details>
## K8sGPT Configuration Options
<details>
<summary>ImagePullSecrets</summary>
You can use custom k8sgpt image by modifying `repository`, `version`, `imagePullSecrets`.
`version` actually works as image tag.
```sh
kubectl apply -f - << EOF
apiVersion: core.k8sgpt.ai/v1alpha1
kind: K8sGPT
metadata:
name: k8sgpt-sample
namespace: k8sgpt-operator-system
spec:
ai:
enabled: true
model: gpt-3.5-turbo
backend: openai
secret:
name: k8sgpt-sample-secret
key: openai-api-key
noCache: false
repository: sample.repository/k8sgpt
version: sample-tag
imagePullSecrets:
- name: sample-secret
EOF
```
</details>
## Helm values
For details please see [here](chart/operator/values.yaml)
## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt-operator?ref=badge_large)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fk8sgpt-ai%2Fk8sgpt-operator?ref=badge_large)

0 comments on commit 8b38b55

Please sign in to comment.