chore(build): update helm chart with crd changes (#143)

chore(build): update helm chart with crd changes - Update helm chart with Jiva Policy and Jiva volumes CRDs and bump up the chart version - Also updated a few developer related docs. Signed-off-by: kmova <kiran.mova@mayadata.io>
openebs-archive · Sep 2, 2021 · d1824f2 · d1824f2
1 parent 293bc51
commit d1824f2
Show file tree

Hide file tree

Showing 10 changed files with 135 additions and 61 deletions.
diff --git a/.github/ISSUE_TEMPLATE/become-an-adopter.md b/.github/ISSUE_TEMPLATE/become-an-adopter.md
@@ -0,0 +1,21 @@
+---
+name: Become an Adopter
+about: Share how OpenEBS is used in your projects
+title: "[ADOPTER]"
+labels: ''
+assignees: ''
+
+---
+
+<!-- OpenEBS Community is working towards becoming a [CNCF incubating project](https://github.com/cncf/toc/pull/506). One of the requirements is to add an ADOPTERS.md. The purpose of this issue is to get a list of organizations/individuals who are using OpenEBS to power their persistent storage workloads in Kubernetes. 
+
+The idea is to use the information provided in this issue to create the ADOPTERS.md file. -->
+
+Please provide details like:
+
+* Stateful Applications that you are running on OpenEBS
+* Are you evaluating or already using in development, CI/CD, production 
+* Are you using for home use or for your organization
+* A brief description of the use case or details on how OpenEBS is helping your projects. 
+
+If you would like your name (as a home user) or organization name to be added to the ADOPTER.md, please provide a preferred contact handle like GitHub id, Twitter id, LinkedIn id, website, etc.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,7 +1,31 @@
 ## Pull Request template
-Please, go through these steps before you submit a PR.
 
-1. This repository follows semantic versioning convention, therefore each PR title/commit message must follow convention: `<type>(<scope>): <subject>`.
+**Why is this PR required? What issue does it fix?**:
+_Fixes #<issue number>_
+
+**What this PR does?**:
+
+**Does this PR require any upgrade changes?**:
+
+**If the changes in this PR are manually verified, list down the scenarios covered:**:
+
+**Any additional information for your reviewer?** : 
+_Mention if this PR is part of any design or a continuation of previous PRs_
+
+
+**Checklist:**
+- [ ] PR Title follows the convention of  `<type>(<scope>): <subject>`. See examples below. 
+- [ ] Has the change log section been updated? 
+- [ ] Commit has unit tests
+- [ ] Commit has integration tests
+- [ ] (Optional) Does this PR change require updating Helm Chart? If yes, mention the Helm Chart PR #<PR number>
+- [ ] (Optional) Are upgrade changes included in this PR? If not, mention the issue/PR to track: 
+- [ ] (Optional) If documentation changes are required, which issue  https://github.com/openebs/website is used to track them: 
+
+<!--
+PR Title format.
+
+This repository follows semantic versioning convention, therefore each PR title/commit message must follow convention: `<type>(<scope>): <subject>`.
    `type` is defining if release will be triggering after merging submitted changes, details in [CONTRIBUTING.md](../CONTRIBUTING.md).
     Most common types are:
     * `feat`      - for new features, not a new feature for build script
@@ -12,6 +36,13 @@ Please, go through these steps before you submit a PR.
     * `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
 
-IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
-
-**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
+Examples:
+  feat(ha): support faster node failure detection 
+  fix(provisioning): remove the duplicate labels added on volume CR
+  chore(build): upgrade the go version to 1.18
+  docs(user): add monitoring related user guides
+  refactor(provisoining): make use of the new context api
+  test(ut): handling volume deletion failures 
+  test(integation): handling incorrect jiva images
+  test(e2e): running nfs on jiva volumes
+-->
diff --git a/ADOPTERS.md b/ADOPTERS.md
@@ -0,0 +1,21 @@
+# OpenEBS Jiva Adopters
+
+You can see the full list of organizations/users using OpenEBS [here](https://github.com/openebs/openebs/blob/master/ADOPTERS.md).
+
+If you are using Jiva, and would like yourself to be listed in this page as a an adopter, please raise an [issue](https://github.com/openebs/jiva-operator/issues/new?assignees=&labels=&template=become-an-adopter.md&title=%5BADOPTER%5D) with the following details:
+
+- Stateful Applications that you are running on OpenEBS
+- Are you evaluating or already using in development, CI/CD, production
+- Are you using it for home use or for your organization
+- A brief description of the use case or details on how OpenEBS is helping your projects.
+
+If you would like your name (as home user) or organization name to be added to the Adopters.md, please provide a preferred contact handle like github id, twitter id, linkedin id, website etc.
+
+Some of the organizations that have publicly shared the usage of Jiva.
+- [Arista](https://github.com/openebs/openebs/blob/HEAD/adopters/arista/README.md)
+- [CLEW Medical](https://github.com/openebs/openebs/blob/HEAD/adopters/clewmedical/README.md)
+- [Clouds Sky GmbH](https://github.com/openebs/openebs/blob/HEAD/adopters/cloudssky/README.md)
+- [CodeWave](https://github.com/openebs/openebs/blob/HEAD/adopters/codewave/README.md)
+- [Verizon Media](https://github.com/openebs/openebs/blob/HEAD/adopters/verizon/README.md)
+
+You can see the full list of organizations/users using OpenEBS [here](https://github.com/openebs/openebs/blob/master/ADOPTERS.md).
diff --git a/Adopters.md b/Adopters.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+v2.12.2 / 2021-08-31
+========================
+* chore(build): bump csi sidecars and jiva version to 1.12.2 (293bc51, @prateekpandey14)
+* refactor(e2e): migrate jiva e2e tests from openebs/e2e-test to this repo. (@nsathyaseelan)
+* fix(crd): update JivaVolumePolicy parameter(monitor, enableBufio and autoScaling)  (#130, @rajaSahil)
+* feat(policy): add pod AntiAffinity in jiva replica sts using policy (#132, @prateekpandey14)
+
 v2.11.0 / 2021-07-15
 ========================
 * fix(status): fetch volume status using controller podIP (#112, @shubham14bajpai)

diff --git a/README.md b/README.md
@@ -1,44 +1,65 @@
 # Jiva Operator
 
-[![Releases](https://img.shields.io/github/release/openebs/openebs/all.svg?style=flat-square)](https://github.com/openebs/openebs/releases)
 [![Build Status](https://github.com/openebs/jiva-operator/actions/workflows/build.yaml/badge.svg)](https://github.com/openebs/jiva-operator/actions/workflows/build.yml)
 [![Slack](https://img.shields.io/badge/chat!!!-slack-ff1493.svg?style=flat-square)](https://kubernetes.slack.com/messages/openebs)
 [![Community Meetings](https://img.shields.io/badge/Community-Meetings-blue)](https://hackmd.io/hiRcXyDTRVO2_Zs9fp0CAg)
 [![Twitter](https://img.shields.io/twitter/follow/openebs.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=openebs)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/openebs/openebs/blob/master/CONTRIBUTING.md)
 [![Go Report Card](https://goreportcard.com/badge/github.com/openebs/jiva-csi)](https://goreportcard.com/report/github.com/openebs/jiva-operator)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator?ref=badge_shield)
+[![Releases](https://img.shields.io/github/release/openebs/jiva-operator/all.svg?style=flat-square)](https://github.com/openebs/jiva-operator/releases)
+[![Docker Pulls](https://img.shields.io/docker/pulls/openebs/jiva)](https://hub.docker.com/repository/docker/openebs/jiva)
+
+<img width="200" align="right" alt="OpenEBS Logo" src="https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/stacked/color/openebs-stacked-color.png" xmlns="http://www.w3.org/1999/html">
+
+<p align="justify">
+<strong>OpenEBS Jiva Operator</strong> can be used to dynamically provision highly available Kubernetes Persistent Volumes using local (ephemeral) storage available on the Kubernetes nodes. 
+</p>
+<br>
 
 ### Overview
 
-Jiva Operator helps with managing the lifecycle and operations on Jiva Volumes.
+Jiva Operator helps with managing the lifecycle and operations on Jiva Volumes. Jiva Volumes are highly available block volumes that save the data to local storage available on the Kubernetes nodes. Jiva volumes replicate the volume data to multiple nodes to provide resiliency against node failures.
 
-A Jiva Volume comprises of the following components:
+A Jiva Volume comprises of the following Kubernetes components:
 
 - Jiva Controller Deployment and an associated Service.
 - Jiva Replica StatefulSet with Hostpath Local PVs for saving the data.
 - JivaVolume CR containing the status of the volume.
 
-We are always happy to list users who run Jiva in production, check out our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters), and their [feedbacks](https://github.com/openebs/openebs/issues/2719).
+We are always happy to list users who run Jiva in production, check out our existing [adopters](./ADOPTERS.md).
 
-### Compatibility and Feature Matrix
+## Compatibility 
 
-| Project Status | Operator Version | K8s Version | OpenEBS Version | Dynamic Provisioning | Resize (Expansion) | Snapshots | Raw Block | AccessModes |
-| ---------------- | --------------- | ------------------- | --------------- | --------------------------- | ----------- | --------- | --------- | ---------- |
-| Beta | 2.6.0+ |   1.18+   |   2.6.0+   |   yes   |    yes    |   no   |   yes   |   RWO   |
+| K8s Version | Jiva Version     | Project Status
+| ------------| ---------------- | ------------- 
+| 1.18+       | 2.6.0+           | Beta  
+| 1.20+       | 2.12.0+          | Beta  
 
+## Usage
 
+- [Quickstart guide](docs/quickstart.md)
 
-## Usage
 
-- [Quickly deploy it on K8s and get started](docs/quickstart.md)
-- [Policies Tutorial](docs/tutorials/policies.md)
-- [Troubleshooting Guide](https://docs.openebs.io/docs/next/t-jiva.html)
-- [Monitoring](https://github.com/openebs/monitoring/blob/develop/docs/metrics-jiva.md)
+## Supported Features
 
-### Raising Issues And PRs
+- [x] Dynamic provisioning
+- [x] Enforced volume size limit
+- [x] Thin provisioned
+- [x] High Availability
+- [x] Access Modes
+    - [x] ReadWriteOnce
+    - [x] ReadWriteMany (using NFS)
+    - ~~ReadOnlyMany~~
+- [x] Volume modes
+    - [x] `Filesystem` mode
+    - [x] `Block` mode
+- [x] Volume metrics
+- [x] Supports fsTypes: `ext4`, `btrfs`, `xfs`
+- [x] Online expansion: If fs supports it (e.g. ext4, btrfs, xfs)
+- [x] Backup and Restore (using Velero)
+- [x] Supports OS/ARCH: linux/arm64, linux/amd64
 
-If you want to raise any issue for jiva-operator please do that at [openebs/openebs].
 
 ### Contributing
 
@@ -47,7 +68,7 @@ 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 [open issues](https://github.com/openebs/jiva-operator/issues)
   - See [contributing guide](./CONTRIBUTING.md)
   - See [Project Roadmap](https://github.com/openebs/openebs/blob/master/ROADMAP.md#jiva)
   - Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view).
@@ -65,4 +86,4 @@ Please read the community code of conduct [here](./CODE_OF_CONDUCT.md).
 
 
 ## License
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fjiva-operator?ref=badge_large)
diff --git a/deploy/helm/charts/Chart.yaml b/deploy/helm/charts/Chart.yaml
@@ -1,10 +1,10 @@
 apiVersion: v2
 name: jiva
-description: Jiva-Operator helm chart for Kubernetes
+description: Helm chart for OpenEBS Jiva Operator. Jiva provides highly available replication block volumes to Kubernetes stateful workloads using the local storage available on the Kubernetes nodes.
 type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.12.1
+version: 2.12.2
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.
 appVersion: 2.12.2

diff --git a/deploy/helm/charts/crds/jivavolumepolicy.yaml b/deploy/helm/charts/crds/jivavolumepolicy.yaml
@@ -1,3 +1,5 @@
+
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -38,12 +40,6 @@ spec:
           spec:
             description: JivaVolumePolicySpec defines the desired state of JivaVolumePolicy
             properties:
-              autoScaling:
-                description: AutoScaling ...
-                type: boolean
-              enableBufio:
-                description: EnableBufio ...
-                type: boolean
               priorityClassName:
                 description: PriorityClassName if specified applies to the pod If
                   left empty, no priority class is applied.
@@ -1401,8 +1397,9 @@ spec:
                           to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
                         type: object
                     type: object
-                  monitor:
-                    description: Monitor enables or disables the target exporter sidecar
+                  disableMonitor:
+                    description: DisableMonitor will not attach prometheus exporter
+                      sidecar to jiva volume target.
                     type: boolean
                   nodeSelector:
                     additionalProperties:
@@ -1483,9 +1480,6 @@ spec:
                       type: object
                     type: array
                 type: object
-            required:
-            - autoScaling
-            - enableBufio
             type: object
           status:
             description: JivaVolumePolicyStatus is for handling status of JivaVolumePolicy

diff --git a/deploy/helm/charts/crds/jivavolumes.yaml b/deploy/helm/charts/crds/jivavolumes.yaml
@@ -1,3 +1,5 @@
+
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -87,12 +89,6 @@ spec:
                   and replica pods during volume provisioning
                 nullable: true
                 properties:
-                  autoScaling:
-                    description: AutoScaling ...
-                    type: boolean
-                  enableBufio:
-                    description: EnableBufio ...
-                    type: boolean
                   priorityClassName:
                     description: PriorityClassName if specified applies to the pod
                       If left empty, no priority class is applied.
@@ -1501,9 +1497,9 @@ spec:
                               More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
                             type: object
                         type: object
-                      monitor:
-                        description: Monitor enables or disables the target exporter
-                          sidecar
+                      disableMonitor:
+                        description: DisableMonitor will not attach prometheus exporter
+                          sidecar to jiva volume target.
                         type: boolean
                       nodeSelector:
                         additionalProperties:
@@ -1586,9 +1582,6 @@ spec:
                           type: object
                         type: array
                     type: object
-                required:
-                - autoScaling
-                - enableBufio
                 type: object
               pv:
                 type: string

diff --git a/deploy/helm/charts/templates/default-policy.yaml b/deploy/helm/charts/templates/default-policy.yaml
@@ -5,8 +5,6 @@ metadata:
   name: {{ .Values.defaultPolicy.name }}
 spec:
   replicaSC: {{ .Values.defaultPolicy.replicaSC }}
-  enableBufio: false
-  autoScaling: false
   target:
     replicationFactor: {{ .Values.defaultPolicy.replicas }}
 {{- end }}