Reorg

common/docs/DeployFunctions.md

@@ -0,0 +1,47 @@
+_Copyright (c) 2019, 2020, 2021 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0_  
+
+# Deployment Functions
+
+The deployment helper functions are defined in common/utils/deploy-functions.env and sourced by common/source.env.  They are used to streamline the deployment of microservices.
+
+## k8s_deploy
+
+Deploy a set of yaml files.  The function accepts a single parameter that represents a space separate list of yaml files to be deployed, for example:
+
+```
+k8s-deploy 'inventory-helidon-deployment.yaml inventory-service.yaml'
+```
+
+### Internals
+
+kubectl apply is used to deploy the files and so the k8s_deploy function is idempotent.
+
+The yaml files are expected to be in the same folder as the script that invokes this function.
+
+The yaml files are processed to substitute environment variables before they are deployed.  The processed yaml files are place in the .deployed folder in the home directory of the microservice.  
+
+The syntax available to define substitution variable is as follows:
+
+- **${VAR}**          Fails if VAR is undefined, else is substitutes the value of VAR
+- **${VAR-default}**  If VAR is not defined substitute 'default', else substitutes the value of VAR
+- **${VAR-}**         If VAR is not defined substitute '', else it substitutes the value of VAR
+- **${VAR?MSG}**      Fails if VAR is undefined with the error 'MSG', else it substitutes value of VAR
+- **${VAR:-default}** If VAR is not defined or empty, substitute 'default', else it substitutes the value of VAR
+- **${VAR:?MSG}**     Fails if VAR is undefined or empty with the error 'MSG', else it substitutes the value of VAR
+
+Here is an example:
+
+```
+- name: OCI_REGION
+  value: "${OCI_REGION-}"
+```
+
+## k8s_undeploy
+
+Undeploy the yaml files what were deployed by k82_deploy.  The files are undeployed in the reverse order.
+
+### Internals
+
+The yaml files of the deployed resources are found in the .deployed folder.  The files are deleted once thay have been undeployed.  
+
+kubectl delete is used to undeploy the resources.

grabdish/config/requirements.env

@@ -3,7 +3,7 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 # Variables to be set in input.env:
-# DB_DEPLOYMENT: 2db
+# DB_DEPLOYMENT: 1DB 2DB
 # DB_TYPE:       atp
 # QUEUE_TYPE:    classicq
 # DB_PASSWORD_SECRET: Name of the secret holding the database password access by function get_secret
@@ -18,4 +18,4 @@
 
 REQ_UTILS="touch cat rm sqlplus grep"
 REQ_INPUT_PARAMS="DB_DEPLOYMENT DB_TYPE QUEUE_TYPE DB_PASSWORD_SECRET UI_PASSWORD_SECRET DB1_NAME DB1_TNS_ADMIN DB1_ALIAS DB2_NAME DB2_TNS_ADMIN DB2_ALIAS CWALLET_OS_BUCKET OCI_REGION GRABDISH_LOG"
-REQ_OUTPUT_PARAMS="ORDER_DB_NAME ORDER_DB_ALIAS ORDER_DB_TNS_ADMIN INVENTORY_DB_NAME INVENTORY_DB_ALIAS INVENTORY_DB_TNS_ADMIN"
+REQ_OUTPUT_PARAMS="ORDER_DB_NAME ORDER_DB_ALIAS ORDER_DB_TNS_ADMIN INVENTORY_DB_NAME INVENTORY_DB_ALIAS INVENTORY_DB_TNS_ADMIN"

grabdish/docs/Build.md

@@ -0,0 +1,36 @@
+_Copyright (c) 2019, 2020, 2021 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0_  
+
+# Grabdish Build Process
+
+It is necessary to build the grabdish microservices before they can be deployed.  Each microservice has its own build script.  A build script compiles the code, constructs a docker image, and pushes the image to the repository.  The image is used when deploying the microservice.  It is possible to run the builds and provisioning in parallel to save time, however, building more than one java based microservice in parallel has been found to be unreliable and so is not recommended.
+
+## Prerequisites
+
+The following are required before building a Grabdish microservice:
+
+1. Java installed
+2. Docker installed
+3. Docker image repository prepared
+4. Software cloned
+
+## Environment Variables
+
+To build grabdish services the following environment variables must be exported:
+
+DOCKER_REGISTRY
+JAVA_HOME
+PATH=${JAVA_HOME}/bin:$PATH
+
+## Steps
+
+1. Change to a service's home folder, for example:
+
+```
+cd inventory-helidon
+```
+
+2. Execute the build script:
+
+```
+./build.sh
+```

grabdish/docs/Deploy.md

@@ -0,0 +1,56 @@
+_Copyright (c) 2019, 2020, 2021 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0_  
+
+# Grabdish Deployment
+
+## Environment Variables
+
+To deploy grabdish services the following environment variables must be exported.  Note, most of these are outputs from the provisioning process:
+
+- ORDER_DB_NAME
+- ORDER_DB_TNS_ADMIN
+- ORDER_DB_ALIAS
+- INVENTORY_DB_NAME
+- INVENTORY_DB_TNS_ADMIN
+- INVENTORY_DB_ALIAS
+- OCI_REGION:                   OCI vault only
+- VAULT_SECRET_OCID:            OCI vault only
+
+## Deploy Steps
+
+1. Source the common environment:
+
+  source microservices-datadriven/common/source.env
+
+2. Change to a microservice's home folder, for example:
+
+```
+cd inventory-helidon
+```
+
+3. Execute the deploy script:
+
+```
+./deploy.sh
+```
+
+## Undeploy Steps
+
+1. Source the common environment:
+
+  source microservices-datadriven/common/source.env
+
+2. Change to a microservice's home folder, for example:
+
+```
+cd inventory-helidon
+```
+
+3. Execute the undeploy script:
+
+```
+./undeploy.sh
+```
+
+## Internals
+
+The deploy.sh and undeploy.sh scripts use the k8s_deploy andf k8s_undeploy helper functions respectively, defined in common/utils/deploy-functions.env and sourced by common/source.env.  See common/docs/DeployFunctions.md for details.