Merge pull request #149 from fao89/8836

Document how to deploy Pulp on OpenShift
pulp · Jun 2, 2021 · 2bbec4a · 2bbec4a
2 parents cf1d33c + 274bca3
commit 2bbec4a
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 1 deletion.
diff --git a/CHANGES/8836.doc b/CHANGES/8836.doc
@@ -0,0 +1 @@
+Document how to deploy Pulp on OpenShift
diff --git a/docs/images/1.png b/docs/images/1.png
diff --git a/docs/images/10.png b/docs/images/10.png
diff --git a/docs/images/2.png b/docs/images/2.png
diff --git a/docs/images/3.png b/docs/images/3.png
diff --git a/docs/images/4.png b/docs/images/4.png
diff --git a/docs/images/5.png b/docs/images/5.png
diff --git a/docs/images/6.png b/docs/images/6.png
diff --git a/docs/images/7.png b/docs/images/7.png
diff --git a/docs/images/8.png b/docs/images/8.png
diff --git a/docs/images/9.png b/docs/images/9.png
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -1,6 +1,6 @@
 # Getting started
 
-## pulp-insta-demo.sh
+## Instant demo
 
 [A script](https://raw.githubusercontent.com/pulp/pulp-operator/master/insta-demo/pulp-insta-demo.sh)
 to install Pulp 3 on Linux systems with as many plugins as possible and an uninstaller.
@@ -11,3 +11,63 @@ pulp-operator on top of it.
 Is not considered production ready because pulp-operator is not yet, it hides every config option,
 and upgrades are not considered. Only suitable as a quick way to evaluate Pulp for the time
 being.
+
+
+## OpenShift
+
+Currently pulp-operator is not on the OpenShift catalog, so as a first step we need to create a catalog entry:
+
+```yaml
+# pulp-catalog-source.yaml
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: CatalogSource
+metadata:
+ name: my-pulp-catalog
+ namespace: openshift-marketplace
+spec:
+ sourceType: grpc
+ image: quay.io/pulp/pulp-index:0.2.0
+
+```
+
+* Refer to [Getting started with the OpenShift CLI](https://docs.openshift.com/container-platform/4.7/cli_reference/openshift_cli/getting-started-cli.html)
+
+* Verify the desired tag for `pulp-index` image [here](https://quay.io/repository/pulp/pulp-index?tab=tags)
+```console
+oc apply -f pulp-catalog-source.yaml
+```
+
+Wait few seconds and refresh OCP page, after that you should be able to see `my-pulp-catalog`
+on the OperatorHub tab:
+![OperatorHub tab](images/1.png "Pulp on OperatorHub tab")
+
+Click on `Pulp` and then `Install`:
+![Installing pulp](images/2.png "Installing pulp operator")
+
+![Installing pulp](images/3.png "Installing pulp operator")
+
+Create a `Secret` with the `S3` credentials:
+![S3 credentials Secret](images/4.png "S3 credentials Secret")
+
+Click on `Pulp`:
+![Click on Pulp](images/5.png "Click on Pulp")
+
+Select `S3` as storage type and, on S3 storage secret, type the name of the storage you created before,
+e.g. `example-pulp-object-storage`:
+![S3 credentials on Pulp kind](images/6.png "S3 credentials on Pulp kind")
+
+Click on `Advanced Configuration`,
+select `Route` as Ingress type, fill in the `Route DNS host`, select `Edge` as Route TLS termination mechanism, and click on `Create`:
+![Advanced Configuration](images/7.png "Advanced Configuration")
+
+Wait few minutes, and pulp-operator should be successfully deployed!
+
+You can check your `password` on `Secrets`, `example-pulp-admin-password`:
+![Admin password Secret](images/8.png "Admin password Secret")
+
+Verify your URL at `Networking > Routes`:
+![Route URL](images/9.png "Route URL")
+
+Use the URL from the previous step with `/pulp/api/v3/status`path and verify Pulp was successfully deployed:
+![Pulp Status](images/10.png "Pulp Status")