mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00
Code Activity

Contributors updates, Kyverno CLI acknowledgements (#2644)

Browse source 
* add platform to bug template

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* Helm value updates

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* linting, formatting, link updates

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* linting, formatting, updates

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* Updates per contributors meeting; linting, fixes

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* Updated templates with acknowledgement of CLI parity

Signed-off-by: Chip Zoller <chipzoller@gmail.com>

* git => GitHub

Signed-off-by: Chip Zoller <chipzoller@gmail.com>
This commit is contained in:
Chip Zoller 2021-11-06 11:08:42 -04:00 committed by GitHub
parent 4810dda3e9
commit 7c5142b26a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 106 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -42,7 +42,9 @@ Describe the big picture of your changes here to communicate to the maintainers
### Proof Manifests
<!--
Read and follow the [PR documentation guide](https://github.com/kyverno/kyverno/blob/main/.github/pr_documentation.md) for more details first. This section is for pasting your YAML manifests (Kubernetes resources and Kyverno policies) which allow maintainers to prove the intended functionality is achieved by your PR. Please use proper fenced code block formatting, for example:
Read and follow the [PR documentation guide](https://github.com/kyverno/kyverno/blob/main/.github/pr_documentation.md) for more details first. This section is for pasting your YAML manifests (Kubernetes resources and Kyverno policies) and Kyverno CLI test manifests which allow maintainers to prove the intended functionality is achieved by your PR. Please use proper fenced code block formatting, for example:
# Kubernetes resource
```yaml
apiVersion: v1
@ -53,6 +55,25 @@ metadata:
data:
allowed-roles: "[\"cluster-admin\", \"cluster-operator\", \"tenant-admin\"]"
```
# Kyverno CLI test manifest (please see docs for latest manifest format at https://kyverno.io/docs/kyverno-cli/). See kyverno/policies for complete examples of all related test files.
```yaml
name: prepend-image-registry
policies:
- prepend_image_registry.yaml
resources:
- resource.yaml
variables: values.yaml
results:
- policy: prepend-registry
rule: prepend-registry-containers
resource: mypod
# if mutate rule
patchedResource: patchedResource01.yaml
kind: Pod
result: pass
```
-->
## Checklist
@ -65,6 +86,7 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh
- [] I have read the [contributing guidelines](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md).
- [] I have added tests that prove my fix is effective or that my feature works.
- [] My PR contains new or altered behavior to Kyverno and
- [] CLI support should be added my PR doesn't contain that functionality.
- [] I have added or changed [the documentation](https://github.com/kyverno/website) myself in an existing PR and the link is:
<!-- Uncomment to link to the PR -->
<!-- https://github.com/kyverno/website/pull/123 -->

4
.github/pr_documentation.md vendored
View file

@ -139,3 +139,7 @@ spec:
```
See that the Deployment fails now that Kyverno can read from multi-line YAML strings in a ConfigMap.
## 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.

9
CODE_OF_CONDUCT.md
View file

@ -1,6 +1,6 @@
# Kyverno Community Code of Conduct v1.0
### Contributor Code of Conduct
## Contributor Code of Conduct
As contributors and maintainers of this project, and in the interest of fostering
an open and welcoming community, we pledge to respect all people who contribute
@ -18,8 +18,7 @@ Examples of unacceptable behavior by participants include:
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic addresses,
without explicit permission
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
* Other unethical or unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject
@ -34,6 +33,4 @@ when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior in Kubernetes may be reported by contacting the project maintainer(s).
This Code of Conduct is adapted from the the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) and the Contributor Covenant
(http://contributor-covenant.org), version 1.2.0, available at
http://contributor-covenant.org/version/1/2/0/
This Code of Conduct is adapted from the the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) and the [Contributor Covenant](https://www.contributor-covenant.org/), [version 1.2.0](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/).

144
CONTRIBUTING.md
View file

@ -2,126 +2,98 @@
We welcome all contributions, suggestions, and feedback, so please do not hesitate to reach out!
## Ways you can contribute
## Ways you can contribute:
- [Report Issues](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#report-issues)
- [Submit Pull Requests](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#submit-pull-requests)
- [Fix or Improve Documentation](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#fix-or-improve-documentation)
- [Join Our Community Meetings](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md#join-our-community-meetings)
- [Report Issues](#report-issues)
- [Submit Pull Requests](#submit-pull-requests)
- [Fix or Improve Documentation](#fix-or-improve-documentation)
- [Join Our Community Meetings](#join-our-community-meetings)
### Report issues
- Report potential bugs
- Request a feature
- Request a sample policy
Issues to Kyverno help improve the project in multiple ways including the following:
- Report potential bugs
- Request a feature
- Request a sample policy
### Submit Pull Requests
#### Setup local development environments
- Please refer to [Running in development mode](https://github.com/kyverno/kyverno/wiki/Running-in-development-mode) for local setup.
#### Submit a PR for [open issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
### Fix or Improve Documentation
- [Kyverno Docs](https://github.com/kyverno/website)
#### Get started
[Pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PRs) allow you to contribute back the changes you've made on your side enabling others in the community to benefit from your hard work. They are the main source by which all changes are made to this project and are a standard piece of GitHub operational flows. Before you contribute, please take a moment to review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md).
Head over to project repository on github and click the **"Fork"** button. With the forked copy, you can try new ideas and implement changes to the project.
New contributors may easily view all [open issues labeled as good first issues](https://github.com/kyverno/kyverno/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) allowing you to get started in an approachable manner.
- **Clone the repository to your device:**
Once you wish to get started contributing to the code base, please refer to our [running in development mode](https://github.com/kyverno/kyverno/wiki/Running-in-development-mode) for local setup guide.
In the process of submitting your PRs, please read and abide by the template provided to ensure the maintainers are able to understand your changes and quickly come up to speed. There are some important pieces that are required outside of the code itself. Some of these are up to you, others are up to the maintainers.
1. Provide Proof Manifests allowing the maintainers and other contributors to verify your changes without requiring they understand the nuances of all your code.
2. For new or changed functionality, this typically requires documentation and so raise a corresponding issue (or, better yet, raise a separate PR) on the [documentation repository](https://github.com/kyverno/website).
3. Test your change with the [Kyverno CLI](https://kyverno.io/docs/kyverno-cli/) and provide a test manifest in the proper format. If your feature/fix does not work with the CLI, a separate issue requesting CLI support must be made.
4. Indicate which release this PR is triaged for (maintainers). This step is important especially for the documentation maintainers in order to understand when and where the necessary changes should be made.
#### Getting started with your PR
Head over to the project repository on GitHub and click the **"Fork"** button. With the forked copy, you can try new ideas and implement changes to the project.
**Clone the repository to your device:**
Get the link of your forked repository, paste it in your device terminal and clone it using the command.
```
$ git clone https://hostname/YOUR-USERNAME/YOUR-REPOSITORY
```sh
git clone https://hostname/YOUR-USERNAME/YOUR-REPOSITORY
```
- **Create a branch:**
**Create a branch:**
Create a new brach and navigate to the branch using this command.
Create a new brach and navigate to the branch using this command.
```
$ git checkout -b <new-branch>
```
```sh
git checkout -b <new-branch>
```
Great, its time to start hacking, You can now go ahead to make all the changes you want.
Great, it's time to start hacking! You can now go ahead to make all the changes you want.
**Stage, Commit, and Push changes:**
- **Stage, Commit and Push changes:**
Now that we have implemented the required changes, use the command below to stage the changes and commit them.
Now that we have implemented the required changes, use the command below to stage the changes and commit them
```sh
git add .
```
```
$ git add .
```
```sh
git commit -s -m "Commit message"
```
```
$ git commit -s -m "Commit message"
```
The `-s` signifies that you have signed off the the commit.
The -s signifies that you have signed off the the commit.
Go ahead and push your changes to GitHub using this command.
Go ahead and push your changes to github using this command.
```
$ git push
```
```sh
git push
```
### Fix or Improve Documentation
The [Kyverno website](https://kyverno.io), like the main Kyverno codebase, is stored in its own [git repo](https://github.com/kyverno/website). To get started with contributions to the documentation, [follow the guide](https://github.com/kyverno/website#contributing) on that repository.
### Engage with us
The website has the most updated information on [how to engage with the Kyverno community](https://kyverno.io/community/) including its maintainers and contributors.
Before you contribute, please review and agree to abide by our community [Code of Conduct](/CODE_OF_CONDUCT.md).
### Join Our Community Meetings
The easiest way to reach us is on the [Kubernetes slack #kyverno channel](https://app.slack.com/client/T09NY5SBT/CLGR9BJU9).
## Developer Certificate of Origin (DCO) Sign off
For contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project, we are requiring everyone to acknowledge this by signing their work.
For contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project, we are requiring everyone to acknowledge this by signing their work which indicates you agree to the DCO found [here](https://developercertificate.org/).
To sign your work, just add a line like this at the end of your commit message:
```
```sh
Signed-off-by: Random J Developer <random@developer.example.org>
```
This can easily be done with the `-s` command line option to append this automatically to your commit message.
```sh
git commit -s -m 'This is my commit message'
```
$ git commit -s -m 'This is my commit message'
```
By doing this you state that you can certify the following (https://developercertificate.org/):
```
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```

45
README.md
View file

@ -2,58 +2,53 @@
**Kubernetes Native Policy Management 🎉**
![build](https://github.com/kyverno/kyverno/workflows/build/badge.svg)
![prereleaser](https://github.com/kyverno/kyverno/workflows/prereleaser/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/kyverno/kyverno)](https://goreportcard.com/report/github.com/kyverno/kyverno)
![build](https://github.com/kyverno/kyverno/workflows/build/badge.svg)
![prereleaser](https://github.com/kyverno/kyverno/workflows/prereleaser/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/kyverno/kyverno)](https://goreportcard.com/report/github.com/kyverno/kyverno)
![License: Apache-2.0](https://img.shields.io/github/license/kyverno/kyverno?color=blue)
[![GitHub Repo stars](https://img.shields.io/github/stars/kyverno/kyverno)](https://github.com/kyverno/kyverno/stargazers)
<a href="https://kyverno.io" rel="kyverno.io">![logo](img/Kyverno_Horizontal.png)</a>
<p class="callout info" style="font-size: 100%;">
Kyverno is a policy engine designed for Kubernetes. It can validate, mutate, and generate configurations using admission controls and background scans. Kyverno policies are Kubernetes resources and do not require learning a new language. Kyverno is designed to work nicely with tools you already use like kubectl, kustomize, and Git.
</p>
## 📙 Documentation
## 📙 Documentation
Kyverno installation and reference documents are available at: <a href="https://kyverno.io/">kyverno.io</a>.
Kyverno installation and reference documents are available at kyverno.io.
👉 **[Quick Start](https://kyverno.io/docs/introduction/#quick-start)**
👉 **[Quick Start](https://kyverno.io/docs/introduction/#quick-start)**
👉 **[Installation](https://kyverno.io/docs/installation/)**
👉 **[Sample Policies](https://kyverno.io/policies/)**
👉 **[Installation](https://kyverno.io/docs/installation/)**
👉 **[Sample Policies](https://kyverno.io/policies/)**
## 🙋‍♂️ Getting Help
We are here to help!
We are here to help!
👉 For feature requests and bugs, file an [issue](https://github.com/kyverno/kyverno/issues).
👉 For feature requests and bugs, file an [issue](https://github.com/kyverno/kyverno/issues).
👉 For discussions or questions, join the slack channel [k8s.slack.io/#kyverno](https://slack.k8s.io/#kyverno).
👉 For discussions or questions, join the [Kyverno Slack channel](https://slack.k8s.io/#kyverno).
👉 For community meeting access join the [mailing list](https://groups.google.com/g/kyverno).
👉 To get updates ⭐️ [star this repository](https://github.com/kyverno/kyverno/stargazers).
👉 For community meeting access, join the [mailing list](https://groups.google.com/g/kyverno).
👉 To get updates ⭐️ [star this repository](https://github.com/kyverno/kyverno/stargazers).
## ➕ Contributing
Thanks for your interest in contributing to Kyverno! Here are some steps to help get you started:
✔ Read and agree to the [Contribution Guidelines](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md).
✔ Read and agree to the [Contribution Guidelines](/CONTRIBUTING.md).
✔ Browse through the [GitHub discussions](https://github.com/kyverno/kyverno/discussions).
✔ Browse through the [GitHub discussions](https://github.com/kyverno/kyverno/discussions).
✔ Read Kyverno design and development details on the [GitHub Wiki](https://github.com/kyverno/kyverno/wiki).
✔ Check out the **[good first issue](https://github.com/kyverno/kyverno/labels/good%20first%20issue)** list. Add a comment with `/assign` to request assignment of the issue.
✔ Checkout out the Kyverno <a href="https://kyverno.io/community">Community</a> page for other ways to get involved.
✔ Read Kyverno design and development details on the [GitHub Wiki](https://github.com/kyverno/kyverno/wiki).
✔ Check out the [good first issues](https://github.com/kyverno/kyverno/labels/good%20first%20issue) list. Add a comment with `/assign` to request assignment of the issue.
✔ Checkout out the Kyverno [Community page](https://kyverno.io/community/) for other ways to get involved.
## Contributors
@ -64,7 +59,3 @@ Kyverno is built and maintained by our growing community of contributors!
</a>
Made with [contributors-img](https://contrib.rocks).