docs: add new slack link (#134) (#135)

Signed-off-by: Sudipto Baral <sudiptobaral.me@gmail.com>

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

.github/workflows/release.yaml

@@ -25,7 +25,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
 
-      - uses: google-github-actions/release-please-action@e0b9d1885d92e9a93d5ce8656de60e3b806e542c # v3
+      - uses: google-github-actions/release-please-action@ee9822ec2c397e8a364d634464339ac43a06e042 # v3
         id: release
         with:
           command: manifest

.release-please-manifest.json

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

CHANGELOG.md

@@ -1,5 +1,33 @@
 # 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)
 
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+contact@k8sgpt.ai.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

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
 
@@ -72,6 +103,11 @@ _Filter on resource_
 k8sgpt analyze --explain --filter=Service
 ```
 
+_Filter by namespace_
+```
+k8sgpt analyze --explain --filter=Pod --namespace=default
+```
+
 _Output to JSON_
 
 ```
@@ -84,19 +120,22 @@ k8sgpt analyze --explain --filter=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.yaml` the data is stored in plain text, including your OpenAI key.
 
-### Contributing
+## Contributing
 
 Please read our [contributing guide](./CONTRIBUTING.md).
-### Community
-* Find us on [Slack](https://cloud-native.slack.com/channels/k8sgpt-ai)
+## Community
+* Find us on [Slack](https://k8sgpt.slack.com/)

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+We currently support the latest release for security patching and will deploy forward releases.
+
+For example if there is a vulnerability in release `0.1.0` we will fix that release in version `0.1.1-fix` or `0.1.1`
+
+## Reporting a Vulnerability
+
+If you are aware of a vulnverability please feel free to disclose it responsibly to contact@k8sgpt.ai or to one of our maintainers in our Slack community.

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,7 +110,7 @@ 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") {
@@ -141,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")

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 == "" {

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

@@ -11,10 +11,11 @@ import (
 	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
 	}