Document ShipwrightBuild

- Describe the fields in the ShipwrightBuild CRD.
- Indicate which version of Shipwright Builds is installed.
- Add installation instructions to the README.
- Remove instruction that the target namespace needs to be created
  first.

Author: adambkaplan

README.md

@@ -2,15 +2,21 @@
 
 An operator to install and configure [Shipwright](https://shipwright.io) on Kubernetes clusters.
 
-## Contributing
+## Installation
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to build, test, and submit
-contributions to the operator.
+The Shipwright operator is designed to be installed with the [Operator Lifecycle Manager](https://olm.operatorframework.io/) ("OLM").
+Before installation, ensure that OLM has been deployed on your cluster by following the [OLM installation instructions](https://olm.operatorframework.io/docs/getting-started/#installing-olm-in-your-cluster).
+
+Once OLM has been deployed, use the following command to install the latest operator release from [operatorhub.io](https://operatorhub.io/operator/shipwright-operator):
+
+```sh
+$ kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml
+```
 
 ## Usage
 
 To deploy and manage [Shipwright Builds](https://github.com/shipwright-io/build) in your cluster,
-first make sure this operator is installed and running on your cluster.
+first make sure this operator is installed and running.
 
 Next, create the following:
 
@@ -26,5 +32,9 @@ spec:
 
 The operator will deploy Shipwright Builds in the provided `targetNamespace`.
 When `.spec.targetNamespace` is not set, the namespace will default to `shipwright-build`.
+Refer to the [ShipwrightBuild documentation](docs/shipwrightbuild.md) for more information about this custom resource.
+
+## Contributing
 
-_Note: this namespace needs to be created before the actual deployment takes place._
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to build, test, and submit
+contributions to the operator.

bundle/manifests/shipwright-operator.clusterserviceversion.yaml

@@ -63,8 +63,6 @@ spec:
 
     The operator will deploy Shipwright Builds in the provided `targetNamespace`.
     When `.spec.targetNamespace` is not set, the namespace will default to `shipwright-build`.
-
-    _Note: this namespace needs to be created before the actual deployment takes place._
   displayName: Shipwright Operator
   icon:
   - base64data: |

config/manifests/bases/shipwright-operator.clusterserviceversion.yaml

@@ -49,8 +49,6 @@ spec:
 
     The operator will deploy Shipwright Builds in the provided `targetNamespace`.
     When `.spec.targetNamespace` is not set, the namespace will default to `shipwright-build`.
-
-    _Note: this namespace needs to be created before the actual deployment takes place._
   displayName: Shipwright Operator
   icon:
   - base64data: |

docs/shipwrightbuild.md

@@ -0,0 +1,13 @@
+# ShipwrightBuild Custom Resource
+
+When the Shipwright Operator is installed with the Operator Lifecycle Manager, the
+`ShipwrightBuild` [custom resource definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) is added to your cluster.
+This custom resource is used to install and configure Shipwright Builds on your cluster.
+The current operator will install version `0.9.0` of Builds.
+
+## ShipwrightBuild Reference
+
+| Field | Description |
+| ----- | ----------- |
+| spec.targetNamespace | The target namespace where Shipwright Build will be deployed. If omitted, this will default to `shipwright-build` |
+| status.conditions | Conditions which report the status of Shipwright Build. Current reported conditions:<br><br>- `Ready` |