Merge pull request #369 from RHEcosystemAppEng/main

.github/ISSUE_TEMPLATE/bug_report.md → .github/ISSUE_TEMPLATE/report-an-issue.md

@@ -1,15 +1,18 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: Report an issue
+about: Report an issue to help us improve the quality
 title: ''
 labels: ''
 assignees: ''
 
 ---
 
-**Describe the bug**
+**Describe the issue**
 
-**Environment (OpenShift or OKD) and its version**
+**Environment**
+   1. (OpenShift or OKD) and its version:
+   2. go version:
+   3. operator sdk version:
 
 **To Reproduce**
 What are the steps to reproduce this issue?
@@ -22,6 +25,8 @@ What are the steps to reproduce this issue?
 
 **Actual behavior**
 
+**Does this issue happen for particular dbaas provider(s)? If so provide the provider names**
+
 **DBaaS Operator logs**
 
 **Custom Resource Data**

Makefile

@@ -39,9 +39,10 @@ ENVTEST_K8S_VERSION ?= 1.25.0
 # If you are developing and pushing against your OWN quay for testing, you likely need to uncomment
 #OLD_BUNDLE_VERSIONS ?= 0.1.0,0.1.1,0.1.2,0.1.3
 
-# ORG indicates the organization that docker images will be build for & pushed to
-# CHANGE THIS TO YOUR OWN QUAY USERNAME FOR DEV/TESTING/PUSHING
+# ORG indicates the quay.io organization that docker images will be build for & pushed to
+# Set REGISTRY to use a registry other than quay.io
 ORG ?= ecosystem-appeng
+REGISTRY ?= quay.io/$(ORG)
 
 # CATALOG_BASE_IMG defines an existing catalog version to build on & add bundles to
 # CATALOG_BASE_IMG ?= quay.io/$(ORG)/dbaas-operator-catalog:v$(VERSION)
@@ -73,7 +74,7 @@ BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
 #
 # For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both
 # redhat.com/dbaas-operator-bundle:$VERSION and redhat.com/dbaas-operator-catalog:$VERSION.
-IMAGE_TAG_BASE ?= quay.io/$(ORG)/dbaas-operator
+IMAGE_TAG_BASE ?= $(REGISTRY)/dbaas-operator
 
 # BUNDLE_IMG defines the image:tag used for the bundle.
 # You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
@@ -206,7 +207,7 @@ catalog-update:
 	-oc delete catalogsource ccapi-k8s-catalogsource -n openshift-marketplace
 	-oc delete catalogsource observability-catalogsource -n openshift-marketplace
 	-oc delete catalogsource rds-provider-catalogsource -n openshift-marketplace
-	 oc apply -f config/samples/catalog-source.yaml
+	sed "s/{{CATALOG_IMG}}/$(subst /,\/,$(CATALOG_IMG))/g" config/samples/catalog-source-template.yaml | oc apply -f -
 
 deploy-sample-app:
 	oc apply -f config/samples/quarkus-runner/deployment.yaml
@@ -341,11 +342,11 @@ catalog-push: ## Push a catalog image.
 
 .PHONY: wrapper-build
 wrapper-build: ## Build the catalog wrapper image.
-	$(CONTAINER_ENGINE) build --pull -f wrapper.Dockerfile --platform linux/amd64 -t quay.io/$(ORG)/dbaas-operator-catalog:0.4.0-wrapper .
+	$(CONTAINER_ENGINE) build --pull -f wrapper.Dockerfile --platform linux/amd64 -t $(REGISTRY)/dbaas-operator-catalog:0.4.0-wrapper .
 
 .PHONY: wrapper-push
 wrapper-push: ## Push the catalog wrapper image.
-	$(MAKE) docker-push IMG=quay.io/$(ORG)/dbaas-operator-catalog:0.4.0-wrapper
+	$(MAKE) docker-push IMG=$(REGISTRY)/dbaas-operator-catalog:0.4.0-wrapper
 
 .PHONY: get-version
 get-version: ; $(info ${VERSION})

README.md

@@ -5,7 +5,7 @@ available to developers for binding to their applications.
 
 ## Architecture Diagram
 
