Let's start with the relationship between several related projects:
- Kubernetes is a container orchestration system, and is used to run containers on a cluster
- hostpath-provisioner (hpp) is a storage provisioner provides filesystem based local storage to kubernetes. The hpp is a fully compatible CSI driver.
As an add-on to Kubernetes, hpp shares some philosophy and design choices:
- Mostly written in golang
- Often related to distributed microservice architectures
- Declarative and Reactive (Operator pattern) approach
This short page shall help to get started with the projects and topics surrounding them. If you notice a strong similarity with the KubeVirt contribution guidelines it's because we have taken inspiration from their success.
Contributing to the hostpath provisioner should be as simple as possible. Have a question? Want to discuss something? Want to contribute something? Just open an Issue or a Pull Request. For discussion, we use the KubeVirt Google Group.
If you spot a bug or want to change something pretty simple, just go ahead and open an Issue and/or a Pull Request, including your changes at kubevirt/hostpath-provisioner.
For bigger changes, please create a tracker Issue, describing what you want to do. Then either as the first commit in a Pull Request, or as an independent Pull Request, provide an informal design proposal of your intended changes.
To make yourself comfortable with the code, you might want to work on some Issues marked with one or more of the following labels help wanted, good first issue, or bug. Any help is greatly appreciated.
Untested features do not exist. To ensure that what we code really works, relevant flows should be covered via unit tests and functional tests. So when thinking about a contribution, also think about testability. All tests can be run local without the need of CI.
Maintainers are here to help you enabling your use-case in a reasonable amount of time. The maintainers will try to review your code and give you productive feedback in a reasonable amount of time. However, if you are blocked on a review, or your Pull Request does not get the attention you think it deserves, reach out for us via Comments in your Issues, or ping us on Slack.
Maintainers are:
- @awels
Before your PR can be merged it must meet the following criteria:
- README.md has been updated if core functionality is affected.
- Complex features need standalone documentation in a tracker issue that can be closed by a PR.
- Getting started
- Getting started
- Developer Guide
- Documentation
- Getting started
- Details
- Golang
- Patterns
- Introducing Operators: Putting Operational Knowledge into Software
- Microservices nice content by Martin Fowler
- Testing