k8sgpt-ai / docs Goto Github PK

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?

No

Problem Description

No Operator documentation

Solution Description

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

Benefits

This will lower the bar to entry for new starters

Potential Drawbacks

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the bug.
• I've included the version of Kubernetes and k8sgpt.

Subject of the issue

• Installtion steps on the website are not formatted correctly and look messed up

Additional context / screenshots

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

v0.3.38

Kubernetes Version

v1.30

Host OS and its Version

No response

Steps to reproduce

gyliu@guangyas-air k8sgpt % bin/k8sgpt auth update
panic: runtime error: index out of range [0] with length 0

goroutine 1 [running]:
github.com/k8sgpt-ai/k8sgpt/cmd/auth.init.func9(0x109462340, {0x109501c40, 0x0, 0x1067a23c7?})
	/Users/gyliu/github.com/k8sgpt-ai/k8sgpt/cmd/auth/update.go:92 +0x638
github.com/spf13/cobra.(*Command).execute(0x109462340, {0x109501c40, 0x0, 0x0})
	/Users/gyliu/go/pkg/mod/github.com/spf13/[email protected]/command.go:989 +0x828
github.com/spf13/cobra.(*Command).ExecuteC(0x109460c40)
	/Users/gyliu/go/pkg/mod/github.com/spf13/[email protected]/command.go:1117 +0x344
github.com/spf13/cobra.(*Command).Execute(...)
	/Users/gyliu/go/pkg/mod/github.com/spf13/[email protected]/command.go:1041
github.com/k8sgpt-ai/k8sgpt/cmd.Execute({0x106ff835c?, 0x0?}, {0x106ff8870?, 0x1047c69b0?}, {0x106ff8960?, 0x140000021c0?})
	/Users/gyliu/github.com/k8sgpt-ai/k8sgpt/cmd/root.go:59 +0xa0
main.main()
	/Users/gyliu/github.com/k8sgpt-ai/k8sgpt/main.go:25 +0x4c

Expected behaviour

No exception

Actual behaviour

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the bug.
• I've included the version of Kubernetes and k8sgpt.

Subject of the issue

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.

Your environment

Additional context / screenshots

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the bug.
• I've included the version of Kubernetes and k8sgpt.

Subject of the issue

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.

Your environment

Additional context / screenshots

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

0.3.37

Kubernetes Version

1.28.0

Host OS and its Version

No response

Steps to reproduce

1. With a default configuration (/Users//Library/Application Support/k8sgpt/k8sgpt.yaml) including multiple specific backends, neither of which is OpenAI
2. Run k8sgpt serve

Expected behaviour

Descriptive error for missing --backend flag with non-default (openai) backend configurations.

Actual behaviour

k8sgpt serve
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x8 pc=0x102e297e0]

goroutine 1 [running]:
github.com/k8sgpt-ai/k8sgpt/cmd/serve.init.func1(0x140001dce00?, {0x102e2d786?, 0x4?, 0x102e2d78a?})
github.com/k8sgpt-ai/k8sgpt/cmd/serve/serve.go:152 +0x500
github.com/spf13/cobra.(*Command).execute(0x105b5b380, {0x105d9d388, 0x0, 0x0})
github.com/spf13/[email protected]/command.go:987 +0x828
github.com/spf13/cobra.(*Command).ExecuteC(0x105b57160)
github.com/spf13/[email protected]/command.go:1115 +0x344
github.com/spf13/cobra.(*Command).Execute(...)
github.com/spf13/[email protected]/command.go:1039
github.com/k8sgpt-ai/k8sgpt/cmd.Execute({0x1036baa18?, 0x0?}, {0x1036bde88?, 0x100c567c0?}, {0x1036bdf70?, 0x140000021c0?})
github.com/k8sgpt-ai/k8sgpt/cmd/root.go:59 +0xa0
main.main()
github.com/k8sgpt-ai/k8sgpt/main.go:25 +0x4c

Additional Information

configuration:

ai:
    providers:
        - name: localai
          model: llama3
          baseurl: http://localhost:11434/v1
          temperature: 0.7
          topp: 0.5
          topk: 50
          maxtokens: 2048
        - name: amazonbedrock
          model: anthropic.claude-v2:0
          temperature: 0.7
          providerregion: us-east-1
          topp: 0.5
          topk: 50
          maxtokens: 2048
    defaultprovider: ""
kubeconfig: ""
kubecontext: ""

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

there is non way for users to know the use cases with examples of using the project in different scenarios

Solution Description

add use case examples and tutorials

Benefits

will help the community to understand the project

Potential Drawbacks

No response

Additional Information

No response

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

whenever a new contributor/user arrives they can face challenges through navigating the project such as slack channel , community meetings , contributing guide etc.

Solution Description

we can make a community section in the docs to help the new contributors navigate through the project

Benefits

it will help the newcomers to not get lost through navigating the project

Potential Drawbacks

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• [x ] I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

• Yes
• [ x] No

Describe the solution you'd like

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

Benefits for the project and its users

Helps the community onboard easier and understand the operator and its purpose.

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?

No

Problem Description

No response

Solution Description

As update auth comes out in v0.3.7 it should be documented

k8sgpt-ai/k8sgpt#450

Benefits

Better ability to configure backends

Potential Drawbacks

No response

Additional Information

No response

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

No response

Kubernetes Version

No response

Host OS and its Version

No response

Steps to reproduce

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

Expected behaviour

Only Helm documentation should be the hyperlink text

Actual behaviour

No response

Additional Information

I'd like to fix this issue

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:

3. 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:

3. 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

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?