-![Conceptual Diagram of the Components](docs/images/dbaas-arch.png)
+![Conceptual Diagram of the Components](docs/images/dbaas-arch-v2.png)
 
 ## Documentation
 
@@ -23,29 +23,27 @@ RDS Operator|[RDS Operator](https://github.com/RHEcosystemAppEng/rds-dbaas-opera
 Observability Operator |[Observability Operator](https://github.com/rhobs/observability-operator)| Operator for installing the monitoring stack and configuring remote write Observatorium.
 
 ## Building the Operator
-Build the OpenShift Database Access Operator image and push it to a public registry, such as quay.io:
-
-Reqs:
+Requires:
  - go v1.18
  - operator-sdk v1.22.2
 
-**if you are using podman instead of docker set CONTAINER_ENGINE as podman** `export CONTAINER_ENGINE=podman`
-- `make build`
-- `make docker-build docker-push IMG=quay.io/<YOUR_USERNAME_IN_QUAY>/dbaas-operator:<version>`
+Build the OpenShift Database Access Operator image and its bundle and catalog images and push them to a public registry, such as quay.io:
 
-## [API Reference](docs/api/markdown/ref.md)
+- `ORG=<YOUR_QUAY_USER> VERSION=<version> make release-build release-push`
+
+**If you are using podman instead of docker:** 
+- `CONTAINER_ENGINE=podman ORG=<YOUR_QUAY_USER> VERSION=<version> make release-build release-push`
+
+You can also build and push the image to a public registry other than quay.io:
+- `REGISTRY=<YOUR_REGISTRY> VERSION=<version> make release-build release-push`
 
 ## Running the Operator (requires OCP 4.10 or higher)
 **NOTE**: The DBaaS console UI portion of the workflow described below will *only* work if your operator is installed via OLM and using version OpenShift Container Platform (OCP) version 4.10 or higher.
 If you run locally or via direct deploy (no longer recommended), you can create a DBaaSInventory. DBaaSConnection CRs created directly in command line can appear in the topology view in the OpenShift Console.
 
 **Deploy via OLM on cluster:**
-- **Make sure to edit `Makefile` and replace `QUAY_ORG` in the `IMAGE_TAG_BASE` with your own Quay.io Org!**
-- **Next `make release-build`**
-- **Next edit the [catalog-source.yaml](config/samples/catalog-source.yaml) template to indicate your new Quay.io org image**
-- `make release-push`
 - Make visibility of the repositories (`dbaas-operator`, `dbaas-operator-bundle`, and `dbaas-operator-catalog`) public in your Quay.io account
-- `make catalog-update`
+- `ORG=<YOUR_QUAY_USER> VERSION=<version> make catalog-update`
   - Note: We already pre-build the dbaas-operator images, which can be deployed to the cluster. They can be found here: 
     https://quay.io/repository/ecosystem-appeng/dbaas-operator-dev-catalog?tab=tags
   - You can also find the exact commit you want to deploy based on the commit sha.
@@ -58,38 +56,43 @@ If you run locally or via direct deploy (no longer recommended), you can create
   Then delete the catalog source.
 
 ## Using the Operator
-
 **Prerequisites:**
-- An instance of OpenShift Container Platform (OCP) 4.10 or higher
-- A database instance created using Crunchy Data Bridge cloud database provider.
+- Either OpenShift Container Platform or Origin Kubernetes Distribution (OKD) 4.10 or higher.
+- [Installation](https://github.com/RHEcosystemAppEng/dbaas-operator/blob/main/docs/quick-start-guide/main.adoc#installing-the-openshift-database-access-operator) of the OpenShift Database Access operator.
+- A service account with either the Crunchy Data Bridge, or CockroachDB, or Amazon RDS cloud-hosted database provider.
 
 **Creating a DBaaSInventory:**
-- Click Operators → Installed Operators.
-- Set the Project dropdown to the openshift-dbaas-operator project.
-- Click the name of the OpenShift Database Access Operator to view the details page.
-- Under Provided APIs, on the Provider Account tile, click Create instance to create a new provider account instance.
-- Refresh the page if you are not seeing the DBaaS Console UI, this required only once to reload the plugin.
-- On the Create Provider Account page, specify a name for the new Provider Account resource.
-  ![provider account creation](docs/images/provider-account-setup.png)
-- Select your cloud database provider from the drop-down menu and provide the credentials for that provider.
-- Click on the Create button to create the Provider Account resource and fetch the available database instances.
-- If fetching is successful, then you can click on the View Provider Accounts button to display the exposed database instances that developers can import.
-- For more understanding see the demo: [IT Operations preview demo of OpenShift Database Access](https://www.youtube.com/watch?v=QmF5da2LvnU&t=0s&ab_channel=OpenShift)  
+1. From the OpenShift console home page, in the **Administrator** perspective, click **Operators**, then click **Installed Operators**.
+2. Set the **Project** to **openshift-dbaas-operator**.
+3. Click the **OpenShift Database Access Operator** tile to view the details page.
+4. Click the **Provider Account** tab.
+5. Click the **Create DBaaSInventory** button to create a new provider account.
+
+   **NOTE:** Refresh the page if you are not seeing the DBaaS Console UI, this requires a one-time only plugin reload.
+6. On the Import Provider Account page, select a **Database provider**, provide the credentials for your choosen cloud-hosted database provider, and specify a name for the new provider account resource.
+   ![provider account creation](docs/images/provider-account-setup-v2.png)
+
+7. Click the **Import** button to create the provider account resource, and fetch the available database instances.
+8. If fetching is successful, then you see can the exposed database instances that developers can import, or you can click the **View Provider Accounts** button to return to the provider account's **DBaaSInventorys** page. Click the link to view an [IT Operations preview demo of OpenShift Database Access](https://www.youtube.com/watch?v=QmF5da2LvnU&t=0s&ab_channel=OpenShift). 
 
 **Creating a DBaaSConnection:**
-- Change into the Developer perspective. Click +Add.
-- Select/Create the project to the application that you want to add the database to. Sample Quarkus application deployment for [crunchy-bridge](config/samples/quarkus-crunchydata-sample-app.yaml)
-- From **Developer Catalog** Click on the **Database** category or select the **Connected Database**
-  ![database-provider](docs/images/connected-database.png)
-- Select the database provider and click Connect.  
-  ![connect-database](docs/images/connected.png)
-- Select the database provider and click Connect.  
-  ![connection-list](docs/images/connection-list.png)
-- Upon successful connection, you are taken to the Topology page.
-- Click and drag the arrow from the application to the new database instance to create a binding connector.
-  ![topology-view](docs/images/topology-view-example.png)
-- For more understanding see the demo: [Developer preview demo of OpenShift Database Access](https://www.youtube.com/watch?v=wEcqQziu17o&ab_channel=OpenShift)  
+1. From the OpenShift console home page, switch to the **Developer** perspective.
+2. Click **+Add**.
+3. Select or create a project for your application where you want to add a database to.
+   Here is sample Quarkus application deployment for [Crunchy Bridge](config/samples/quarkus-crunchydata-sample-app.yaml).
+4. Click the **Cloud-hosted Database** category.
+   ![database-provider](docs/images/connected-database-v2.png)
+5. Select the cloud-hosted database provider tile, and click **Add to Topology**.  
+   ![connect-database](docs/images/connected-v2.png)
+6. Select the database instance name, and click **Add to Topology**.  
+   ![connection-list](docs/images/connection-list-v2.png)
+7. Upon a successful connection, you are taken to the Topology page.
+8. Click and drag the arrow from the application to the new database instance to create a binding connector.
+   ![topology-view](docs/images/topology-view-example.png)
+   Click the link to view a [Developer preview demo of OpenShift Database Access](https://www.youtube.com/watch?v=wEcqQziu17o&ab_channel=OpenShift).
 
+## [API Reference](docs/api/markdown/ref.md)
+
 ## Contributing
 
 - Fork OpenShift Database Access Operator repository

config/samples/catalog-source-template.yaml

@@ -0,0 +1,9 @@
+apiVersion: operators.coreos.com/v1alpha1
+kind: CatalogSource
+metadata:
+  name: dbaas-operator
+  namespace: openshift-marketplace
+spec:
+  sourceType: grpc
+  image: {{CATALOG_IMG}}
+  displayName: DBaaS Operator