Doc updates for 1.0 release (#756)

Update docs for 1.0 release

---------

Signed-off-by: Mark Nelson <[email protected]>
Co-authored-by: John Lathouwers <[email protected]>
Co-authored-by: Andy Tael <[email protected]>
Co-authored-by: corradodebari <[email protected]>

Author: 4 people

docs-source/mbaas/content/_index.md

@@ -16,7 +16,7 @@ Engine for Kubernetes (OKE) for customer usage with Oracle Backend for Parse Pla
 
  
 {{< hint type=[warning] icon=gdoc_fire title="Interested in Spring Boot or Microservices, too?" >}}
-Check out [Oracle Backend for Spring Boot](https://oracle.github.io/microservices-datadriven/spring/)
+Check out [Oracle Backend for Spring Boot and Microservices](https://oracle.github.io/microservices-datadriven/spring/)
 {{< /hint >}}
 &nbsp;
 

docs-source/mbaas/content/azure/_index.md

@@ -51,7 +51,7 @@ The Multicloud installation is done using the Azure Cloud Shell.  The following
 
     ![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
 
-3. Upload the [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-mbaas_latest.zip) stack. For example:
+3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-mbaas_latest.zip) stack. For example:
 
     ![Azure Upload](AzureUpload.png)
 

docs-source/mbaas/content/on-premises/_index.md

@@ -13,7 +13,7 @@ The _Desktop_ installation can be used to explore a non-Production environment,
 
 You must meet the following prerequisites to use the Oracle Backend for Parse Platform On-Premises. You need access to:
 
-* An Oracle Database Enterprise Edition 21.3.0.0
+* An Oracle Database Enterprise Edition 19.3.0.0
 * A Container Repository
 * A Kubernetes cluster
 * [Python 3+](https://www.python.org/)
@@ -54,50 +54,51 @@ The _Desktop_ installation provisions an Oracle Database into the Kubernetes clu
 
 After installing Podman:
 
-1. Log in to the Container Registry: 
+1. Log in to the Container Registry:
 
    `podman login container-registry.oracle.com`
-   
-2. Pull the database image: 
 
-   `podman pull container-registry.oracle.com/database/enterprise:21.3.0.0`
-   
-3. Pull the ORDS image: 
+2. Pull the database image:
+
+   `podman pull container-registry.oracle.com/database/enterprise:19.3.0.0`
+
+3. Pull the ORDS image:
 
    `podman pull container-registry.oracle.com/database/ords:21.4.2-gh`
 
 ### Defining the Parse Application (_Estate_  Installation)
 
-The Parse application is defined in `ansible/vars/baas.yaml`. For example:
+The application is defined in `ansible/vars/mbaas.yaml`. For example:
 
 ```yaml
 ---
+mbaas_edition: "COMMUNITY"
 app_name: "MYAPP"
 app_id: "PiITzsu3RCc499RRDOYOBgWnyAlMm6695r1536y1"
 master_key: "Q5CP7MHpoZhSwbk39XpHxamp4rJJ4F3vPZ3NZ7ee"
 dashboard_username: "ADMIN"
 dashboard_password: "OZ0-mSt-27Evb-Qy"
 storage: ""
-access_key: ""
-private_key: ""
+access_key: "N/A"
+private_key: "N/A"
 ...
 ```
 
 You can use any arbitrary string as your `app_name`, `app_id`, and `master_key`. These are used by your clients to authenticate with the Parse Server.  It is recommended to specify a unique `dashboard_username` and `dashboard_password`.
 
 ### Defining the Database  (_Estate_  Installation)
 
-The database is defined in `ansible/roles/database/vars/main.yaml`. For example:  
+The database is defined in `ansible/roles/database/vars/main.yaml`. For example:
 
 ```yaml
 ---
-oracle_dbs: ['BAASPDB']
-default_db: BAASPDB
-BAASPDB:
-  username: 'PDBADMIN'
-  password: 'Correct-horse-Battery-staple-35'
-  service: '(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=BAASPDB)))'
-  ocid: ''
+database_oracle_dbs: ["BAASPDB"]
+database_default_db: BAASPDB
+BAASPDB: # noqa: var-naming[pattern]
+  username: "PDBADMIN"
+  password: "Correct-horse-Battery-staple-35"
+  service: "(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=BAASPDB)))"
+  ocid: ""
 ...
 ```
 
@@ -110,25 +111,24 @@ The Container Repository is defined in `ansible/roles/registry/vars/main.yaml`.
 
 ```yaml
 ---
-compartment_ocid: ''
-registry_username: 'oracle'
-registry_password: 'Correct-horse-Battery-staple-35'
-push_registry_url: 'docker.io/myorg'
-push_registry_auth:
+registry_username: "oracle"
+registry_password: "Correct-horse-Battery-staple-35"
+registry_push_url: "docker.io/myorg"
+registry_push_auth:
   auths:
     docker.io/myorg:
-      auth: 'b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0'
-pull_registry_url: 'docker.io/myorg'
-pull_registry_auth:
+      auth: "b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0"
+registry_pull_url: "docker.io/myorg"
+registry_pull_auth:
   auths:
     docker.io/myorg:
-      auth: 'b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0'
+      auth: "b3JhY2xlOjdaUVgxLXhhbFR0NTJsS0VITlA0"
 ...
 ```
 
-Specify the URL or authentication credentials for your Container Repository in `pull_registry_url`, `push_registry_url`, `registry_username`, and `registry_password`.  
+Specify the URL or authentication credentials for your Container Repository in `registry_pull_url`, `registry_push_url`, `registry_username`, and `registry_password`.
 
-For the `push_registry_auth` and `pull_registry_auth` sections, manually log into your repository and copy the values found in created file, located in `$HOME/.config/containers/auth.json`
+For the `registry_pull_auth` and `registry_push_auth` sections, manually log into your repository and copy the values found in created file, located in `$HOME/.config/containers/auth.json`
 
 Why is there duplication between the push and pull URL's?  The push URL is used from the deployment machine while the pull URL is used inside the pods. If you
 have a private registry inside the Kubernetes cluster, these URL's could be different. This is the case for the _Desktop_ installation. The push URL

docs-source/mbaas/content/on-premises/macos_ventura/_index.md

@@ -49,7 +49,7 @@ minikube start --cpus 4 --memory max --container-runtime=containerd
 minikube addons enable ingress
 ```
 
-### Download Oracle Backend for Spring Boot
+### Download Oracle Backend for Spring Boot and Microservices
 
 Download the [Oracle Backend for Parse Server](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/onprem-mbaas_latest.zip) and unzip into a new directory.
 
@@ -100,7 +100,7 @@ Build and push the images to the Container Registry in the Kubernetes cluster by
 
 After the images are built and pushed, the tunnel is no longer required and can be stopped.
 
-### Deploy Oracle Backend for Spring Boot
+### Deploy Oracle Backend for Spring Boot and Microservices
 
 Deploy the database and Microservices by running this command:
 

docs-source/mbaas/content/on-premises/ol8/_index.md

@@ -12,20 +12,30 @@ Read [On-Premises](../index.md) and ensure that your desktop meets the minimum s
 
 ### Additional Operating System Packages
 
-Install the following operating system packages:
+As the `root` user, install the following operating system packages:
 
 ```bash
-sudo dnf -y module install container-tools:ol8
-sudo dnf -y install conntrack podman curl
-sudo dnf -y install oracle-database-preinstall-21c
-sudo dnf -y install langpacks-en
-sudo dnf module install python39
+dnf -y module install container-tools:ol8
+dnf -y install conntrack podman curl
+dnf -y install oracle-database-preinstall-21c
+dnf -y install langpacks-en
+dnf module install -y python39
+dnf -y update
 ```
 
 Set the default Python3 to Python 3.9:
 
 ```bash
-sudo alternatives --set python3 /usr/bin/python3.9
+alternatives --set python3 /usr/bin/python3.9
+```
+
+### Install MiniKube
+
+As the `root` user, install minikube:
+
+```bash
+curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
+install minikube-linux-amd64 /usr/local/bin/minikube
 ```
 
 ### Create a Non-Root User
@@ -48,23 +58,16 @@ As the `obaas` user, take these steps:
 1. Log in to the Container Registry:
 
    `podman login container-registry.oracle.com`
-   
+
 2. Pull the database image:
 
-   `podman pull container-registry.oracle.com/database/enterprise:19.19.0.0`
-   
+   `podman pull container-registry.oracle.com/database/enterprise:19.3.0.0`
+
 3. Pull the ORDS image:
 
    `podman pull container-registry.oracle.com/database/ords:21.4.2-gh`
 
-### Install and Start Minikube
-
-As the `root` user, process these commands:
-
-```bash
-curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
-install minikube-linux-amd64 /usr/local/bin/minikube
-```
+### Start Minikube
 
 As the `obaas` user, process these commands:
 
@@ -109,18 +112,11 @@ Assuming the source was unzipped to `~/obaas`, as the `obaas` user, run this com
 
 In order to push the images to the Container Registry in the Kubernetes cluster, open a new terminal and start a port-forward service.
 
-As the `obaas` user, run this command:
-
-`kubectl port-forward service/private -n container-registry 5000:5000 &`
+As the `obaas` user, run these commands:
 
-To test access to the registry, run this command:
-
-`curl -X GET -k https://localhost:5000/v2/_catalog`
-
-This `curl` results in the following:
-
-```text
-{"errors":[{"code":"UNAUTHORIZED","message":"authentication required","detail":[{"Type":"registry","Class":"","Name":"catalog","Action":"*"}]}]}
+```bash
+source ./activate.env
+kubectl port-forward service/private -n container-registry 5000:5000 &`
 ```
 
 ### Build the Images

docs-source/mbaas/themes/hugo-geekdoc/i18n/en.yaml

@@ -36,7 +36,7 @@ posts_tagged_with: All posts tagged with '{{ . }}'
 
 footer_build_with: >
   Built with <svg class="gdoc-icon gdoc_heart"><use xlink:href="#gdoc_heart"></use></svg> by Oracle
-footer_legal_notice: (C) 2022, Oracle and/or its affiliates
+footer_legal_notice: (C) 2022, 2023, Oracle and/or its affiliates
 footer_privacy_policy: Privacy Policy
 footer_content_license_prefix: >
   Content licensed under Universal Permissive License

docs-source/spring/config.toml

@@ -1,6 +1,6 @@
 baseURL = 'https://oracle.github.io/microservices-datadriven/spring/'
 languageCode = 'en-us'
-title = 'Oracle Backend for Spring Boot'
+title = 'Oracle Backend for Spring Boot and Microservices'
 theme = "hugo-geekdoc"
 
 pluralizeListTitles = false

docs-source/spring/content/_index.md

@@ -1,10 +1,10 @@
 ---
-title: "Oracle Backend for Spring Boot - Developer Preview"
+title: "Oracle Backend for Spring Boot and Microservices"
 ---
 
-Oracle Backend for Spring Boot allows developers to build Microservices in Spring Boot and provisions a backend as a service with
-Oracle Database and other infrastructure components that operate on multiple clouds. This service vastly simplifies the task of
-building, testing, and operating Microservices platforms for reliable, secure, and scalable enterprise applications.
+Oracle Backend for Spring Boot and Microservices allows developers to build microservices in Spring Boot and provisions a "backend as a service" with
+Oracle Database and other infrastructure components that operate on multiple clouds. Oracle Backend for Spring Boot and Microservices vastly simplifies the task of
+building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
 
 To learn more, watch this short introductory video:
 
@@ -14,37 +14,59 @@ In addition to an Oracle Autonomous Database Serverless instance, the following
 Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
 
 - Apache APISIX API Gateway and Dashboard
+- Apache Kafka
+- Coherence
+- Grafana
+- HashiCorp Vault
+- Jaeger
+- Loki
+- Netflix Conductor
+- OpenTelemetry Collector
+- Oracle Autonomous Database Serverless
+- Oracle Database Operator for Kubernetes (OraOperator or the operator)
+- Oracle Transaction Manager for Microservices (MicroTx)
+- Prometheus
+- Promtail
 - Spring Eureka service registry
 - Spring Boot Admin dashboard
 - Spring Cloud Config server
-- Netflix Conductor
-- Prometheus
-- Grafana
-- OpenTelemetry Collector
-- Jaeger
-- HashiCorp Vault
-- Apache Kafka
-- Coherence
 
 Developers also have access to development or build time services and libraries including:
 
 - A command-line interface (CLI) to manage service deployment and configuration, including database schema management.
+- Visual Studio Code (VS Code) plugin to manage service deployment and configuration.
 - Spring Data (Java Persistence API (JPA) and Oracle JDBC) to access Oracle Database.
 - Oracle Java Database Connectivity (Oracle JDBC) drivers.
 - Spring Cloud Config client.
 - Spring Eureka service discovery client.
 - Spring Cloud OpenFeign.
 - OpenTelemetry Collector (including automatic instrumentation).
 
+## Learn more, try it out with CloudBank!
+
+To learn more about deploying and using Oracle Backend for Spring Boot and Microservices, we recommend our
+[CloudBank](https://bit.ly/CloudBankOnOBaaS) self-paced, on-demand hands-on lab.
+
+![](./cloudbank-hol.png)
+
+In the [CloudBank](https://bit.ly/CloudBankOnOBaaS) hands-on lab, you can learn how to:
+
+- Install Oracle Backend for Spring Boot and Microservices.
+- Set up a development environment for Spring Boot.
+- Build Spring Boot microservices from scratch using Spring Web to create
+  Representational State Transfer (REST) services.
+- Use service discovery and client-side load balancing.
+- Use Spring Actuator to allow monitoring of services.
+- Create services that use asynchronous messaging with Java Message Service (JMS) instead of REST.
+- Implement the Saga pattern to manage data consistency across microservices.
+- Use the APISIX API Gateway to expose services to clients.
+- Extend a provided Flutter client to add a new "cloud cash" feature that uses the services you have built.
+
  
 {{< hint type=[warning] icon=gdoc_fire title="Interested in Mobile or web apps too?" >}}
 Check out [Oracle Backend for Parse Platform](https://oracle.github.io/microservices-datadriven/mbaas/)!
 {{< /hint >}}
 &nbsp;
 
-## Developer Preview
 
-This release is a *Developer Preview*. This means that not all functionality is complete. In this release, most of the planned services
-and components are provided. However, additional configuration options and components may be provided in a future release. We are releasing
-this as a *Developer Preview* to allow interested developers to try it and provide feedback.
 

docs-source/spring/content/azure/_index.md

@@ -2,8 +2,8 @@
 title: "Azure/OCI Multicloud Installation"
 ---
 
-The Oracle Backend for Spring Boot is available to install in Multicloud (Microsoft Azure (Azure) and Oracle Cloud Infrastructure (OCI)). This installation
-deploys the Oracle Backend for Spring Boot in Azure with an Oracle Autonomous Database running in OCI.
+The Oracle Backend for Spring Boot and Microservices is available to install in Multicloud (Microsoft Azure (Azure) and Oracle Cloud Infrastructure (OCI)). This installation
+deploys the Oracle Backend for Spring Boot and Microservices in Azure with an Oracle Autonomous Database running in OCI.
 
 ## Prerequisites
 
@@ -20,11 +20,11 @@ Watch this video for a quick overview of the setup process.
 
 ## Download
 
-Download [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
+Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
 
 ## Setup
 
-A few setup steps are required in both OCI and Azure to deploy the Oracle Backend for Spring Boot application.
+A few setup steps are required in both OCI and Azure to deploy the Oracle Backend for Spring Boot and Microservices application.
 
 ### OCI
 
@@ -53,7 +53,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following s
 
    ![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
 
-3. Upload the [Oracle Backend for Spring Boot](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas-platform_latest.zip) stack. For example:
+3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas-platform_latest.zip) stack. For example:
 
    ![Azure Upload](AzureUpload.png)
 
@@ -96,4 +96,3 @@ terraform plan -out=multicloud.plan
 terraform apply "multicloud.plan"
 ```
 
-Next, go to the [On-Premises](../on-premises/) page to learn more.