Updating documentation to use hosted helm chart. (#115)

Author: HoustonPutman

Makefile

@@ -32,7 +32,7 @@ clean:
 mod-tidy:
 	export GO111MODULE=on; go mod tidy
 
-release: manifests
+release: manifests helm-check
 	VERSION=${VERSION} bash hack/setup_release.sh
 
 ###
@@ -84,6 +84,9 @@ manifests-check:
 	@echo "Check to make sure the manifests are up to date"
 	git diff --exit-code -- config
 
+helm-check:
+	helm lint helm/solr-operator
+
 # Generate code
 generate: controller-gen
 	$(CONTROLLER_GEN) object:headerFile=./hack/boilerplate.go.txt paths="./..."

docs/charts/index.yaml

@@ -3,10 +3,10 @@ entries:
   solr-operator:
   - apiVersion: v1
     appVersion: v0.2.5
-    created: "2020-05-08T18:03:36.734334-04:00"
+    created: "2020-05-14T14:31:51.166349-04:00"
     description: The Solr Operator enables easy management of Solr resources within
       Kubernetes.
-    digest: b6cfb98aa7d77999310ee82c7b706e572c823e5c25fe5ddceb6454b2413d3541
+    digest: cdc896541390137c0f8aaab7b51f4b944e6cde23f9d8da5ffb0486e20efa5c48
     home: https://github.com/bloomberg/solr-operator
     icon: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
     keywords:
@@ -26,4 +26,4 @@ entries:
     urls:
     - https://github.com/bloomberg/solr-operator/releases/download/v0.2.5/solr-operator-0.2.5.tgz
     version: 0.2.5
-generated: "2020-05-08T18:03:36.728994-04:00"
+generated: "2020-05-14T14:31:51.161206-04:00"

docs/local_tutorial.md

@@ -2,8 +2,9 @@
 
 This tutorial shows how to setup Solr under Kubernetes on your local mac. The plan is as follows:
 
- 1. [Setup Docker for Mac with K8S](#setup-docker-for-mac-with-k8s)
- 2. [Install an Ingress Controller to reach the cluster on localhost](#install-an-ingress-controller)
+ 1. [Setup Kubernetes and Dependencies](#setup-kubernetes-and-dependencies)
+    1. [Setup Docker for Mac with K8S](#setup-docker-for-mac-with-k8s)
+    2. [Install an Ingress Controller to reach the cluster on localhost](#install-an-ingress-controller)
  3. [Install Solr Operator](#install-solr-operator)
  4. [Start your Solr cluster](#start-your-solr-cluster)
  5. [Create a collection and index some documents](#create-a-collection-and-index-some-documents)
@@ -12,7 +13,9 @@ This tutorial shows how to setup Solr under Kubernetes on your local mac. The pl
  8. [Install Kubernetes Dashboard (optional)](#install-kubernetes-dashboard-optional)
  9. [Delete the solrCloud cluster named 'example'](#delete-the-solrcloud-cluster-named-example)
 
-## Setup Docker for Mac with K8S
+## Setup Kubernetes and Dependencies
+
+### Setup Docker for Mac with K8s
 
 ```bash
 # Install Homebrew, if you don't have it already
@@ -33,7 +36,7 @@ open /Applications/Docker.app
 brew install helm watch
 ```
 
-## Install an Ingress Controller
+### Install an Ingress Controller
 
 Kubernetes services are by default only accessible from within the k8s cluster. To make them adressable from our laptop, we'll add an ingress controller
 
@@ -51,22 +54,28 @@ kubectl get all --namespace ingress-nginx
 
 Once we have installed Solr to our k8s, this will allow us to address the nodes locally.
 
-## Install Solr Operator
+## Install the Solr Operator
 
 Now that we have the prerequisites setup, let us install Solr Operator which will let us easily manage a large Solr cluster:
 
+Before installing the Solr Operator, we need to install the [Zookeeper Operator](https://github.com/pravega/zookeeper-operator).
+Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/bloomberg/solr-operator/master/example/dependencies/zk_operator.yaml
+```
+
+Now add the Solr Operator Helm repository. (You should only need to do this once)
+
 ```bash
-# Download the operator
-OPERATOR_VER=0.2.5
-curl https://codeload.github.com/bloomberg/solr-operator/tar.gz/v$OPERATOR_VER | tar xz
-ln -s -f solr-operator-$OPERATOR_VER solr-operator
+$ helm repo add solr-operator https://bloomberg.github.io/solr-operator/charts
+```
 
-# Install the Zookeeper operator (and etcd operator even if we don't use it)
-kubectl apply -f solr-operator/example/dependencies/
+Next, install the Solr Operator chart. Note this is using Helm v3, in order to use Helm v2 please consult the [Helm Chart documentation](https://hub.helm.sh/charts/solr-operator/solr-operator).
 
+```bash
 # Install the operator (specifying ingressBaseDomain to match our ingressController)
-helm install --set-string ingressBaseDomain=ing.local.domain \
-    solr-operator solr-operator/helm/solr-operator
+$ helm install solr-operator solr-operator/solr-operator --set-string ingressBaseDomain=ing.local.domain
 ```
 
 After installing, you can check to see what lives in the cluster to make sure that the Solr and ZooKeeper operators have started correctly.

docs/running-the-operator.md

@@ -1,27 +1,34 @@
 # Running the Solr Operator
 
+### Installing the Zookeeper Operator
+
+Before installing the Solr Operator, we need to install the [Zookeeper Operator](https://github.com/pravega/zookeeper-operator).
+This is because the Solr Operator, in most instances, relies on the Zookeeper Operator to create the Zookeeper clusters that Solr coordinates through.
+Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/bloomberg/solr-operator/master/example/dependencies/zk_operator.yaml
+```
+
 ## Using the Solr Operator Helm Chart
 
-The easiest way to run the Solr Operator is via the [provided Helm Chart](/helm/solr-operator).
+The easiest way to run the Solr Operator is via the [provided Helm Chart](https://hub.helm.sh/charts/solr-operator/solr-operator).
 
 The helm chart provides abstractions over the Input Arguments described below, and should work with any official images in docker hub.
 
 ### How to install via Helm
 
-Currently you need a local version of the Helm chart downloaded before you can install the operator.
+The first step is to add the Solr Operator helm repository.
 
 ```bash
-# Download the operator
-OPERATOR_VER=0.2.5
-curl https://codeload.github.com/bloomberg/solr-operator/tar.gz/v$OPERATOR_VER | tar xz
-ln -s -f solr-operator-$OPERATOR_VER solr-operator
+$ helm repo add solr-operator https://bloomberg.github.io/solr-operator/charts
+```
 
-# Install the Zookeeper operator (and etcd operator even if we don't use it)
-kubectl apply -f solr-operator/example/dependencies/
 
-# Install the operator (specifying ingressBaseDomain to match our ingressController)
-helm install --set-string ingressBaseDomain=ing.local.domain \
-    solr-operator solr-operator/helm/solr-operator
+Next, install the Solr Operator chart. Note this is using Helm v3, in order to use Helm v2 please consult the [Helm Chart documentation](https://hub.helm.sh/charts/solr-operator/solr-operator).
+
+```bash
+$ helm install solr-operator solr-operator/solr-operator
 ```
 
 After installing, you can check to see what lives in the cluster to make sure that the Solr and ZooKeeper operators have started correctly.

example/dependencies/crds.yaml

@@ -1,32 +1,40 @@
-apiVersion: apps/v1
-kind: Deployment
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
 metadata:
-  name: etcd-operator
+  name: zookeeperclusters.zookeeper.pravega.io
 spec:
-  replicas: 1
-  selector:
-    matchLabels:
-        name: etcd-operator
-  template:
-    metadata:
-      labels:
-        name: etcd-operator
-    spec:
-      containers:
-      - name: etcd-operator
-        image: quay.io/coreos/etcd-operator:v0.9.3
-        command:
-        - etcd-operator
-        - -cluster-wide
-        env:
-        - name: MY_POD_NAMESPACE
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.namespace
-        - name: MY_POD_NAME
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.name
+  group: zookeeper.pravega.io
+  names:
+    kind: ZookeeperCluster
+    listKind: ZookeeperClusterList
+    plural: zookeeperclusters
+    singular: zookeepercluster
+    shortNames:
+      - zk
+  additionalPrinterColumns:
+    - name: Replicas
+      type: integer
+      description: The number of ZooKeeper servers in the ensemble
+      JSONPath: .status.replicas
+    - name: Ready Replicas
+      type: integer
+      description: The number of ZooKeeper servers in the ensemble that are in a Ready state
+      JSONPath: .status.readyReplicas
+    - name: Internal Endpoint
+      type: string
+      description: Client endpoint internal to cluster network
+      JSONPath: .status.internalClientEndpoint
+    - name: External Endpoint
+      type: string
+      description: Client endpoint external to cluster network via LoadBalancer
+      JSONPath: .status.externalClientEndpoint
+    - name: Age
+      type: date
+      JSONPath: .metadata.creationTimestamp
+  scope: Namespaced
+  version: v1beta1
+  subresources:
+    status: {}
 
 ---
 apiVersion: apps/v1

example/dependencies/operators.yaml renamed to example/dependencies/zk_operator.yaml

@@ -1,6 +1,5 @@
 
 apiVersion: v1
-type: application
 name: solr-operator
 description: The Solr Operator enables easy management of Solr resources within Kubernetes.
 version: 0.2.5

helm/solr-operator/Chart.yaml

@@ -1,27 +1,53 @@
 Solr Operator
 =============
-A Helm chart for the Solr Operator.
-
-## The Solr Operator
 
 The Solr Operator is designed to allow easy deployment Solr Clouds and other Solr Resources to Kubernetes.
 
 Documentation around using the Solr Operator can be found in it's [source repo](https://github.com/bloomberg/solr-operator).
 
 ## Using the Helm Chart
 
+### Installing the Zookeeper Operator
+
+Before installing the Solr Operator, we need to install the [Zookeeper Operator](https://github.com/pravega/zookeeper-operator).
+This is because the Solr Operator, in most instances, relies on the Zookeeper Operator to create the Zookeeper clusters that Solr coordinates through.
+
+If you are setting `useZkOperator=false`, then please disregard this section.
+
+Eventually the Zookeeper Opertor will be a dependency on the Solr Operator helm chart, but for now there are two easy ways to deploy it.
+
+- A helm chart is available [in the Zookeeper Operator repository](https://github.com/pravega/zookeeper-operator/blob/master/charts/zookeeper-operator/).
+- Use the following kubectl command:
+```bash
+kubectl apply -f https://raw.githubusercontent.com/bloomberg/solr-operator/master/example/dependencies/zk_operator.yaml
+```
+
+#### Helm
+
+Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
+
+```bash
+kubectl apply -f https://raw.githubusercontent.com/bloomberg/solr-operator/master/example/dependencies/zk_operator.yaml
+```
+
+### Adding the Solr Operator Helm Chart Repository
+You should only need to add the solr operator helm chart repository once, by running the following command:
+
+```console
+$ helm repo add solr-operator https://bloomberg.github.io/solr-operator/charts
+```
+
 ### Installing the Chart
 
-To install the chart with the release name `test`:
+To install the Solr Operator with the latest version or with a specific version, run either of the following commands:
 
 ```console
-$ helm install test .
+$ helm install solr-operator solr-operator/solr-operator
+$ helm install solr-operator solr-operator/solr-operator --version 0.2.5
 ```
 
 The command deploys the solr-operator on the Kubernetes cluster with the default configuration. The [configuration](#chart-values) section lists the parameters that can be configured during installation.
 
-**NOTE**: Since by default the `useZkOperator` option is set to `True`, you must have already installed the [Zookeeper Operator](https://github.com/pravega/zookeeper-operator) in your kubernetes cluster. A helm chart is [also available](https://github.com/pravega/zookeeper-operator/blob/master/charts/zookeeper-operator/Chart.yaml) for it.
-
 ### Helm Version Differences
 
 #### Helm 2
@@ -31,7 +57,7 @@ If you are using Helm 2, CRDs are installed using the crd-install hook. Prior to
 You will also need to update the install command to use the name flag, as shown below.
 
 ```console
-$ helm install --name test .
+$ helm install --name solr-operator solr-operator/solr-operator
 ```
 
 #### Helm 3
@@ -45,13 +71,13 @@ To uninstall/delete the `solr-operator` deployment:
 #### Helm 3
 
 ```console
-$ helm uninstall test
+$ helm uninstall solr-operator
 ```
 
 #### Helm 2
 
 ```console
-$ helm delete test
+$ helm delete solr-operator
 ```
 
 The command removes all the Kubernetes components associated with the chart and deletes the release.