Merge pull request #99 from JohnStrunk/housekeeping

Housekeeping for v0.1.0 release

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - YYYY-MM-DD
+
+### Added
+
+- Support for rsync & rclone replication
+- Helm chart to deploy operator
+
+[Unreleased]: https://github.com/backube/scribe/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/backube/scribe/releases/tag/v0.1.0

README.md

@@ -8,20 +8,20 @@ Status](https://readthedocs.org/projects/scribe-replication/badge/?version=lates
 [![Go Report
 Card](https://goreportcard.com/badge/github.com/backube/scribe)](https://goreportcard.com/report/github.com/backube/scribe)
 [![codecov](https://codecov.io/gh/backube/scribe/branch/master/graph/badge.svg)](https://codecov.io/gh/backube/scribe)
+![maturity](https://img.shields.io/static/v1?label=maturity&message=alpha&color=red)
 
 ![Documentation](https://github.com/backube/scribe/workflows/Documentation/badge.svg)
 ![operator](https://github.com/backube/scribe/workflows/operator/badge.svg)
-![mover-rsync](https://github.com/backube/scribe/workflows/mover-rsync/badge.svg)
 
 ## Getting started
 
-Currently, this project is under heavy development. To try out Scribe, clone the
-repository and follow the steps in the [installation
+To try out Scribe,  follow the steps in the [installation
 instructions](https://scribe-replication.readthedocs.io/en/latest/installation/index.html).
 
 ## Helpful links
 
 - [Scribe documentation](https://scribe-replication.readthedocs.io)
+- [Changelog](CHANGELOG.md)
 - [Contributing guidelines](https://github.com/backube/.github/blob/master/CONTRIBUTING.md)
 - [Organization code of conduct](https://github.com/backube/.github/blob/master/CODE_OF_CONDUCT.md)
 

docs/installation/index.rst

@@ -17,53 +17,44 @@ your situation.
    within a cluster. If the controller is not deployed review the
    snapshot controller documentation https://github.com/kubernetes-csi/external-snapshotter.
 
-Development
-===========
+Kubernetes & OpenShift
+======================
 
-If you are developing Scribe, run the following as it will output the logs of
-the controller to your terminal.
+While the operator can be deployed via the ``make deploy`` or ``make
+deploy-openshift`` targets, the recommended method for deploying Scribe is via
+the Helm chart.
 
 .. code-block:: bash
 
-   # Install Scribe CRDs into the cluster
-   $ make install
-
-   # Run the operator locally
-   $ make run
+   # Add the Backube Helm repo
+   $ helm repo add backube https://backube.github.io/helm-charts/
 
-Kubernetes
-==========
+   # Deploy the chart in your cluster
+   $ helm install --create-namespace scribe-system scribe backube/scribe
 
-If you are running Kubernetes issue the following command.
+Verify Scribe is running by checking the output of ``kubectl get pods``:
 
 .. code-block:: bash
 
-   $ make deploy
-
-OpenShift
-=========
-
-A special make target is provided to allow Scribe to be installed on OpenShift.
-Using this method ensures the proper `SecurityContextConstraint
-<https://docs.openshift.com/container-platform/4.6/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.html>`_
-is applied to the cluster.
+   $ kubectl -n scribe-system get pods
+   NAME                          READY   STATUS    RESTARTS   AGE
+   scribe-686c8557bc-cr6k9       2/2     Running   0          13s
 
-.. code-block:: bash
+At this point it is now possible to use the Rsync and Rclone capabilities of
+Scribe.
 
-   $ make deploy-openshift
+Continue on to the :doc:`usage docs </usage/index>`.
 
+Development
+===========
 
-In the case of the Kubernetes or OpenShift instructions above, verify Scribe is
-running by checking the output of ``kubectl get pods``:
+If you are developing Scribe, run the following as it will run the operator
+locally and output the logs of the controller to your terminal.
 
 .. code-block:: bash
 
-   $ kubectl -n scribe-system get pods
-   NAME                                         READY   STATUS    RESTARTS   AGE
-   scribe-controller-manager-77d89c5879-bvscw   2/2     Running   0          27s
-
-At this point it is now possible to use the Rsync and Rclone capabilities of
-Scribe.
-
-Continue on to the :doc:`usage docs </usage/index>`.
+   # Install Scribe CRDs into the cluster
+   $ make install
 
+   # Run the operator locally
+   $ make run

helm/scribe/README.md

@@ -4,6 +4,8 @@ Asynchronous volume replication for Kubernetes CSI storage
 
 ## About this operator
 
+![maturity](https://img.shields.io/static/v1?label=maturity&message=alpha&color=red)
+
 Scribe is a Kubernetes operator that performs asynchronous replication of
 persistent volumes within, or across, clusters. Scribe supports replication in a
 storage system independent manner. This means replication can be used with