Merge branch 'master' of https://github.com/openebs/openebs into ranj…

…ith-cassandra-typo
meghanareddy-k · Oct 19, 2020 · ed6993f · ed6993f
2 parents 9e36f75 + 210b387
commit ed6993f
Show file tree

Hide file tree

Showing 13 changed files with 631 additions and 36 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,18 +6,19 @@ Firstly, if you are unsure or afraid of anything, just ask or submit the issue o
 
 However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document will cover all the points we're looking for in your contributions, raising your chances of quickly merging or addressing your contributions.
 
-That said, OpenEBS is an innovation in Open Source. You are welcome to contribute in any way you can and all the help provided is very much appreciated. 
+That said, OpenEBS is an innovation in Open Source. You are welcome to contribute in any way you can and all the help provided is very much appreciated.
 
 - [Raise issues to request new functionality, fix documentation or for reporting bugs.](#raising-issues)
-- [Submit changes to improve documentation.](#submit-change-to-improve-documentation) 
+- [Submit changes to improve documentation.](#submit-change-to-improve-documentation)
 - [Submit proposals for new features/enhancements.](#submit-proposals-for-new-features)
 - [Solve existing issues related to documentation or code.](#contributing-to-source-code-and-bug-fixes)
 
-There are a few simple guidelines that you need to follow before providing your hacks. 
+There are a few simple guidelines that you need to follow before providing your hacks.
 
 ## Raising Issues
 
 When raising issues, please specify the following:
+
 - Setup details need to be filled as specified in the issue template clearly for the reviewer to check.
 - A scenario where the issue occurred (with details on how to reproduce it).
 - Errors and log messages that are displayed by the software.
@@ -29,42 +30,45 @@ Getting documentation right is hard! Refer to this [page](./contribute/CONTRIBUT
 
 ## Submit Proposals for New Features
 
-There is always something more that is required, to make it easier to suit your use-cases. Feel free to join the discussion on new features or raise a PR with your proposed change. 
+There is always something more that is required, to make it easier to suit your use-cases. Feel free to join the discussion on new features or raise a PR with your proposed change.
 
-- [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/)
+- [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/)
 
 ## Contributing to Source Code and Bug Fixes
 
 Provide PRs with appropriate tags for bug fixes or enhancements to the source code. For a list of tags that could be used, see [this](./contribute/labels-of-issues.md).
 
-* For contributing to K8s demo, please refer to this [document](./contribute/CONTRIBUTING-TO-K8S-DEMO.md).
-    - For checking out how OpenEBS works with K8s, refer to this [document](./k8s/README.md) 
-- For contributing to Kubernetes OpenEBS Provisioner, please refer to this [document](./contribute/CONTRIBUTING-TO-KUBERNETES-OPENEBS-PROVISIONER.md).
-
+- For contributing to K8s demo, please refer to this [document](./contribute/CONTRIBUTING-TO-K8S-DEMO.md).
+  - For checking out how OpenEBS works with K8s, refer to this [document](./k8s/README.md)
+
+* For contributing to Kubernetes OpenEBS Provisioner, please refer to this [document](./contribute/CONTRIBUTING-TO-KUBERNETES-OPENEBS-PROVISIONER.md).
+
 Refer to this [document](./contribute/design/code-structuring.md) for more information on code structuring and guidelines to follow on the same.
 
 ## Solve Existing Issues
+
 Head over to [issues](https://github.com/openebs/openebs/issues) to find issues where help is needed from contributors. See our [list of labels guide](./contribute/labels-of-issues.md) to help you find issues that you can solve faster.
 
-A person looking to contribute can take up an issue by claiming it as a comment/assign their GitHub ID to it. In case there is no PR or update in progress for a week on the said issue, then the issue reopens for anyone to take up again. We need to consider high priority issues/regressions where response time must be a day or so. 
+A person looking to contribute can take up an issue by claiming it as a comment/assign their GitHub ID to it. In case there is no PR or update in progress for a week on the said issue, then the issue reopens for anyone to take up again. We need to consider high priority issues/regressions where response time must be a day or so.
 
 ---
+
 ### 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 contributors have confirmed their right to license their contribution under the project's license. Please read [developer-certificate-of-origin](./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 <random@developer.example.org>
-````
+```
+
 or use the command `git commit -s -m "commit message comes here"` to sign-off on your commits.
 
 Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
 
 ---
 
-## Join our community 
+## Join our community
 
 Want to actively develop and contribute to the OpenEBS community, refer to this [document](./community/README.md).
diff --git a/README.md b/README.md
@@ -115,4 +115,4 @@ This is a list of third-party companies and individuals who provide products or
 - [Clouds Sky GmbH](https://cloudssky.com/en/)
 - [CodeWave](https://codewave.eu/)
 - [Gridworkz Cloud Services](https://gridworkz.com/)
-- [MayaData](https://mayadata.io/)
+- [MayaData](https://mayadata.io/)
diff --git a/RELEASE.md b/RELEASE.md
@@ -8,9 +8,9 @@ The scope of the release is determined by:
 - the [issues filed by the community](https://github.com/search?q=is%3Aissue+is%3Aopen+label%3Aproject%2Fcommunity+org%3Aopenebs&type=Issues). 
 
 1. The release scope is published and tracked using [GitHub Projects](https://github.com/orgs/openebs/projects). To maintain monthly release cadence, the project tracker is setup with indicative milestones leading up to freezing the feature development in the 3rd week, the remaining days are used to run e2e and fix any issues found by e2e or community. 
-1. At the start of the release cycle, one of the contributor takes on the role of release manager and works with the OpenEBS Maintainers to co-ordinate the release activities.  
+1. At the start of the release cycle, one of the contributors takes on the role of release manager and works with the OpenEBS Maintainers to co-ordinate the release activities.  
 1. Contributors sync-up over [community calls and slack](./community/) to close on the release tasks. Release manager runs the community calls for a given release. In the community call, the risks are identified and mitigated by seeking additional help or by pushing the task to next release.
 1. The various release management tasks are explained in the [release process document](./contribute/process/release-management.md).
 1. OpenEBS release is made via GitHub. Once all the components are released, [Change Summary](https://github.com/openebs/openebs/wiki) is updated and [openebs/openebs](https://github.com/openebs/openebs/releases) repo is tagged with the release. 
-1. OpenEBS release in announced on [all Community reach out channels](./community/).
+1. OpenEBS release is announced on [all Community reach out channels](./community/).
 1. The release tracker GitHub project is closed
diff --git a/k8s/demo/scripts/README.md b/k8s/demo/scripts/README.md
@@ -61,7 +61,3 @@ You will have the following machines ready to use:
 
 ## How-T0
 - [Setup Passwordless SSH](./setup-passwordless-ssh.md)
-
-## Next Steps
-- [Configure a Hello-World App](../../dedicated/run-k8s-hello-world.md)
-- [Configure MySQL Pod with OpenEBS Storage](../../dedicated/run-mysql-openebs.md)
diff --git a/k8s/openshift/byo/baremetal/README.md b/k8s/openshift/byo/baremetal/README.md
@@ -25,7 +25,7 @@ successful in resolving the machine IP addresses).
 
 #### Notes: 
 
-- System recommendations for production cluster can be found [here](https://docs.openshift.org/latest/install_config/install/prerequisites.html#hardware).
+- System recommendations for production cluster can be found [here](https://docs.openshift.com/container-platform/3.11/install/prerequisites.html#hardware).
 This document focuses on bringing up a setup for evaluation purposes.
 
 - Ensure that the Docker service is running. 

diff --git a/k8s/upgrades/README.md b/k8s/upgrades/README.md
@@ -16,7 +16,7 @@ If already using CSPC pools and cStor CSI volumes they can be upgraded from `1.1
 
 This document describes the steps for the following OpenEBS Upgrade paths:
 
-- Upgrade from 1.0.0 or later to a newer release up to 2.1.0
+- Upgrade from 1.0.0 or later to a newer release up to 2.2.0
 
 For other upgrade paths of earlier releases, please refer to the respective directories.
 Example: 
@@ -38,7 +38,7 @@ The upgrade of OpenEBS is a three step process:
 
 **Note: It is mandatory to make sure to that all OpenEBS control plane
 and data plane components are running with the expected version before the upgrade.**
-- **For upgrading to the latest release (2.1.0), the previous version should be minimum 1.0.0 **
+- **For upgrading to the latest release (2.2.0), the previous version should be minimum 1.0.0 **
 
 **Note: All steps described in this document need to be performed from a
 machine that has access to Kubernetes master**
@@ -119,8 +119,8 @@ the openebs-operator.yaml for your cluster, you will have to download the
 desired openebs-operator.yaml and customize it again**
 
 ```
-#Upgrade to OpenEBS control plane components to desired version. Say 2.1.0
-$ kubectl apply -f https://openebs.github.io/charts/2.1.0/openebs-operator.yaml
+#Upgrade to OpenEBS control plane components to desired version. Say 2.2.0
+$ kubectl apply -f https://openebs.github.io/charts/2.2.0/openebs-operator.yaml
 ```
 
 ### Upgrade using helm chart (using openebs/openebs, openebs-charts repo, etc.,):
@@ -135,13 +135,13 @@ latest openebs/openebs chart.
 - If the default values seem appropriate, you can use the below commands to
   update OpenEBS. [More](https://hub.helm.sh/charts/openebs/openebs) details about the specific chart version.
   ```sh
-  $ helm upgrade --reset-values <release name> openebs/openebs --version 2.1.0
+  $ helm upgrade --reset-values <release name> openebs/openebs --version 2.2.0
   ```
 - If not, customize the values into your copy (say custom-values.yaml),
   by copying the content from above default yamls and edit the values to
   suite your environment. You can upgrade using your custom values using:
   ```sh
-  $ helm upgrade <release name> openebs/openebs --version 2.1.0 -f custom-values.yaml`
+  $ helm upgrade <release name> openebs/openebs --version 2.2.0 -f custom-values.yaml`
   ```
 
 ### Using customized operator YAML or helm chart.
@@ -168,9 +168,9 @@ backup of the data before starting the below upgrade procedure.
 - Automatic rollback option is not provided. To rollback, you need to update
   the controller, exporter and replica pod images to the previous version
 - Before proceeding with the upgrade of the OpenEBS Data Plane components like cStor or Jiva,  verify that OpenEBS Control plane is indeed in desired version
-  You can use the following command to verify components are in 2.1.0:
+  You can use the following command to verify components are in 2.2.0:
   ```sh
-  $ kubectl get pods -n openebs -l openebs.io/version=2.1.0
+  $ kubectl get pods -n openebs -l openebs.io/version=2.2.0
   ```
   The above command should show that the control plane components are upgrade.
   The output should look like below:
@@ -256,7 +256,7 @@ spec:
         - "--from-version=1.12.0"
 
         # --to-version is the version desired upgrade version
-        - "--to-version=2.1.0"
+        - "--to-version=2.2.0"
 
         # Bulk upgrade is supported
         # To make use of it, please provide the list of PVs
@@ -277,7 +277,7 @@ spec:
 
         # the image version should be same as the --to-version mentioned above
         # in the args of the job
-        image: openebs/m-upgrade:2.1.0
+        image: openebs/m-upgrade:<same-as-to-version>
         imagePullPolicy: Always
       restartPolicy: OnFailure
 ---
@@ -343,7 +343,7 @@ spec:
         - "--from-version=1.12.0"
 
         # --to-version is the version desired upgrade version
-        - "--to-version=2.1.0"
+        - "--to-version=2.2.0"
 
         # Bulk upgrade is supported
         # To make use of it, please provide the list of SPCs
@@ -364,7 +364,7 @@ spec:
 
         # the image version should be same as the --to-version mentioned above
         # in the args of the job
-        image: openebs/m-upgrade:2.1.0
+        image: openebs/m-upgrade:<same-as-to-version>
         imagePullPolicy: Always
       restartPolicy: OnFailure
 ---
@@ -420,7 +420,7 @@ spec:
         - "--from-version=1.12.0"
 
         # --to-version is the version desired upgrade version
-        - "--to-version=2.1.0"
+        - "--to-version=2.2.0"
 
         # Bulk upgrade is supported from 1.9
         # To make use of it, please provide the list of PVs
@@ -441,7 +441,7 @@ spec:
 
         # the image version should be same as the --to-version mentioned above
         # in the args of the job
-        image: openebs/m-upgrade:2.1.0
+        image: openebs/m-upgrade:<same-as-to-version>
         imagePullPolicy: Always
       restartPolicy: OnFailure
 ---