This repository has been archived by the owner on May 8, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): update helm instructions and versions (#278)
Updates the version of LVM and ZFS Local PV charts. As a pre-step towards 3.0 and enabling CSI drivers for jiva and cstor, made the necessary documentation and values.yaml updates. The premise is that openebs chart will continue its current templates of ndm and local provisioner, while jiva and cstor will be deprecated in favor of the corresponding csi charts. Once 3.0 is released, the recommended way to install cstor, jiva and other engines would be to enable via this umbrella chart. If there is a strong use-case for using only one type of engine in a cluster - the user can opt to install the sub-charts directly. Trimmed down the configuration options in the README to the commonly used options. Also, added Shovan as a maintainer. Signed-off-by: kmova <[email protected]>
- Loading branch information
Showing
12 changed files
with
232 additions
and
257 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,9 @@ | ||
| #### Special notes for your reviewer: | ||
| #### Why is this change required? | ||
|
|
||
| #### What is changed? | ||
|
|
||
| #### Checklist | ||
| [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] | ||
| - [ ] [DCO](https://github.com/helm/charts/blob/master/CONTRIBUTING.md#sign-your-work) signed | ||
| - [ ] [DCO](https://github.com/openebs/charts/blob/HEAD/CONTRIBUTING.md#sign-your-commits) signed | ||
| - [ ] Chart Version bumped | ||
| - [ ] Variables are documented in the README.md | ||
| - [ ] Title of the PR starts with chart name (e.g. `[stable/openebs]`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Chart.lock | ||
| charts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). | ||
| This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/HEAD/code-of-conduct.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ You can contribute to openebs/charts by filling an issue at [openebs/openebs](ht | |
|
|
||
| * If you want to file an issue for bug or feature request, please see [Filing an issue](#filing-an-issue) | ||
| * If you are a first-time contributor, please see [Steps to Contribute](#steps-to-contribute) and code standard(code-standard.md). | ||
| * If you would like to work on something more involved, please connect with the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/master/community) | ||
| * If you would like to work on something more involved, please connect with the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/HEAD/community) | ||
|
|
||
| ## Filing an issue | ||
|
|
||
|
|
@@ -22,15 +22,15 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed | |
| * Find an issue to work on or create a new issue. The issues are maintained at [openebs/openebs](https://github.com/openebs/openebs/issues). | ||
| * Claim your issue by commenting your intent to work on it to avoid duplication of efforts. | ||
| * Fork the repository on GitHub. | ||
| * Create a branch from where you want to base your work (usually master). | ||
| - If you are updating helm charts, create a branch from master. | ||
| * Create a branch from where you want to base your work (usually main). | ||
| - If you are updating helm charts, create a branch from main. | ||
| - If you are updating an artifact, create a branch from gh-pages. | ||
| * Commit your changes by making sure the commit messages convey the need and notes about the commit. | ||
| * Push your changes to the branch in your fork of the repository. | ||
| * Submit a pull request to the original repository. See [Pull Request checklist](#pull-request-checklist) | ||
|
|
||
| ## Pull Request Checklist | ||
| * Rebase to the current master branch before submitting your pull request. | ||
| * Rebase to the current HEAD branch before submitting your pull request. | ||
| * Commits should be as small as possible. Each commit should follow the checklist below: | ||
| - For code changes, add tests relevant to the fixed bug or new feature. | ||
| - Commit header (first line) should convey what changed | ||
|
|
@@ -58,18 +58,18 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed | |
| * `style` - formatting, missing semicolons, linting fix, etc; no significant production code changes | ||
| * `test` - adding missing tests, refactoring tests; no production code change | ||
| * `refactor` - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes | ||
| * `cherry-pick` - if PR is merged in the master branch and raised to release branch(like v1.9.x) | ||
| * `cherry-pick` - if PR is merged in the HEAD branch and raised to release branch(like v1.9.x) | ||
|
|
||
| ## Code Reviews | ||
| All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for more information on using pull requests. | ||
|
|
||
| * If your PR is not getting reviewed or you need a specific person to review it, please reach out to the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/master/community) | ||
| * If your PR is not getting reviewed or you need a specific person to review it, please reach out to the OpenEBS Contributors. See [OpenEBS Community](https://github.com/openebs/openebs/tree/HEAD/community) | ||
|
|
||
| * If PR is fixing any issues from [github-issues](github.com/openebs/openebs/issues) then you need to mention the issue number with a link in PR description. like: _fixes https://github.com/openebs/openebs/issues/56_ | ||
|
|
||
| ## Sign your commits | ||
|
|
||
| We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS projects. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/master/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: | ||
| We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS projects. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/HEAD/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: | ||
|
|
||
| ```` | ||
| Signed-off-by: Random J Developer <[email protected]> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| This is a OpenEBS sub project and abides by the [OpenEBS Project Governance](https://github.com/openebs/openebs/blob/master/GOVERNANCE.md). | ||
| This is a OpenEBS sub project and abides by the [OpenEBS Project Governance](https://github.com/openebs/openebs/blob/HEAD/GOVERNANCE.md). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,4 @@ | |
|
|
||
| #Reviewers | ||
| "Prateek Pandey",@prateekpandey14,MayaData | ||
| "Shovan Maity",@shovanmaity,MayaData | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,102 @@ | ||
| # OpenEBS Helm Chart and other artifacts | ||
|
|
||
| [](https://github.com/openebs/charts/actions) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://github.com/openebs/charts/actions) | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fcharts?ref=badge_shield) | ||
| [](https://kubernetes.slack.com/messages/openebs) | ||
|
|
||
| The content in this repository is published using GitHub pages at https://openebs.github.io/charts/. | ||
|
|
||
| This repository contains OpenEBS Helm charts and other example artifacts like openebs-operator.yaml or example YAMLs. | ||
| <img width="200" align="right" alt="OpenEBS Logo" src="https://raw.githubusercontent.com/cncf/artwork/HEAD/projects/openebs/stacked/color/openebs-stacked-color.png" xmlns="http://www.w3.org/1999/html"> | ||
|
|
||
|
|
||
| This repository contains OpenEBS Helm charts and other example artifacts like openebs-operator.yaml or example YAMLs. The content in this repository is published using GitHub pages at https://openebs.github.io/charts/. | ||
|
|
||
| ## OpenEBS Helm Chart | ||
|
|
||
| The helm chart is located under [./charts/](./charts/) directory. | ||
| The helm chart is located under [./charts/openebs/](./charts/openebs/) directory. | ||
|
|
||
| OpenEBS helm chart is an umbrella chart that pulls together engine specific charts. The engine charts are included as dependencies in [Chart.yaml](charts/openebs/Chart.yaml). | ||
|
|
||
| OpenEBS helm chart will includes common components that are used by multiple engines like: | ||
| - Node Disk Manager related components | ||
| - Dynamic LocalPV (hostpath and device) Provisioner related components | ||
| - Security Policies like RBAC, PSP, Kyverno | ||
|
|
||
| Engine charts included as dependencies are: | ||
| - [cStor](https://github.com/openebs/cstor-operators/tree/HEAD/deploy/helm/charts) | ||
| - [Jiva](https://github.com/openebs/jiva-operator/tree/HEAD/deploy/helm/charts) | ||
| - [ZFS Local PV](https://github.com/openebs/zfs-localpv/tree/HEAD/deploy/helm/charts) | ||
| - [LVM Local PV](https://github.com/openebs/lvm-localpv/tree/HEAD/deploy/helm/charts) | ||
| - [Dynamic NFS](https://github.com/openebs/dynamic-nfs-provisioner/tree/develop/deploy/helm/charts) | ||
|
|
||
| When new changes to helm chart are pushed to master branch, the changes are picked up by [Helm Chart releaser](https://github.com/helm/chart-releaser-action) GitHub Action. The chart releaser will: | ||
| - Upload the new version of the charts to the [GitHub releases](https://github.com/openebs/charts/releases). | ||
| - Update the helm repo index file and push to the [GitHub Pages branch](https://github.com/openebs/charts/tree/gh-pages). | ||
| Some of the other charts that will be included in the upcoming releases are: | ||
| - [Rawfile Local PV](https://github.com/openebs/rawfile-localpv/tree/HEAD/deploy/charts/rawfile-csi) | ||
| - [Mayastor](https://github.com/openebs/mayastor/tree/develop/chart) | ||
| - [Dashboard](https://github.com/openebs/monitoring/tree/develop/deploy/charts/openebs-monitoring) | ||
|
|
||
| ## Mayastor Helm Chart | ||
| > **Note:** cStor and Jiva out-of-tree provisioners will be replaced by respective CSI charts listed above. OpenEBS users are expected to install the cstor and jiva CSI components and migrate the pools and volumes. The steps to migate are available at: https://github.com/openebs/upgrade | ||
| ### Releasing a new version | ||
|
|
||
| - Raise a PR with the required changes to the HEAD branch. | ||
| - Tag the [maintainers](./MAINTAINERS) for review | ||
| - Once changes are reviewed and merged, the changes are picked up by [Helm Chart releaser](https://github.com/helm/chart-releaser-action) GitHub Action. The chart releaser will: | ||
| - Upload the new version of the charts to the [GitHub releases](https://github.com/openebs/charts/releases). | ||
| - Update the helm repo index file and push to the [GitHub Pages branch](https://github.com/openebs/charts/tree/gh-pages). | ||
|
|
||
| Helm chart for Mayastor is currently maintained [along the Mayastor code-base](https://github.com/openebs/Mayastor/tree/develop/chart). Please, note, that it is being actively developed and can change or break without warning. | ||
|
|
||
| ## OpenEBS Artifacts | ||
|
|
||
| The artifacts are located in the [GitHub Pages(gh-pages) branch](https://github.com/openebs/charts/tree/gh-pages). | ||
|
|
||
| The files can be accessed either as github rawfile or as hosted files. Example, openebs operator can be used as follows: | ||
| - As github raw file URL: | ||
| ``` | ||
| kubectl apply -f https://raw.githubusercontent.com/openebs/charts/gh-pages/openebs-operator.yaml | ||
| ``` | ||
| - As hosted URL: | ||
| ``` | ||
| kubectl apply -f https://openebs.github.io/charts/openebs-operator.yaml | ||
| ``` | ||
|
|
||
| This is a collection of YAMLs or scripts that help to perform some OpenEBS tasks like: | ||
| - YAML file to setup OpenEBS via kubectl. | ||
| - [OpenEBS Commons Operator](https://github.com/openebs/charts/blob/gh-pages/openebs-operator.yaml) | ||
| - [OpenEBS cStor](https://github.com/openebs/charts/blob/gh-pages/cstor-operator.yaml) | ||
| - [OpenEBS Jiva](https://github.com/openebs/charts/blob/gh-pages/jiva-operator.yaml) | ||
| - [OpenEBS Hostpath](https://github.com/openebs/charts/blob/gh-pages/hostpath-operator.yaml) | ||
| - [OpenEBS Hostpath and Device](https://github.com/openebs/charts/blob/gh-pages/openebs-operator-lite.yaml) | ||
| - [OpenEBS LVM Local PV](https://github.com/openebs/charts/blob/gh-pages/lvm-operator.yaml) | ||
| - [OpenEBS ZFS Local PV](https://github.com/openebs/charts/blob/gh-pages/zfs-operator.yaml) | ||
| - [OpenEBS NFS PV](https://github.com/openebs/charts/blob/gh-pages/nfs-operator.yaml) | ||
| - YAML file to install OpenEBS prerequisties on hosts via nsenter pods via kubectl. | ||
| - [Setup iSCSI on Ubuntu](https://github.com/openebs/charts/blob/gh-pages/openebs-ubuntu-setup.yaml) | ||
| - [Setup iSCSI on Amazon Linux](https://github.com/openebs/charts/blob/gh-pages/openebs-amazonlinux-setup.yaml) | ||
| - Scripts to push the OpenEBS container images to a custom registry for air-gapped environments. | ||
| - and more. | ||
|
|
||
| The artifacts are located in the [GitHub Pages(gh-pages) branch](https://github.com/openebs/charts/tree/gh-pages). | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [./CONTRIBUTING.md](./CONTRIBUTING.md). | ||
| See [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
|
|
||
| ## License | ||
| ## Community, discussion, and support | ||
|
|
||
| You can reach the maintainers of this project at: | ||
|
|
||
| - [Kubernetes Slack](http://slack.k8s.io/) channels: | ||
| * [#openebs](https://kubernetes.slack.com/messages/openebs/) | ||
| * [#openebs-dev](https://kubernetes.slack.com/messages/openebs-dev/) | ||
| - [Mailing List](https://lists.cncf.io/g/cncf-openebs-users) | ||
|
|
||
| For more ways of getting involved with community, check our [community page](https://github.com/openebs/openebs/tree/HEAD/community). | ||
|
|
||
| [Apache 2.0 License](./LICENSE). | ||
| ### Code of conduct | ||
|
|
||
| Participation in the OpenEBS community is governed by the [CNCF Code of Conduct](./CODE-OF-CONDUCT.md). | ||
|
|
||
|
|
||
|
|
||
| ## License | ||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fcharts?ref=badge_large) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| This is a OpenEBS sub project and abides by the [OpenEBS Security Policy](https://github.com/openebs/openebs/blob/master/SECURITY.md). | ||
| This is a OpenEBS sub project and abides by the [OpenEBS Security Policy](https://github.com/openebs/openebs/blob/HEAD/SECURITY.md). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,27 @@ | ||
| apiVersion: v2 | ||
| version: 2.12.7 | ||
| version: 2.12.8 | ||
| name: openebs | ||
| appVersion: 2.12.1 | ||
| description: Containerized Storage for Containers | ||
| icon: https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/icon/color/openebs-icon-color.png | ||
| description: Containerized Attached Storage for Kubernetes | ||
| icon: https://raw.githubusercontent.com/cncf/artwork/HEAD/projects/openebs/icon/color/openebs-icon-color.png | ||
| home: http://www.openebs.io/ | ||
| keywords: | ||
| - cloud-native-storage | ||
| - block-storage | ||
| - local-storage | ||
| - iSCSI | ||
| - NVMe | ||
| - storage | ||
| - kubernetes | ||
| sources: | ||
| - https://github.com/openebs/openebs | ||
| maintainers: | ||
| - name: kmova | ||
| email: kiran.mova@openebs.io | ||
| email: kiran.mova@mayadata.io | ||
| - name: prateekpandey14 | ||
| email: [email protected] | ||
| email: [email protected] | ||
| - name: shovanmaity | ||
| email: [email protected] | ||
| dependencies: | ||
| - name: openebs-ndm | ||
| version: "1.6.1" | ||
|
|
@@ -35,11 +40,11 @@ dependencies: | |
| repository: "https://openebs.github.io/jiva-operator" | ||
| condition: jiva.enabled | ||
| - name: zfs-localpv | ||
| version: "1.9.5" | ||
| version: "1.9.8" | ||
| repository: "https://openebs.github.io/zfs-localpv" | ||
| condition: zfs-localpv.enabled | ||
| - name: lvm-localpv | ||
| version: "0.8.2" | ||
| version: "0.8.4" | ||
| repository: "https://openebs.github.io/lvm-localpv" | ||
| condition: lvm-localpv.enabled | ||
| - name: nfs-provisioner | ||
|
|
||
Oops, something went wrong.