Yes

Problem Description

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
google
noopai

When you run k8sgpt auth list

Solution Description

If you want to document either of the missing backends, please create a PR (1 PR for each backend) and link to this issue.

Benefits

People would know what to do.

Potential Drawbacks

N/A

Additional Information

N/A

[ ] 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

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

Problem Description

Part of #46

Solution Description

Provide a proper explanation about the filters used in the K8sGPT CLI.
This should be added under the explanation section.

Additional Information

I am working on this.

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

In order to assist our users and provide better documentation then we wish to cover the following topics:

• Filters
• Caching
• Integations

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?

Yes

Problem Description

Part #46

Solution Description

Provide a proper explanation about Integrations used in the K8sGPT CLI.
Further, this should be added under the explanation section.

Additional Information

I am working on it.

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?

No

Problem Description

n/a

Solution Description

Document configuration of the OCI backend.

Benefits

Users will be able to reference the OCI backend documentation for ease of configuration.

Potential Drawbacks

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

• Yes
• No

Description

It is now possible to use different AI backends e.g. k8sgpt-ai/k8sgpt#309
This is not yet reflected in the documentation

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

v0.3.37

Kubernetes Version

n/a

Host OS and its Version

Mac

Steps to reproduce

1. Navigate to https://docs.k8sgpt.ai/reference/cli/
2. Scroll down to "Analysis with serve mode"

Expected behaviour

curl -X POST "http://localhost:8080/v1/analyze"

1. Note the changed method from GET to POST
2. Note the added v1 to the path
3. Also this was the minimal working example for me, but I leave to your best judgment whether to use or not the parameters

Actual behaviour

curl -X GET "http://localhost:8080/analyze?namespace=k8sgpt&explain=false"
resulting in :

1. client side:

    {"code":5,"message":"Not Found","details":[]}%  
   

2. server side:

    ERROR: Failed to extract ServerMetadata from context
   

Additional Information

No response

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

No response

Kubernetes Version

No response

Host OS and its Version

MacOs 13.3.1

Steps to reproduce

To be found at https://docs.k8sgpt.ai/getting-started/getting-started/

Expected behaviour

This should be added as k8sgpt

Actual behaviour

doesn't get wrapped due to mismatched astrics

Additional Information

No response

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?

Yes

Problem Description

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

Solution Description

I will create a pull request and link it to this issue, which will include the documentation for the missing cache providers.

Benefits

People will also know what to do for other cache providers as well.

Potential Drawbacks

N/A

Additional Information

N/A

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

0.3.37

Kubernetes Version

n/a

Host OS and its Version

n/a

Steps to reproduce

open https://docs.k8sgpt.ai/reference/cli/#additional-commands

Expected behaviour

Serve mode

k8sgpt serve --http

Analysis with serve mode

curl -X GET "http://localhost:8080/analyze?namespace=k8sgpt&explain=false"

Actual behaviour

Serve mode

k8sgpt serve

Analysis with serve mode

curl -X GET "http://localhost:8080/analyze?namespace=k8sgpt&explain=false"

Additional Information

That curl won't work without --http flag enabled on the k8sgpt serve command.
I suggest to fix the documentation to include examples dedicated to REST API and GRPC and/or make it clear which is for what.
In this particular case perhaps adding the --http flag to the command is the minimal fix. It may be followed with a snippet with grcurl followed by " if not using the --http flag"

instead of schema.v1.Server the correct resource is schema.v1.ServerService

e.g.:

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

No response

Solution Description

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)

Benefits

It would be easy to review PRs as the latest deploy preview would be available.

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

No response

Kubernetes Version

No response

Host OS and its Version

No response

Steps to reproduce

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

Expected behaviour

only Values.yaml should be the hyperlink text

Actual behaviour

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

• Yes
• No

Describe the solution you'd like

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

Benefits for the project and its users

Developers will know how to use the NoOpAIProvider

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?

Yes

Problem Description

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

Solution Description

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_

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?

No

Problem Description

No response

Solution Description

Running k8sgpt wth flag --http enables a REST API via grpc gateway.
There are way to generate openapi from grpc as the grpc gateway readme suggests:
https://github.com/grpc-ecosystem/grpc-gateway?tab=readme-ov-file#6-optional-generate-openapi-definitions-using-protoc-gen-openapiv2

Benefits

This is a very tangible and useful integration scenario and an openapi specification will nicely support the integration efforts based on it.

Potential Drawbacks

No response

Additional Information

No response

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

• Yes
• No

Describe the solution you'd like

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

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

Solution Description

spelling mistake

Benefits

Docs will look more accurate and good

Potential Drawbacks

No response

Additional Information

i will rise PR for this

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

• 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?

Yes

Problem Description

Part #46

Solution Description

Provide a proper explanation about caching used in the K8sGPT CLI.
Further, this should be added under the explanation section.

Potential Drawbacks

No response

Additional Information

I am working on it.

Checklist

• I've searched for similar issues and couldn't find anything matching
• I've included steps to reproduce the behavior

Affected Components

• K8sGPT (CLI)
• K8sGPT Operator

K8sGPT Version

No response

Kubernetes Version

No response

Host OS and its Version

No response

Steps to reproduce

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

Expected behaviour

grammar mistake: completed -> been completed
add hyphen : out-of-cluster

Actual behaviour

No response

Additional Information

i will rise a PR for this

Checklist:

• I've searched for similar issues and couldn't find anything matching
• I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

• Yes
• No

Description

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

Issues such as k8sgpt-ai/k8sgpt#182
We should have a recommended way of doing things, in this case by passing a secret in.