Merge pull request #120 from k8sgpt-ai/release-please--branches--main

chore(main): release 0.1.2

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,35 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: 'feature: '
+labels: 'type:question'
+assignees: '@k8sgpt-ai/maintainers'
+---
+
+<!-- 
+Thank you for initiating this feature request 🤗
+
+To ensure conciseness, kindly try to adhere to the following format.
+-->
+
+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
+
+<!-- If yes, please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+## Benefits for the project and its users
+<!-- Describe the benefits this feature will bring to the project and its users. -->
+
+## Potential drawbacks
+<!-- Describe any potential drawbacks this feature might bring to the project and its users. -->
+
+## Additional context
+<!-- Add any other context about your feature request here. If applicable, add drawings to help explain. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,50 @@
+---
+name: Question / Bug Report
+about: Create a report to help us improve
+title: 'question: '
+labels: 'type:question'
+assignees: ''
+---
+
+<!-- 
+Thank you for initiating this issue request 🤗
+
+To ensure conciseness, kindly try to adhere to the following format.
+-->
+
+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
+
+<!-- Describe your issue here. -->
+
+### Your environment
+
+<!-- Describe your environment here. -->
+
+* Version of Kubernetes
+  <!-- kubectl version -->
+* Host OS and its version / If windows, is it WSL?
+* Version of k8sgpt
+  <!-- k8sgpt version -->
+
+### Steps to reproduce
+
+<!-- Tell us how to reproduce this issue. -->
+
+* Step 1
+* Step 2
+
+### Expected behaviour
+<!-- Tell us what should happen -->
+
+### Actual behaviour
+
+<!-- Tell us what happens instead -->
+
+### Additional context / screenshots
+<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->

.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.1.0"}
+{".":"0.1.2"}

CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## [0.1.2](https://github.com/k8sgpt-ai/k8sgpt/compare/v0.1.1...v0.1.2) (2023-03-28)
+
+
+### Features
+
+* added namespace filter ([#127](https://github.com/k8sgpt-ai/k8sgpt/issues/127)) ([b78ab3d](https://github.com/k8sgpt-ai/k8sgpt/commit/b78ab3d9b503a256bf6ccf18276e20140ae17d1c))
+* prefix templates ([#125](https://github.com/k8sgpt-ai/k8sgpt/issues/125)) ([65a568e](https://github.com/k8sgpt-ai/k8sgpt/commit/65a568e937a8fdacc179f5e8b1a021a0178c04f0))
+
+
+### Bug Fixes
+
+* readme code blocks ([#126](https://github.com/k8sgpt-ai/k8sgpt/issues/126)) ([c8b92aa](https://github.com/k8sgpt-ai/k8sgpt/commit/c8b92aaa0e2795aa8d65f84277c8adfe0f1d14e3))
+* update README.md ([#119](https://github.com/k8sgpt-ai/k8sgpt/issues/119)) ([05abe97](https://github.com/k8sgpt-ai/k8sgpt/commit/05abe975dd859cd85096a1a7182f17b0437ad20f))
+
+
+### Other
+
+* added default issue template ([#96](https://github.com/k8sgpt-ai/k8sgpt/issues/96)) ([#121](https://github.com/k8sgpt-ai/k8sgpt/issues/121)) ([11c227b](https://github.com/k8sgpt-ai/k8sgpt/commit/11c227b82e16dac8b46cbd03bb04d9cc1c2b5ac3))
+
+
+### Docs
+
+* add new issue templates ([dbd305f](https://github.com/k8sgpt-ai/k8sgpt/commit/dbd305f901cca09b7148254c3aa7a7435504d6cc))
+* add WSL gcc instructions ([4d5566b](https://github.com/k8sgpt-ai/k8sgpt/commit/4d5566b4df7aedf43edbeeb03130f0ba77dbed1a))
+* added Windows and Linux instalation steps in README ([#116](https://github.com/k8sgpt-ai/k8sgpt/issues/116)) ([3bfb278](https://github.com/k8sgpt-ai/k8sgpt/commit/3bfb278f81a9c550ee37a88c0cb0377331802542))
+* fix indentations ([a46416d](https://github.com/k8sgpt-ai/k8sgpt/commit/a46416dce0f5cee2d42b27525023b04af1a8e3c0))
+* rename ISSUE_TEMPLATE ([#124](https://github.com/k8sgpt-ai/k8sgpt/issues/124)) ([cb4932c](https://github.com/k8sgpt-ai/k8sgpt/commit/cb4932c39df4903a4b48ae5f0428860027f76fd2))
+
+## [0.1.1](https://github.com/k8sgpt-ai/k8sgpt/compare/v0.1.0...v0.1.1) (2023-03-28)
+
+
+### Features
+
+* this stops service exiting the program ([6f90386](https://github.com/k8sgpt-ai/k8sgpt/commit/6f90386fc93b2e39e59832468922e8ba7210b8e5))
+* updated readme ([e0141d1](https://github.com/k8sgpt-ai/k8sgpt/commit/e0141d1cf54b5b37b25a5caeb9d5c940b9410ea7))
+
+
+### Bug Fixes
+
+* short term solution for exhaustion ([5890e3a](https://github.com/k8sgpt-ai/k8sgpt/commit/5890e3a79c80a2973af2feb7d50e7f9c57c563c2))
+
+
+### Other
+
+* update README.md ([93b947f](https://github.com/k8sgpt-ai/k8sgpt/commit/93b947f261e401c10dde6dc1854e6e22187437d6))
+* update root.go path ([2cb1c9c](https://github.com/k8sgpt-ai/k8sgpt/commit/2cb1c9c150d052bb3942d9f62ded9d54b0e1873e))
+
 ## [0.1.0](https://github.com/k8sgpt-ai/k8sgpt/compare/v0.0.9...v0.1.0) (2023-03-28)
 
 

README.md

@@ -7,15 +7,45 @@
 
 It has SRE experience codified into it's analyzers and helps to pull out the most relevent information to enrich it with AI.
 
-## Quick Start
+## Installation
+
+### Linux/Mac via brew
 
 ```
 brew tap k8sgpt-ai/k8sgpt
 brew install k8sgpt
 ```
 
+<details>
+  <summary>Failing Installation on WSL (missing gcc)</summary>
+  When installing Homebrew on WSL, you may encounter the following error:
+
+  ```
+  ==> Installing k8sgpt from k8sgpt-ai/k8sgpt Error: The following formula cannot be installed from bottle and must be 
+  built from source. k8sgpt Install Clang or run brew install gcc.
+  ```
+
+If you install gcc as suggested, the problem will persist. Therefore, you need to install the build-essential package.
+  ```
+     sudo apt-get update
+     sudo apt-get install build-essential
+  ```
+</details>
+
+### Windows
+
+* Download the latest Windows binaries of **k8sgpt** from the [Release](https://github.com/k8sgpt-ai/k8sgpt/releases) 
+  tab based on your system architecture.
+* Extract the downloaded package to your desired location. Configure the system *path* variable with the binary location
+
+### Verify installation
+
+* Run `k8sgpt version`
+
+## Quick Start
+
 * Currently the default AI provider is OpenAI, you will need to generate an API key from [OpenAI](https://openai.com)
-  * You can do this by running `k8sgpt generate` to open a browser link to generate it 
+  * You can do this by running `k8sgpt generate` to open a browser link to generate it
 * Run `k8sgpt auth` to set it in k8sgpt.
 * Run `k8sgpt analyze` to run a scan.
 * And use `k8sgpt analyze --explain` to get a more detailed explanation of the issues.
@@ -24,7 +54,8 @@ brew install k8sgpt
 
 ## Analyzers
 
-K8sGPT uses analyzers to triage and diagnose issues in your cluster. It has a set of analyzers that are built in, but you will be able to write your own analyzers.
+K8sGPT uses analyzers to triage and diagnose issues in your cluster. It has a set of analyzers that are built in, but 
+you will be able to write your own analyzers.
 
 ### Built in analyzers
 
@@ -69,13 +100,18 @@ k8sgpt analyze --explain
 _Filter on resource_
 
 ```
-k8sgpt analyze --explain --resource=Service
+k8sgpt analyze --explain --filter=Service
+```
+
+_Filter by namespace_
+```
+k8sgpt analyze --explain --filter=Pod --namespace=default
 ```
 
 _Output to JSON_
 
 ```
-k8sgpt analyze --explain --resource=Service --output=json
+k8sgpt analyze --explain --filter=Service --output=json
 ```
 
 ## Upcoming major milestones
@@ -84,19 +120,22 @@ k8sgpt analyze --explain --resource=Service --output=json
 - [ ] Custom AI/ML model backend support
 - [ ] Custom analyzers
 
-### What about kubectl-ai?
+## What about kubectl-ai?
 
-The the kubectl-ai [project](https://github.com/sozercan/kubectl-ai) uses AI to create manifests and apply them to the cluster. It is not what we are trying to do here, it is focusing on writing YAML manifests.
+The kubectl-ai [project](https://github.com/sozercan/kubectl-ai) uses AI to create manifests and apply them to the 
+cluster. It is not what we are trying to do here, it is focusing on writing YAML manifests.
 
-K8sgpt is focused on triaging and diagnosing issues in your cluster. It is a tool for SRE, Platform & DevOps engineers to help them understand what is going on in their cluster. Cutting through the noise of logs and multiple tools to find the root cause of an issue.
+K8sgpt is focused on triaging and diagnosing issues in your cluster. It is a tool for SRE, Platform & DevOps engineers 
+to help them understand what is going on in their cluster. Cutting through the noise of logs and multiple tools to find 
+the root cause of an issue.
 
 
-### Configuration 
+## Configuration
 
-`k8sgpt` stores config data in `~/.k8sgpt` the data is stored in plain text, including your OpenAI key.
+`k8sgpt` stores config data in `~/.k8sgpt.yaml` the data is stored in plain text, including your OpenAI key.
 
-### Contributing
+## Contributing
 
 Please read our [contributing guide](./CONTRIBUTING.md).
-### Community
+## Community
 * Find us on [Slack](https://cloud-native.slack.com/channels/k8sgpt-ai)

cmd/analyze/analyze.go

@@ -17,12 +17,13 @@ import (
 )
 
 var (
-	explain  bool
-	backend  string
-	output   string
-	filters  []string
-	language string
-	nocache  bool
+	explain   bool
+	backend   string
+	output    string
+	filters   []string
+	language  string
+	nocache   bool
+	namespace string
 )
 
 // AnalyzeCmd represents the problems command
@@ -68,9 +69,16 @@ var AnalyzeCmd = &cobra.Command{
 		ctx := context.Background()
 		// Get kubernetes client from viper
 		client := viper.Get("kubernetesClient").(*kubernetes.Client)
+		// Analysis configuration
+		config := &analyzer.AnalysisConfiguration{
+			Namespace: namespace,
+			NoCache:   nocache,
+			Explain:   explain,
+		}
 
 		var analysisResults *[]analyzer.Analysis = &[]analyzer.Analysis{}
-		if err := analyzer.RunAnalysis(ctx, client, aiClient, explain, analysisResults); err != nil {
+		if err := analyzer.RunAnalysis(ctx, config, client,
+			aiClient, analysisResults); err != nil {
 			color.Red("Error: %v", err)
 			os.Exit(1)
 		}
@@ -102,8 +110,13 @@ var AnalyzeCmd = &cobra.Command{
 		for _, analysis := range *analysisResults {
 
 			if explain {
-				parsedText, err := analyzer.ParseViaAI(ctx, aiClient, analysis.Error, nocache)
+				parsedText, err := analyzer.ParseViaAI(ctx, config, aiClient, analysis.Error)
 				if err != nil {
+					// Check for exhaustion
+					if strings.Contains(err.Error(), "status code: 429") {
+						color.Red("Exhausted API quota. Please try again later")
+						os.Exit(1)
+					}
 					color.Red("Error: %v", err)
 					continue
 				}
@@ -136,10 +149,13 @@ var AnalyzeCmd = &cobra.Command{
 
 func init() {
 
-	AnalyzeCmd.Flags().BoolVarP(&nocache, "no-cache", "n", false, "Do not use cached data")
+	// namespace flag
+	AnalyzeCmd.Flags().StringVarP(&namespace, "namespace", "n", "", "Namespace to analyze")
+	// no cache flag
+	AnalyzeCmd.Flags().BoolVarP(&nocache, "no-cache", "c", false, "Do not use cached data")
 	// array of strings flag
 	AnalyzeCmd.Flags().StringSliceVarP(&filters, "filter", "f", []string{}, "Filter for these analzyers (e.g. Pod,PersistentVolumeClaim,Service,ReplicaSet)")
-
+	// explain flag
 	AnalyzeCmd.Flags().BoolVarP(&explain, "explain", "e", false, "Explain the problem to me")
 	// add flag for backend
 	AnalyzeCmd.Flags().StringVarP(&backend, "backend", "b", "openai", "Backend AI provider")

cmd/root.go

@@ -48,7 +48,7 @@ func init() {
 	rootCmd.AddCommand(auth.AuthCmd)
 	rootCmd.AddCommand(analyze.AnalyzeCmd)
 	rootCmd.AddCommand(generate.GenerateCmd)
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.k8sgpt.git.yaml)")
+	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.k8sgpt.yaml)")
 	rootCmd.PersistentFlags().StringVar(&masterURL, "master", "", "The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.")
 	rootCmd.PersistentFlags().StringVar(&kubeconfig, "kubeconfig", "", "Path to a kubeconfig. Only required if out-of-cluster.")
 	// Cobra also supports local flags, which will only run

pkg/analyzer/analysis.go

@@ -5,6 +5,12 @@ import (
 	v1 "k8s.io/api/core/v1"
 )
 
+type AnalysisConfiguration struct {
+	Namespace string
+	NoCache   bool
+	Explain   bool
+}
+
 type PreAnalysis struct {
 	Pod                   v1.Pod
 	FailureDetails        []string

pkg/analyzer/analyzer.go

@@ -11,39 +11,40 @@ import (
 	"github.com/spf13/viper"
 )
 
-func RunAnalysis(ctx context.Context, client *kubernetes.Client,
-	aiClient ai.IAI, explain bool, analysisResults *[]Analysis) error {
+func RunAnalysis(ctx context.Context, config *AnalysisConfiguration,
+	client *kubernetes.Client,
+	aiClient ai.IAI, analysisResults *[]Analysis) error {
 
-	err := AnalyzePod(ctx, client, aiClient, explain, analysisResults)
+	err := AnalyzePod(ctx, config, client, aiClient, analysisResults)
 	if err != nil {
 		return err
 	}
 
-	err = AnalyzeReplicaSet(ctx, client, aiClient, explain, analysisResults)
+	err = AnalyzeReplicaSet(ctx, config, client, aiClient, analysisResults)
 	if err != nil {
 		return err
 	}
 
-	err = AnalyzePersistentVolumeClaim(ctx, client, aiClient, explain, analysisResults)
+	err = AnalyzePersistentVolumeClaim(ctx, config, client, aiClient, analysisResults)
 	if err != nil {
 		return err
 	}
 
-	err = AnalyzeEndpoints(ctx, client, aiClient, explain, analysisResults)
+	err = AnalyzeEndpoints(ctx, config, client, aiClient, analysisResults)
 	if err != nil {
 		return err
 	}
 	return nil
 }
 
-func ParseViaAI(ctx context.Context, aiClient ai.IAI, prompt []string,
-	nocache bool) (string, error) {
+func ParseViaAI(ctx context.Context, config *AnalysisConfiguration,
+	aiClient ai.IAI, prompt []string) (string, error) {
 	// parse the text with the AI backend
 	inputKey := strings.Join(prompt, " ")
 	// Check for cached data
 	sEnc := base64.StdEncoding.EncodeToString([]byte(inputKey))
 	// find in viper cache
-	if viper.IsSet(sEnc) && !nocache {
+	if viper.IsSet(sEnc) && !config.NoCache {
 		// retrieve data from cache
 		response := viper.GetString(sEnc)
 		if response == "" {
@@ -61,7 +62,7 @@ func ParseViaAI(ctx context.Context, aiClient ai.IAI, prompt []string,
 	response, err := aiClient.GetCompletion(ctx, inputKey)
 	if err != nil {
 		color.Red("error getting completion: %v", err)
-		return "", nil
+		return "", err
 	}
 
 	if !viper.IsSet(sEnc) {

pkg/analyzer/podAnalyzer.go

@@ -10,10 +10,11 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-func AnalyzePod(ctx context.Context, client *kubernetes.Client, aiClient ai.IAI, explain bool, analysisResults *[]Analysis) error {
+func AnalyzePod(ctx context.Context, config *AnalysisConfiguration,
+	client *kubernetes.Client, aiClient ai.IAI, analysisResults *[]Analysis) error {
 
 	// search all namespaces for pods that are not running
-	list, err := client.GetClient().CoreV1().Pods("").List(ctx, metav1.ListOptions{})
+	list, err := client.GetClient().CoreV1().Pods(config.Namespace).List(ctx, metav1.ListOptions{})
 	if err != nil {
 		return err
 	}

pkg/analyzer/pvcAnalyzer.go

@@ -10,10 +10,10 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-func AnalyzePersistentVolumeClaim(ctx context.Context, client *kubernetes.Client, aiClient ai.IAI, explain bool, analysisResults *[]Analysis) error {
+func AnalyzePersistentVolumeClaim(ctx context.Context, config *AnalysisConfiguration, client *kubernetes.Client, aiClient ai.IAI, analysisResults *[]Analysis) error {
 
 	// search all namespaces for pods that are not running
-	list, err := client.GetClient().CoreV1().PersistentVolumeClaims("").List(ctx, metav1.ListOptions{})
+	list, err := client.GetClient().CoreV1().PersistentVolumeClaims(config.Namespace).List(ctx, metav1.ListOptions{})
 	if err != nil {
 		return err
 	}

pkg/analyzer/rsAnalyzer.go

@@ -10,10 +10,11 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-func AnalyzeReplicaSet(ctx context.Context, client *kubernetes.Client, aiClient ai.IAI, explain bool, analysisResults *[]Analysis) error {
+func AnalyzeReplicaSet(ctx context.Context, config *AnalysisConfiguration,
+	client *kubernetes.Client, aiClient ai.IAI, analysisResults *[]Analysis) error {
 
 	// search all namespaces for pods that are not running
-	list, err := client.GetClient().AppsV1().ReplicaSets("").List(ctx, metav1.ListOptions{})
+	list, err := client.GetClient().AppsV1().ReplicaSets(config.Namespace).List(ctx, metav1.ListOptions{})
 	if err != nil {
 		return err
 	}

pkg/analyzer/serviceAnalyzer.go

@@ -4,16 +4,18 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/fatih/color"
 	"github.com/k8sgpt-ai/k8sgpt/pkg/ai"
 	"github.com/k8sgpt-ai/k8sgpt/pkg/kubernetes"
 	"github.com/k8sgpt-ai/k8sgpt/pkg/util"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-func AnalyzeEndpoints(ctx context.Context, client *kubernetes.Client, aiClient ai.IAI, explain bool, analysisResults *[]Analysis) error {
+func AnalyzeEndpoints(ctx context.Context, config *AnalysisConfiguration, client *kubernetes.Client, aiClient ai.IAI,
+	analysisResults *[]Analysis) error {
 
 	// search all namespaces for pods that are not running
-	list, err := client.GetClient().CoreV1().Endpoints("").List(ctx, metav1.ListOptions{})
+	list, err := client.GetClient().CoreV1().Endpoints(config.Namespace).List(ctx, metav1.ListOptions{})
 	if err != nil {
 		return err
 	}
@@ -27,7 +29,8 @@ func AnalyzeEndpoints(ctx context.Context, client *kubernetes.Client, aiClient a
 		if len(ep.Subsets) == 0 {
 			svc, err := client.GetClient().CoreV1().Services(ep.Namespace).Get(ctx, ep.Name, metav1.GetOptions{})
 			if err != nil {
-				return err
+				color.Yellow("Service %s/%s does not exist", ep.Namespace, ep.Name)
+				continue
 			}
 
 			for k, v := range svc.Spec.Selector {