diff --git a/.github/ISSUE_TEMPLATE/bug-cli.yaml b/.github/ISSUE_TEMPLATE/bug-cli.yaml new file mode 100644 index 0000000000..4205dc7844 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-cli.yaml @@ -0,0 +1,91 @@ +name: "Bug Report: CLI" +description: Report a bug in the Kyverno CLI. +title: "[Bug] [CLI] " +labels: ["bug", "type:cli"] +body: + - type: markdown + attributes: + value: | + Please tell us about the bug, but before doing so ensure you have read the documentation on the CLI functionality found [here](https://kyverno.io/docs/kyverno-cli/). + - type: dropdown + id: kyverno-version + attributes: + label: Kyverno CLI Version + description: >- + What version of the Kyverno CLI are you running (`kyverno version`)? + options: + - 1.4.x + - 1.5.x + - 1.6.x + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Description + description: Describe what happened. + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: true + - type: textarea + id: bug-reproduce-steps + attributes: + label: Steps to reproduce + description: >- + What are the exact steps needed to reproduce the bug you experienced? Please provide any and all manifests needed to reproduce your issue, including Kyverno policies and test Kubernetes resources. + GitHub supports [syntax highlighting](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) with code blocks. + # placeholder: Tell us what you see! + value: |- + 1. + validations: + required: true + - type: textarea + id: bug-expectations + attributes: + label: Expected behavior + description: What did you expect to happen? + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: true + - type: textarea + id: bug-screenshots + attributes: + label: Screenshots + description: >- + If you have any screenshots that would help, please paste them below. + GitHub allows you to copy-and-paste directly from the clipboard into the text area. + **Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below. + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: false + - type: textarea + id: logs + attributes: + label: Kyverno logs + description: >- + Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + Kyverno CLI logs may be found by passing the -v flag to any command. + render: shell + - type: input + id: slack + attributes: + label: Slack discussion + description: >- + If this issue is the result of a discussion thread on Slack, please provide the link to the discussion for reference. + # placeholder: ex. email@example.com + validations: + required: false + - type: checkboxes + id: troubleshooting + attributes: + label: Troubleshooting + description: >- + By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem. + options: + - label: I have read and followed the [troubleshooting guide](https://kyverno.io/docs/troubleshooting/). + required: true + - label: I have searched other issues in this repository and mine is not recorded. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-webhook.yaml b/.github/ISSUE_TEMPLATE/bug-webhook.yaml new file mode 100644 index 0000000000..d86bab60e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-webhook.yaml @@ -0,0 +1,136 @@ +name: "Bug Report: Webhook" +description: Report a bug with the Kyverno webhook. +title: "[Bug] " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please tell us about the bug, but before doing so ensure you have read the [documentation](https://kyverno.io/docs/). + - type: dropdown + id: kyverno-version + attributes: + label: Kyverno Version + description: What version of Kyverno are you running? + options: + - 1.4.x + - 1.5.x + - 1.6.x + validations: + required: true + - type: dropdown + id: k8s-version + attributes: + label: Kubernetes Version + description: What version of Kubernetes are you running? + options: + - 1.20.x + - 1.21.x + - 1.22.x + - 1.23.x + validations: + required: true + - type: dropdown + id: k8s-platform + attributes: + label: Kubernetes Platform + description: What Kubernetes platform are you using? + options: + - EKS + - GKE + - AKS + - KinD + - Minikube + - K3d + - OpenShift + - VMware Tanzu (specify in description) + - Bare metal + - Other (specify in description) + validations: + required: true + - type: dropdown + id: kyverno-rule + attributes: + label: Kyverno Rule Type + description: What Kyverno rule type? + options: + - Validate + - Mutate + - Generate + - imageVerify + - Other + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Description + description: Describe what happened. + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: true + - type: textarea + id: bug-reproduce-steps + attributes: + label: Steps to reproduce + description: >- + What are the exact steps needed to reproduce the bug you experienced? + Please provide any and all manifests needed to reproduce your issue, including Kyverno policies and test Kubernetes resources. + GitHub supports [syntax highlighting](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) with code blocks. + # placeholder: Tell us what you see! + value: |- + 1. + validations: + required: true + - type: textarea + id: bug-expectations + attributes: + label: Expected behavior + description: What did you expect to happen? + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: true + - type: textarea + id: bug-screenshots + attributes: + label: Screenshots + description: >- + If you have any screenshots that would help, please paste them below. + GitHub allows you to copy-and-paste directly from the clipboard into the text area. + **Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below. + # placeholder: Tell us what you see! + # value: "asdf" + validations: + required: false + - type: textarea + id: logs + attributes: + label: Kyverno logs + description: >- + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + For help on how to view Pod logs in Kubernetes, see [here](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-running-pod/#examine-pod-logs). + For guidance on how to enable more verbose log output in Kyverno, see [the documentation](https://kyverno.io/docs/troubleshooting/#policies-are-partially-applied). + render: shell + - type: input + id: slack + attributes: + label: Slack discussion + description: >- + If this issue is the result of a discussion thread on Slack, please provide the link to the discussion for reference. + # placeholder: ex. email@example.com + validations: + required: false + - type: checkboxes + id: troubleshooting + attributes: + label: Troubleshooting + description: >- + By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem. + options: + - label: I have read and followed the documentation AND the [troubleshooting guide](https://kyverno.io/docs/troubleshooting/). + required: true + - label: I have searched other issues in this repository and mine is not recorded. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5a3ed176e8..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve. -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Software version numbers** -State the version numbers of applications involved in the bug. - -* Kubernetes version: -* Kubernetes platform (if applicable; ex., EKS, GKE, OpenShift): -* Kyverno version: - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4e74329d2a..a8ecc80c0e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,14 @@ blank_issues_enabled: false contact_links: - - name: Kyverno Community Support (#kyverno channel on the Kubernetes Slack) + - name: Kyverno Documentation Issues + url: https://github.com/kyverno/website/issues/new/choose + about: For any feedback or bug reports on the Kyverno documentation, follow the link. + - name: Kyverno Policy Issues + url: https://github.com/kyverno/policies/issues/new/choose + about: For issues with a sample policy or to request a new one, follow the link. + - name: Kyverno Community Support (#kyverno channel on Kubernetes Slack) url: https://kubernetes.slack.com/archives/CLGR9BJU9 about: Please ask and answer any Kyverno usage questions here. - name: Kyverno Contributor Discussions url: https://github.com/kyverno/kyverno/discussions - about: Please ask and answer questions Kyverno internals questions here. - + about: Please ask and answer questions related to Kyverno internals here. diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000000..bc6d01d69d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,63 @@ +name: "Feature Request" +description: Suggest a new feature for Kyverno to support. +title: "[Feature] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Please explain the new feature. + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Describe the problem. + placeholder: A clear and concise description of the problem statement. + # value: "asdf" + validations: + required: true + - type: textarea + id: solution + attributes: + label: Solution Description + description: Describe the solution you'd like. + placeholder: A clear and concise description of what you want to happen. + # value: "asdf" + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Describe alternatives you've considered. + placeholder: A clear and concise description of any alternative solutions or features you've considered. + # value: "asdf" + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Context + description: Any additional context to this enhancement request. + placeholder: Add any other context or screenshots about the feature request here. + # value: "asdf" + validations: + required: false + - type: input + id: slack + attributes: + label: Slack discussion + description: If this feature request is the result of a discussion thread on Slack, please provide the link to the discussion for reference. + # placeholder: ex. email@example.com + validations: + required: false + - type: checkboxes + id: research + attributes: + label: Research + description: By submitting this issue, you agree that you have performed some basic attempts at researching your problem and solution. + options: + - label: I have read and followed the documentation AND the [troubleshooting guide](https://kyverno.io/docs/troubleshooting/). + required: true + - label: I have searched other issues in this repository and mine is not recorded. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491ef1..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -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. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/sample-policy.md b/.github/ISSUE_TEMPLATE/sample-policy.md deleted file mode 100644 index 354f3be8b9..0000000000 --- a/.github/ISSUE_TEMPLATE/sample-policy.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Sample Policy -about: Suggest a policy that you would like Kyverno to support. -title: '' -labels: '' -assignees: '' - ---- - - - -**Checklist** - - - -- [x] I have verified the policy does not exist in the [samples library](https://kyverno.io/policies/). - -**Is your policy request related to a problem? Please describe.** - -A clear and concise description of what the problem is. - -**Describe the ideal solution you'd like** - -A clear and concise description of what you want to happen. - -**Additional context** - -Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9bbdaef68d..56472d562a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,6 +16,7 @@ You can discuss changes with maintainers in the [Kyverno Slack Channel](https:// Add the milestone label by commenting `/milestone 1.2.3`. --> + ## What type of PR is this - - [ ] I have raised an issue in [kyverno/website](https://github.com/kyverno/website) to track the doc update and the link is: + - [ ] I have raised an issue in [kyverno/website](https://github.com/kyverno/website) to track the documentation update and the link is: diff --git a/.github/pr_documentation.md b/.github/pr_documentation.md index 7880750c41..92ab31436f 100644 --- a/.github/pr_documentation.md +++ b/.github/pr_documentation.md @@ -142,4 +142,8 @@ See that the Deployment fails now that Kyverno can read from multi-line YAML str ## CLI Support -A new feature which has been implemented for the webhook may often need to be available in the [Kyverno CLI](https://kyverno.io/docs/kyverno-cli/) simultaneously. Please ensure your tests and Proof Manifests include one for the `test` command allowing validation of the CLI functionality. If the provided functionality does not work in the CLI, a separate issue may need to be raised. +A new feature which has been implemented for the webhook may often need to be available in the [Kyverno CLI](https://kyverno.io/docs/kyverno-cli/) simultaneously. Please ensure your tests and Proof Manifests include one for the `test` command allowing validation of the CLI functionality. If the provided functionality does not work in the CLI, a separate issue may need to be raised. + +## Cherry Picking for Releases + +Kyverno releases are generated from release branches. When the release branch is created, if there's any change that needs to be back ported for patches we cherry-pick commits to include them in the release. To assist in the cherry-pick process, please check the box that this PR is targeting a specific release branch as reviewers wants to make sure current PR has the right milestone and cherry-pick PR targets to the same release branch.