doc/*,CHANGELOG.md: adding helm operator docs (#783)

* doc/helm: adding helm project layout and user/developer guides

* doc: updating CLI reference and user guide for Helm

* CHANGELOG.md: add helm operator line

* doc/helm: minor example output and formatting changes

* doc/helm: updates based on PR feedback

* doc/helm/user-guide.md: fixing nits and copy/paste typo

* README.md: added Helm workflow

* user-guide.md,helm,ansible: update user guides to describe --cluster-scoped scaffold changes

Author: joelanford

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Added
 
+- Helm type operator generation support ([#776](https://github.com/operator-framework/operator-sdk/pull/776))
+
 ### Changed
 
 - The SDK's Kubernetes Golang dependency versions/revisions have been updated from `v1.11.2` to `v1.12.3`. ([#807](https://github.com/operator-framework/operator-sdk/pull/807))

README.md

@@ -23,7 +23,7 @@ The Operator SDK is a framework that uses the [controller-runtime][controller_ru
 
 ## Workflow
 
-The SDK provides workflows to develop operators in Go or Ansible.
+The SDK provides workflows to develop operators in Go, Ansible, or Helm.
 
 The following workflow is for a new **Go** operator:
 1. Create a new operator project using the SDK Command Line Interface(CLI)
@@ -38,6 +38,12 @@ The following workflow is for a new **Ansible** operator:
 3. Use the SDK CLI to build and generate the operator deployment manifests
 4. Optionally add additional CRD's using the SDK CLI and repeat steps 2 and 3
 
+The following workflow is for a new **Helm** operator:
+1. Create a new operator project using the SDK Command Line Interface(CLI)
+2. Create a new (or add your existing) Helm chart for use by the operator's reconciling logic
+3. Use the SDK CLI to build and generate the operator deployment manifests
+4. Optionally add additional CRD's using the SDK CLI and repeat steps 2 and 3
+
 ## Prerequisites
 
 - [dep][dep_tool] version v0.5.0+.
@@ -118,7 +124,7 @@ $ kubectl delete -f deploy/crds/app_v1alpha1_appservice_crd.yaml
 
 To learn more about the writing an operator in Go, see the [user guide][guide].
 
-The SDK also supports developing an operator using Ansible. See the [Ansible operator user guide][ansible_user_guide].
+The SDK also supports developing an operator using Ansible or Helm. See the [Ansible][ansible_user_guide] and [Helm][helm_user_guide] operator user guides.
 
 ## Samples
 
@@ -152,3 +158,4 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
 [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
 [controller_runtime]: https://github.com/kubernetes-sigs/controller-runtime
 [ansible_user_guide]:./doc/ansible/user-guide.md
+[helm_user_guide]:./doc/helm/user-guide.md

doc/ansible/user-guide.md

@@ -62,6 +62,13 @@ If you'd like to create your memcached-operator project to be cluster-scoped use
 $ operator-sdk new memcached-operator --cluster-scoped --api-version=cache.example.com/v1alpha1 --kind=Memcached --type=ansible
 ```
 
+Using `--cluster-scoped` will scaffold the new operator with the following modifications:
+* `deploy/operator.yaml` - Set `WATCH_NAMESPACE=""` instead of setting it to the pod's namespace
+* `deploy/role.yaml` - Use `ClusterRole` instead of `Role`
+* `deploy/role_binding.yaml`:
+  * Use `ClusterRoleBinding` instead of `RoleBinding`
+  * Set the subject namespace to `REPLACE_NAMESPACE`. This must be changed to the namespace in which the operator is deployed.
+
 ### Watches file
 
 The Watches file contains a list of mappings from custom resources, identified