-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): prepare v2.12.x as the last branch for maintenance (#…
…1819) - Update readme with new location of code - Add deprecate note to all user facing CRDs - shift to using legacy operator - Use the legacy operator set with v2.12.x branch images - Replace references to master with HEAD - update release sequence steps Signed-off-by: kmova <[email protected]>
- Loading branch information
Showing
11 changed files
with
75 additions
and
85 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 |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ OpenEBS uses the standard GitHub pull requests process to review and accept cont | |
| * If you are a first-time contributor, please see [Steps to Contribute](#steps-to-contribute). | ||
| * If you have documentation improvement ideas, go ahead and create a pull request. See [Pull Request checklist](#pull-request-checklist). | ||
| * If you would like to make code contributions, please start with [Setting up the Development Environment](#setting-up-your-development-environment). | ||
| * 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). | ||
|
|
||
| ## Steps to Contribute | ||
|
|
||
|
|
@@ -30,11 +30,11 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed | |
| - Commit header (first line) should convey what changed. | ||
| - Commit body should include details such as why the changes are required and how the proposed changes. | ||
| - DCO Signed. | ||
| * 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). | ||
|
|
||
| ## Sign your work | ||
|
|
||
| We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. 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 project. 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]> | ||
|
|
@@ -57,7 +57,7 @@ For setting up a Development environment on your local host, see the detailed in | |
| ## Reviews against Pull Requests | ||
|
|
||
| A PR can be reviewed by both core as well as external contributors. Below can be referred to during reviews: | ||
| - contributor should be familiar with maya's [idiomatic standards](https://github.com/openebs/maya/blob/master/docs/idiomatic-maya-guide.md) | ||
| - contributor should be familiar with maya's [idiomatic standards](https://github.com/openebs/maya/blob/HEAD/docs/idiomatic-maya-guide.md) | ||
| - contributor should fix all the linting issues raised by the lint tools integrated with maya | ||
| - contributor should try to implement relevant golang based unit tests for the fix/enhancement | ||
| - contributor should try to rework on the review comments as much as possible | ||
|
|
||
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). | ||
| [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 |
|---|---|---|
| @@ -1,92 +1,66 @@ | ||
| ## Overview | ||
|
|
||
| [](https://travis-ci.org/openebs/maya) | ||
| [](https://www.codacy.com/app/OpenEBS/maya?utm_source=github.com&utm_medium=referral&utm_content=openebs/maya&utm_campaign=Badge_Grade) | ||
| [](https://app.travis-ci.com/openebs/maya) | ||
| [](https://goreportcard.com/report/github.com/openebs/maya) | ||
| [](https://codecov.io/gh/openebs/maya) | ||
| [](https://godoc.org/github.com/openebs/maya) | ||
| [](https://github.com/openebs/maya/blob/master/LICENSE) | ||
| [](https://codecov.io/gh/openebs/maya) | ||
| [](https://github.com/openebs/maya/blob/HEAD/LICENSE) | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fmaya?ref=badge_shield) | ||
| [](https://bestpractices.coreinfrastructure.org/projects/1753) | ||
|
|
||
| *Visit [https://docs.openebs.io](https://docs.openebs.io) to learn about Container Attached Storage(CAS) and full documentation on using OpenEBS Maya*. | ||
|
|
||
| ## Project Status: Deprecated | ||
|
|
||
| Although all the components still work, this repo is now deprecated, moving work to following repo, come join us there ! | ||
|
|
||
| - [cstor-operators](https://github.com/openebs/cstor-operators) | ||
| - [Jiva-operators](https://github.com/openebs/jiva-operator) | ||
| - [LocalPV](https://github.com/openebs/dynamic-localpv-provisioner) | ||
|
|
||
| *OpenEBS Maya* extends the capabilities of Kubernetes to orchestrate CAS (aka Container Native) Storage Solutions like OpenEBS Jiva, OpenEBS cStor, etc. *Maya* (meaning *Magic*), seamlessly integrates into the Kubernetes Storage Workflow and helps provision and manage the CAS based Storage Volumes. The core-features of *Maya* include: | ||
|
|
||
| - Maintaining the inventory of the underlying disks on the Kubernetes Nodes. | ||
|
|
||
| - Managing the allocation of Disks to CAS Storage Engines. | ||
|
|
||
| - Provisioning of CAS Volumes by interfacing with K8s Dynamic Volume Provisioner. | ||
|
|
||
| - Managing the high availability of the CAS volumes by tuning the scheduling parameters of CAS Deployments (Pods). | ||
| ## Overview | ||
|
|
||
| - Provide adapters to CAS Volumes to interact with Kubernetes and related infrastructure components like Prometheus, Grafana etc. | ||
| OpenEBS control plane components like provisioners and operators were hosted in this repository. | ||
|
|
||
| *Maya* orchestration and management capabilities are delivered through a set of services and tools. Currently, these services support deploying the CAS Storage Solutions in Kubernetes Clusters. In future, these can be extended to support other Container Orchestrators. | ||
| As the OpenEBS community started to add new engines, the engine specific control plane components have been moved to their respective repositories. | ||
| - cStor operators and CSI driver have moved to [openebs/cstor-operators](https://github.com/openebs/cstor-operators) and [openebs/cstor-csi](https://github.com/openebs/cstor-csi) respectively. | ||
| - Jiva operator and CSI driver have moved to [openebs/jiva-operator](https://github.com/openebs/jiva-operator) | ||
| - Local PV Hostpath and Device provisioner has been moved to [openebs/dynamic-localpv-provisioner](https://github.com/openebs/dynamic-localpv-provisioner) | ||
| - Jiva and cStor prometheus metrics exporter been moved to [openebs/m-exporter](https://github.com/openebs/m-exporter) | ||
| - `mayactl` for displaying status of Jiva and cStor volumes is merged into [openebs/openebsctl](https://github.com/openebs/openebsctl) | ||
|
|
||
| ## Maya Architecture | ||
| This repository mainly contains code required for running the legacy cStor and Jiva pools and volumes like: | ||
| - `m-apiserver` - used for provisoining the legacy cStor and Jiva pools and volumes. | ||
| - `mayactl` - packaged along with `m-apiserver` for fetching the legacy cStor and Jiva volume status. | ||
| - `admission-server` - used for validating Jiva and cStor pool and volume requests. | ||
| - `m-upgrade` - used for upgrading the legacy Jiva volumes, cStor pools and volumes. | ||
| - `cstor-pool-mgmt` and `cstor-volume-mgmt` - used for managing the legacy cStor pool and volumes. | ||
|
|
||
|  | ||
| With OpenEBS 3.0, all of the above legacy components are deprecated and users are requested to migrate towards using: | ||
| - CStor CSI Driver | ||
| - Jiva CSI Driver | ||
|
|
||
| **Maya** components can be broadly classified based on their deployment type as follows: | ||
| The steps to migrate are provided here: https://github.com/openebs/upgrade. | ||
|
|
||
| - **Control Plane Components** - These are containers that are initialized as part of enabling OpenEBS in a Kubernetes cluster. | ||
| - *maya-apiserver* helps with the creation of CAS Volumes and provides API endpoints to manage those volumes. *maya-apiserver* can also be considered as a template engine that can be easily extended to support any kind of CAS storage solutions. It takes as input a set of CAS templates that are converted into CAS K8s YAMLs based on user requests. | ||
| - *provisioner* is an implementation of Kubernetes Dynamic Provisioner that processes the PVC requests by interacting with maya-apiserver. | ||
| `v2.12.x` is the last active branch on this repository, that will be used to mainly resolve any security vulnerability or kubernetes compatibility issues found on production setups using the legacy provisioners. New features will be developed only cStor and Jiva CSI drivers. | ||
|
|
||
| - **CAS Side-car Components** - These are adapter components that help with managing the CAS containers that do not inherently come up with the required endpoints. For example: | ||
| - *maya-exporter* helps in providing a metrics endpoint to the CAS container. | ||
| - *cas-mgmt* components can be attached as side-cars for helping to store/retrieve configuration information from Kubernetes Config Store (etcd). For cStor CAS solution, cstor-pool-mgmt is one such *cas-mgmt* component. | ||
| ## Install | ||
|
|
||
| - **CLI** - While most of the operations can be performed via the kubectl, *Maya* also comes with *mayactl* that helps retrieve storage related information for debugging/troubleshooting storage related issues. | ||
| Please refer to our documentation at [OpenEBS Documentation](http://openebs.io/). | ||
|
|
||
| ## Install | ||
| ## Release | ||
|
|
||
| Please refer to our documentation at [OpenEBS Documentation](http://docs.openebs.io/). | ||
| Prior to creating a release tag on this repository on `v2.12.x` branch with the required fixes, ensure that the dependent data engine repositories and provisioner are tagged. Once the code is merged, use the following sequence to release a new version for the legacy components: | ||
| - (Optional) New release tag on v2.12.x branch of [openebs/linux-utils](https://github.com/openebs/linux-utils) | ||
| - (Optional) New release tag on v0.6.x branch of [openebs/ndm](https://github.com/openebs/node-disk-manager) | ||
| - New release tag on v2.12.x branch of [openebs/cstor](https://github.com/openebs/cstor) and [openebs/libcstor](https://github.com/openebs/libcstor) | ||
| - New release tag on v2.12.x branch of [openebs/jiva](https://github.com/openebs/jiva) | ||
| - New release tag on v2.12.x branch of [openebs/openebs-k8s-provisioner](https://github.com/openebs/openebs-k8s-provisioner) | ||
| - New release tag on v2.12.x branch of [openebs/m-exporter](https://github.com/openebs/m-exporter) | ||
| - New release tag on v2.12.x branch of [openebs/maya](https://github.com/openebs/maya) | ||
| - New release tag on v2.12.x branch of [openebs/velero-plugin](https://github.com/openebs/velero-plugin) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Head over to the [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
| We are looking at further refactoring this repository by moving the common packages from this repository into a new common repository. If you are interested in helping with the refactoring efforts, please reach out to the OpenEBS Community. | ||
|
|
||
| For details on setting up the development environment and fixing the code, head over to the [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
|
|
||
| ## Community | ||
|
|
||
| OpenEBS welcomes your feedback and contributions in any form possible. | ||
|
|
||
| - [Join OpenEBS community on Kubernetes Slack](https://kubernetes.slack.com) | ||
| - Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/) | ||
| - Want to raise an issue or help with fixes and features? | ||
| - See [open issues](https://github.com/openebs/openebs/issues) | ||
| - See [contributing guide](./CONTRIBUTING.md) | ||
| - See [Project Roadmap](https://github.com/orgs/openebs/projects) | ||
| - Checkout our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters) and their [feedbacks](https://github.com/openebs/openebs/issues/2719). | ||
| - Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view). | ||
| - Join our OpenEBS CNCF Mailing lists | ||
| - For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements) | ||
| - For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users) | ||
|
|
||
|
|
||
| ## More Info | ||
|
|
||
| - Design proposals for *Maya* components are located at [OpenEBS Designs directory](https://github.com/openebs/openebs/tree/master/contribute/design). | ||
|
|
||
| - The issues related to *Maya* are logged under [openebs/openebs](https://github.com/openebs/openebs/issues). | ||
|
|
||
| - To build Maya from the source code, see [developer's documentation](https://github.com/openebs/maya/blob/master/docs/developer.md). | ||
|
|
||
| - Maya uses [golang dep](https://github.com/golang/dep) to manage dependencies. | ||
|
|
||
| - The source code for OpenEBS Provisioner is available at [openebs/external-storage](https://github.com/openebs/external-storage). | ||
|
|
||
| - *mayactl* is shipped along with the maya-apiserver container. | ||
| - Already signed up? Head to our discussions at: | ||
| - [#openebs](https://kubernetes.slack.com/messages/openebs/) | ||
| - [#openebs-dev](https://kubernetes.slack.com/messages/openebs-dev/) | ||
|
|
||
| ## License | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fmaya?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
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
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
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 |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| ## 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]> | ||
|
|
@@ -21,4 +21,4 @@ If PR is about adding a new feature or bug fix then the Author of the PR is expe | |
| ```sh | ||
| maya/changelogs/unreleased <- folder | ||
| 12-github_user_name <- file | ||
| ``` | ||
| ``` | ||
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
Oops, something went wrong.