k8sgpt-ai / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for K8sGPT
Home Page: https://docs.k8sgpt.ai/
License: Apache License 2.0
Documentation for K8sGPT
Home Page: https://docs.k8sgpt.ai/
License: Apache License 2.0
No response
No response
No response
https://github.com/k8sgpt-ai/docs/blob/main/docs/reference/operator/overview.md Here in line number 16 the values.yaml file
is marked as a hyperlink
only Values.yaml
should be the hyperlink text
No response
No response
Checklist:
We have a Helm Chart to install K8s inside of a cluster k8sgpt-ai/k8sgpt#318
This has to be documented under installation options and possibly under References with the different configurations that can be made in the values.yaml file
None
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
:
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
Modify to:
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
easy to understand
n/a
No response
Checklist:
No
n/a
Document configuration of the OCI backend.
Users will be able to reference the OCI backend documentation for ease of configuration.
No response
No response
Explain this issue:
In the Getting Started Guide, the command to authenticate k8sgpt with OpenAI is k8sgpt auth new
. However, this command is no longer used these days. Add the correct command for authentication.
Solution
The correct command should be k8sgpt auth add --backend openai -m gpt-3.5-turbo
No
No Operator documentation
We would like to have some documentation around setting up and running the operator.
Most of this can be lifted from the readme here but also enhanced and made more readable
This will lower the bar to entry for new starters
No response
No response
instead of schema.v1.Server the correct resource is schema.v1.ServerService
e.g.:
docs/docs/reference/cli/serve-mode.md
Line 33 in ce9e48f
[ ] Remove in docs edit button (we want the docs to link to the k8sgpt repo and the edit button will point to that)
[ ] This page needs extra spacing before bullet points https://docs.k8sgpt.ai/explanation/ to display them nicer
No response
No response
MacOs 13.3.1
To be found at https://docs.k8sgpt.ai/getting-started/getting-started/
This should be added as k8sgpt
doesn't get wrapped due to mismatched astrics
No response
Yes
Part #46
Provide a proper explanation about caching used in the K8sGPT CLI.
Further, this should be added under the explanation section.
No response
I am working on it.
Checklist:
On the docs/Overview page Edit this page is giving a 404 error. Not pointing to the edit page on github.
I have circled with red color button.
In order to assist our users and provide better documentation then we wish to cover the following topics:
It would be really nice to have an Issue and PR template for the repo because it will help to understand and format the issues and the changes proposed through a PR more accurately.
I can work on this, please assign it to me
Checklist:
We have added the instructions for installation using rpm
, deb
, apk
in the README.md
here. The same should be updated in the installation.md
in the docs here
Yes
Part #46
Provide a proper explanation about Integrations used in the K8sGPT CLI.
Further, this should be added under the explanation section.
I am working on it.
No response
No response
No response
https://github.com/k8sgpt-ai/docs/blob/main/docs/getting-started/in-cluster-operator.md
You will also need to install helm v3. See the Helm documentation for more information.
Only Helm documentation should be the hyperlink text
Only Helm documentation should be the hyperlink text
No response
I'd like to fix this issue
Yes
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
I will create a pull request and link it to this issue, which will include the documentation for the missing cache providers.
People will also know what to do for other cache providers as well.
N/A
N/A
No response
No response
No response
1.https://github.com/k8sgpt-ai/docs/blob/f0f6406d56e7e94ded689d3cc67415991b87d731/docs/getting-started/in-cluster-operator.md?plain=1
grammar mistake: completed -> been completed
add hyphen : out-of-cluster
grammar mistake: completed -> been completed
add hyphen : out-of-cluster
No response
i will rise a PR for this
Checklist:
It is now possible to use different AI backends e.g. k8sgpt-ai/k8sgpt#309
This is not yet reflected in the documentation
Yes
The docs currently does not list all the AI backends that are available in K8sGPT:
https://docs.k8sgpt.ai/reference/providers/backend/
The following backends are missing:
cohere
amazonbedrock
amazonsagemaker
noopai
When you run k8sgpt auth list
If you want to document either of the missing backends, please create a PR (1 PR for each backend) and link to this issue.
People would know what to do.
N/A
N/A
Issues such as k8sgpt-ai/k8sgpt#182
We should have a recommended way of doing things, in this case by passing a secret in.
No
No response
As update auth comes out in v0.3.7 it should be documented
Better ability to configure backends
No response
No response
None
there is non way for users to know the use cases with examples of using the project in different scenarios
add use case examples and tutorials
will help the community to understand the project
No response
No response
None
spelling mistake
Docs will look more accurate and good
No response
i will rise PR for this
Checklist:
As we now have an operator it would be ideal to document the README on the docs site to help people get started.
https://github.com/k8sgpt-ai/k8sgpt-operator
Helps the community onboard easier and understand the operator and its purpose.
Part of #46
Provide a proper explanation about the filters used in the K8sGPT CLI.
This should be added under the explanation section.
I am working on this.
Checklist:
On the docs/Overview page Edit this page is giving a 404 error. Not pointing to the edit page on github.
I have circled with red color button.
Checklist:
In PR k8sgpt-ai/k8sgpt#218, we introduced a NoOpAIProvider, which simply echoes the input of an AI request. We should write some documentation on how to use it
Developers will know how to use the NoOpAIProvider
None
No response
Implement Netlify for building the latest deploy preview for our Docs site just as we have for our Website. For example- k8sgpt-ai/website#1 (comment)
It would be easy to review PRs as the latest deploy preview would be available.
Yes
Bedrock now requires --providerRegion
set on auth add
command
It can be overridden dynamically with AWS_DEFAULT_REGION
env, this needs documenting.
THESE MUST BE REGIONS BEDROCK IS ENABLED IN
example
k8sgpt auth add -b amazonbedrock -m anthropic.claude-instant-v1 --providerRegion eu-central-1
``
### Benefits
Clearer docs for amazon bedrock etc etc
### Potential Drawbacks
_No response_
### Additional Information
_No response_
None
whenever a new contributor/user arrives they can face challenges through navigating the project such as slack channel , community meetings , contributing guide etc.
we can make a community section in the docs to help the new contributors navigate through the project
it will help the newcomers to not get lost through navigating the project
No response
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.