Inventory overview & service

Signed-off-by: NoeSamaille <noe.samaille@ibm.com>
cloud-design-patterns-journey · Apr 19, 2024 · 0a2d655 · 0a2d655
1 parent 54f1d67
commit 0a2d655
Show file tree

Hide file tree

Showing 101 changed files with 3,550 additions and 5 deletions.
diff --git a/docs/images/common/LoginCommand.png b/docs/images/common/LoginCommand.png
diff --git a/docs/images/common/gitpodapplaunch.png b/docs/images/common/gitpodapplaunch.png
diff --git a/docs/images/common/gitpodeditor.png b/docs/images/common/gitpodeditor.png
diff --git a/docs/images/common/gitpodexplorer.png b/docs/images/common/gitpodexplorer.png
diff --git a/docs/images/common/gitpodgitignore.png b/docs/images/common/gitpodgitignore.png
diff --git a/docs/images/common/gitpodlogin.png b/docs/images/common/gitpodlogin.png
diff --git a/docs/images/common/gitpodworkspacecreation.png b/docs/images/common/gitpodworkspacecreation.png
diff --git a/docs/images/common/openshiftcluster.png b/docs/images/common/openshiftcluster.png
diff --git a/docs/images/common/openshiftconsole.png b/docs/images/common/openshiftconsole.png
diff --git a/docs/images/common/openshiftconsoleproject.png b/docs/images/common/openshiftconsoleproject.png
diff --git a/docs/images/common/openshiftproject.png b/docs/images/common/openshiftproject.png
diff --git a/docs/images/common/openshiftwebterminal.png b/docs/images/common/openshiftwebterminal.png
diff --git a/docs/images/common/pushcodeorg.png b/docs/images/common/pushcodeorg.png
diff --git a/docs/images/common/template.png b/docs/images/common/template.png
diff --git a/docs/images/inventory-appid/AppIdInt02a.png b/docs/images/inventory-appid/AppIdInt02a.png
diff --git a/docs/images/inventory-appid/AppIdIntegration01.png b/docs/images/inventory-appid/AppIdIntegration01.png
diff --git a/docs/images/inventory-appid/AppIdIntegration02.png b/docs/images/inventory-appid/AppIdIntegration02.png
diff --git a/docs/images/inventory-appid/AppidInt03.png b/docs/images/inventory-appid/AppidInt03.png
diff --git a/docs/images/inventory-appid/AppidInt04.png b/docs/images/inventory-appid/AppidInt04.png
diff --git a/docs/images/inventory-appid/AppidLogin.png b/docs/images/inventory-appid/AppidLogin.png
diff --git a/docs/images/inventory-appid/appid-authentication-settings.png b/docs/images/inventory-appid/appid-authentication-settings.png
diff --git a/docs/images/inventory-appid/appid-cloud-directory-users.png b/docs/images/inventory-appid/appid-cloud-directory-users.png
diff --git a/docs/images/inventory-appid/appid-redirect-error.png b/docs/images/inventory-appid/appid-redirect-error.png
diff --git a/docs/images/inventory-appid/architecture.png b/docs/images/inventory-appid/architecture.png
diff --git a/docs/images/inventory-appid/argocd-config.png b/docs/images/inventory-appid/argocd-config.png
diff --git a/docs/images/inventory-appid/database.png b/docs/images/inventory-appid/database.png
diff --git a/docs/images/inventory-appid/inventory-ui-design.png b/docs/images/inventory-appid/inventory-ui-design.png
diff --git a/docs/images/inventory-appid/ocp-cli-login.png b/docs/images/inventory-appid/ocp-cli-login.png
diff --git a/docs/images/inventory-application/appid-authentication-settings.png b/docs/images/inventory-application/appid-authentication-settings.png
diff --git a/docs/images/inventory-application/appid-cloud-directory-users.png b/docs/images/inventory-application/appid-cloud-directory-users.png
diff --git a/docs/images/inventory-application/appid-redirect-error.png b/docs/images/inventory-application/appid-redirect-error.png
diff --git a/docs/images/inventory-application/architecture.png b/docs/images/inventory-application/architecture.png
diff --git a/docs/images/inventory-application/gradlerun.png b/docs/images/inventory-application/gradlerun.png
diff --git a/docs/images/inventory-application/inventory-ui-design.png b/docs/images/inventory-application/inventory-ui-design.png
diff --git a/docs/images/inventory-bff/bff-overview.jpeg b/docs/images/inventory-bff/bff-overview.jpeg
diff --git a/docs/images/inventory-cd/Artifactory-SetMeUp.png b/docs/images/inventory-cd/Artifactory-SetMeUp.png
diff --git a/docs/images/inventory-cd/ArtifactoryMenu.png b/docs/images/inventory-cd/ArtifactoryMenu.png
diff --git a/docs/images/inventory-cd/appid-authentication-settings.png b/docs/images/inventory-cd/appid-authentication-settings.png
diff --git a/docs/images/inventory-cd/appid-cloud-directory-users.png b/docs/images/inventory-cd/appid-cloud-directory-users.png
diff --git a/docs/images/inventory-cd/appid-redirect-error.png b/docs/images/inventory-cd/appid-redirect-error.png
diff --git a/docs/images/inventory-cd/architecture.png b/docs/images/inventory-cd/architecture.png
diff --git a/docs/images/inventory-cd/argocd-config.png b/docs/images/inventory-cd/argocd-config.png
diff --git a/docs/images/inventory-cd/artifactoryurlsetup.png b/docs/images/inventory-cd/artifactoryurlsetup.png
diff --git a/docs/images/inventory-cd/database.png b/docs/images/inventory-cd/database.png
diff --git a/docs/images/inventory-cd/inventory-ui-design.png b/docs/images/inventory-cd/inventory-ui-design.png
diff --git a/docs/images/inventory-mongodb/ResultScreen.png b/docs/images/inventory-mongodb/ResultScreen.png
diff --git a/docs/images/inventory-mongodb/mongodbibmcloud.png b/docs/images/inventory-mongodb/mongodbibmcloud.png
diff --git a/docs/images/inventory-mongodb/mongodbopenshift.png b/docs/images/inventory-mongodb/mongodbopenshift.png
diff --git a/docs/images/inventory-mongodb/mongodbopenshiftsecret.png b/docs/images/inventory-mongodb/mongodbopenshiftsecret.png
diff --git a/docs/images/inventory-mongodb/secret-creation-openshift.png b/docs/images/inventory-mongodb/secret-creation-openshift.png
diff --git a/docs/images/inventory-mongodb/servicecreds.png b/docs/images/inventory-mongodb/servicecreds.png
diff --git a/docs/images/inventory-service/crwexposeservice.png b/docs/images/inventory-service/crwexposeservice.png
diff --git a/docs/images/inventory-service/crwopenapp.png b/docs/images/inventory-service/crwopenapp.png
diff --git a/docs/images/inventory-service/crwopenlink.png b/docs/images/inventory-service/crwopenlink.png
diff --git a/docs/images/inventory-service/gitpod01.png b/docs/images/inventory-service/gitpod01.png
diff --git a/docs/images/inventory-service/gitpod02.png b/docs/images/inventory-service/gitpod02.png
diff --git a/docs/images/inventory-service/swaggerui.png b/docs/images/inventory-service/swaggerui.png
diff --git a/docs/images/inventory-service/viewapp.png b/docs/images/inventory-service/viewapp.png
diff --git a/docs/images/inventory-ui/ui-graphql-data.png b/docs/images/inventory-ui/ui-graphql-data.png
diff --git a/docs/images/inventory-ui/ui-init-components.png b/docs/images/inventory-ui/ui-init-components.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppIdInt02a.png b/docs/labs/inventory-app/inventory-appid/images/AppIdInt02a.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppIdIntegration01.png b/docs/labs/inventory-app/inventory-appid/images/AppIdIntegration01.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppIdIntegration02.png b/docs/labs/inventory-app/inventory-appid/images/AppIdIntegration02.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppidInt03.png b/docs/labs/inventory-app/inventory-appid/images/AppidInt03.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppidInt04.png b/docs/labs/inventory-app/inventory-appid/images/AppidInt04.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/AppidLogin.png b/docs/labs/inventory-app/inventory-appid/images/AppidLogin.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/appid-authentication-settings.png b/docs/labs/inventory-app/inventory-appid/images/appid-authentication-settings.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/appid-cloud-directory-users.png b/docs/labs/inventory-app/inventory-appid/images/appid-cloud-directory-users.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/appid-redirect-error.png b/docs/labs/inventory-app/inventory-appid/images/appid-redirect-error.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/architecture.png b/docs/labs/inventory-app/inventory-appid/images/architecture.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/argocd-config.png b/docs/labs/inventory-app/inventory-appid/images/argocd-config.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/database.png b/docs/labs/inventory-app/inventory-appid/images/database.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/inventory-ui-design.png b/docs/labs/inventory-app/inventory-appid/images/inventory-ui-design.png
diff --git a/docs/labs/inventory-app/inventory-appid/images/ocp-cli-login.png b/docs/labs/inventory-app/inventory-appid/images/ocp-cli-login.png
diff --git a/docs/labs/inventory-app/inventory-appid/index.md b/docs/labs/inventory-app/inventory-appid/index.md
@@ -0,0 +1,208 @@
+---
+title: Authentication with App ID
+---
+<!--- cSpell:ignore ICPA openshiftconsole Theia userid toolset crwexposeservice gradlew bluemix ocinstall Mico crwopenlink crwopenapp swaggerui gitpat gituser  buildconfig yourproject wireframe devenvsetup viewapp crwopenlink  atemplatized rtifactoryurlsetup Kata Koda configmap Katacoda checksetup cndp katacoda checksetup Linespace igccli regcred REPLACEME Tavis pipelinerun openshiftcluster invokecloudshell cloudnative sampleapp bwoolf hotspots multicloud pipelinerun Sricharan taskrun Vadapalli Rossel REPLACEME cloudnativesampleapp artifactoryuntar untar Hotspot devtoolsservices Piyum Zonooz Farr Kamal Arora Laszewski  Roadmap roadmap Istio Packt buildpacks automatable ksonnet jsonnet targetport podsiks SIGTERM SIGKILL minikube apiserver multitenant kubelet multizone Burstable checksetup handson  stockbffnode codepatterns devenvsetup newwindow preconfigured cloudantcredentials apikey Indexyaml classname  errorcondition tektonpipeline gradlew gitsecret viewapp cloudantgitpodscreen crwopenlink cdply crwopenapp -->
+
+**Securing Inventory App with App ID**
+
+To secure the application we are using the capabilities available within the IBM Cloud platform to enable integration with AppID.  
+With Openshift 3.11, a simple annotation was used on the ingress to enable Appid. In Openshift 4.x, Red Hat OpenShift on IBM Cloud annotations (ingress.bluemix.net/[annotation]) and NGINX annotations (nginx.ingress.kubernetes.io/[annotation_name]) are not supported for the router or the Ingress resource.  
+With Openshift 4.x, AppID integration is enabled with SDKs.
+
+## Prerequisites
+
+The following prerequisites are required for AppID integration:  
+
+- An instance of the App ID service:
+  In IBM Cloud Dashboard, go to "Services" and select the AppID instance.
+
+  ![AppID Service](images/AppIdIntegration01.png)
+
+- A set of service credentials:
+    - In AppID instance, go to "Application". 
+    - Click on "Add application".
+    - Enter your application name 
+    - Select the type as Regular web application.
+    - Click on Save to create the service credentials for your application.
+
+    ![AppID Credentials Creation](images/AppIdInt02a.png)
+
+    - After saving, your application credentials will get created.Click on the down Arrow at 
+    the left end of your application name and get the credentials.
+
+    ![AppID Credentials Creation](images/AppidInt03.png)
+
+
+- `yarn` version 1.22.19 or higher.
+- `node` version 16.16.0 or higher (it is recommended that you use an LTS version).
+
+!!! note
+    To install `yarn` run the command `npm install -g yarn`
+
+
+## Enable Appid in the solution
+
+### Installation
+-   By using the command line, change to the directory that contains your Node.js app.
+-   Install the AppID service and other dependencies.
+
+    ```bash
+    yarn add ibmcloud-appid passport@0.5.2 express-session
+    ```
+
+-  Obtain your credentials by navigating to the **Applications** tab of the AppID dashboard as mentioned in [Prerequisites](#prerequisites).
+
+-  Obtain the application as mentioned in [AppID Redirect Url Config](#appid-redirect-url-config).
+
+### Create binding secret for appid in your namespace
+- Login to the IBM Cloud cluster where your workshop-team-one ocp cluster resides.
+  ```bash
+  ibmcloud login -u [username] -p [password]
+  ```
+- Login to your ocp cluster using the oc cli.
+
+  ![Openshift cli login Page](images/ocp-cli-login.png)  
+
+  - Click on "Copy Login Command". It will redirect to a new page.  
+
+  - Click the display token link. Copy the "Log in with this token" command & login to `oc` cli, it should look like this :
+
+    ```bash
+    oc login --token=sha256~bfGcq7l6H3JHd9GwbNRaSsJ7cDAiLK5EPF4tbPQ-WfY --server=https://c108-e.eu-gb.containers.cloud.ibm.com:31718
+    ```
+
+- Navigate to your namespace where you are running the inventory solution pipeline and create the binding secret for He the Appid instance on the cloud account
+  ```bash
+  oc project <PROJECT_NAME>
+  ibmcloud oc cluster service bind --cluster workshop-team-one --namespace <PROJECT_NAME> --service workshop-team-one-appid
+  ```
+!!! note
+    Save the binding name, you will use it later
+
+
+### Update the configuration values in the configuration files
+- Put these credentials in *server/config/mappings.json* to be referred by application:
+   ```json title="server/config/mappings.json"
+   {
+    "APPID_CONFIG": ""{\"tenantId\":\"<tenantId_value>\",\"oauthServerUrl\":\"<oauthServer_URL>\",\"clientId\": \"<ClientID_value>\", \"secret\": \"<secret_value>\"}",
+    "application_url":"<openshift_appln_route_url>"
+   }
+   ```
+
+- Add the following parameter in `values.yaml` along with its value:
+   ```yaml title="chart/base/values.yaml"
+   appidBinding: <BINDING_NAME>
+   ```
+
+### Adding the dependencies
+- Add the following *require* definitions to your `server/server.js`:
+    ```bash title="server/server.js"
+    const express = require('express');
+    const session = require('express-session')
+    const passport = require('passport');
+    const WebAppStrategy = require("ibmcloud-appid").WebAppStrategy;
+    const CALLBACK_URL = "/ibm/cloud/appid/callback";
+    const appidConfig = require("./config/mappings.json");
+    ```
+
+### Activate the appid integration
+- In *server.js*, set up your express app to use express-session middleware.
+   ```javascript title="server/server.js"
+   const app = express();
+
+   const appidcfg = appidConfig.APPID_CONFIG;
+
+   app.use(
+     session({
+           secret: appidcfg.secret,
+           resave: true,
+           saveUninitialized: true
+     })
+   );
+   app.use(passport.initialize());
+   app.use(passport.session());
+   ```
+
+- In the same file, initialize the SDK using the information obtained in the previous steps.
+   ```javascript title="server/server.js"
+
+   passport.use(
+     new WebAppStrategy({
+       tenantId: appidcfg.tenantId,
+       clientId: appidcfg.clientId,
+       secret: appidcfg.secret,
+       oauthServerUrl: appidcfg.oAuthServerUrl,
+       redirectUri: appidConfig.application_url + CALLBACK_URL
+     })
+   );
+   ```
+
+-   In the same file, configure passport with serialization and deserialization. This configuration step is required for authenticated session persistence across HTTP requests. For more information, see the [passport docs](http://www.passportjs.org/docs/)
+    ```javascript title="server/server.js"
+    passport.serializeUser(function(user, cb) {
+      cb(null, user);
+    });
+    passport.deserializeUser(function(obj, cb) {
+      cb(null, obj);
+    });
+    ```
+
+-   Add the following code to your *server.js* to issue the service redirects.
+    ```javascript title="server/server.js" 
+    app.get(CALLBACK_URL, passport.authenticate(WebAppStrategy.STRATEGY_NAME));
+    app.use(passport.authenticate(WebAppStrategy.STRATEGY_NAME ));
+    ```
+
+### Adding environment variables to `deployment.yaml`
+- Open the `deployment.yaml` file and add environment variables that use those values to the top of the existing `env` block:
+  ```yaml title="chart/base/templates/deployment.yaml"
+  - name: APPID_CONFIG
+    valueFrom:
+       secretKeyRef:
+          name: {{ .Values.appidBinding | quote }}
+          key: binding
+  ```
+
+### AppID redirect url config
+
+- Get the ingress for the UI component by running `igc ingress -n dev-{initials}`.
+
+- Open the IBM Cloud resource list - `https://cloud.ibm.com/resources`
+
+- Open the AppID instance to the `Manage Authentication` -> `Authentication Settings` view
+
+    ![AppID authentication settings](images/appid-authentication-settings.png)
+
+- Add the redirect url for the application to the web redirect URLs. The redirect url will have
+the following form:
+
+    `{ingress url}/ibm/cloud/appid/callback`
+
+    e.g. `https://inventory-manangement-ui-dev.sms-test-oc-cluster.us-east.containers.appdomain.cloud/ibm/cloud/appid/callback`
+
+### Add users to AppID
+
+- Open the AppID instance to `Cloud Directory` -> `Users`
+
+    ![AppID cloud directory users](images/appid-cloud-directory-users.png)
+
+- Add yourself as a user with an email address, name, and password#
+
+### Commit and push the changes
+- Commit your local changes and push them to your remote repository
+  ```bash
+  git add .
+  git commit -m "Added appid"
+  git push
+  ```
+- Your previously defined pipeline should be launched and the new app should be deployed afterwards
+
+### Access the UI
+
+- Open a browser to the UI Application URL
+
+- You should be met with the AppID login screen. (This screen can be customized from the AppID service console but for now we are showing the default screen.)
+
+     ![AppID Login Page](images/AppidLogin.png)
+
+- Provide the email address and password you configured in the previous steps. You should be granted access to the UI.
diff --git a/...bs/inventory-app/inventory-application/images/appid-authentication-settings.png b/...bs/inventory-app/inventory-application/images/appid-authentication-settings.png
diff --git a/...labs/inventory-app/inventory-application/images/appid-cloud-directory-users.png b/...labs/inventory-app/inventory-application/images/appid-cloud-directory-users.png
diff --git a/docs/labs/inventory-app/inventory-application/images/appid-redirect-error.png b/docs/labs/inventory-app/inventory-application/images/appid-redirect-error.png
diff --git a/docs/labs/inventory-app/inventory-application/images/architecture.png b/docs/labs/inventory-app/inventory-application/images/architecture.png
diff --git a/docs/labs/inventory-app/inventory-application/images/gradlerun.png b/docs/labs/inventory-app/inventory-application/images/gradlerun.png
diff --git a/docs/labs/inventory-app/inventory-application/images/inventory-ui-design.png b/docs/labs/inventory-app/inventory-application/images/inventory-ui-design.png
diff --git a/docs/labs/inventory-app/inventory-application/index.md b/docs/labs/inventory-app/inventory-application/index.md
@@ -0,0 +1,48 @@
+<!--- cSpell:ignore ICPA openshiftconsole Theia userid toolset crwexposeservice gradlew bluemix ocinstall Mico crwopenlink crwopenapp swaggerui gitpat gituser  buildconfig yourproject wireframe devenvsetup viewapp crwopenlink  atemplatized rtifactoryurlsetup Kata Koda configmap Katacoda checksetup cndp katacoda checksetup Linespace igccli regcred REPLACEME Tavis pipelinerun openshiftcluster invokecloudshell cloudnative sampleapp bwoolf hotspots multicloud pipelinerun Sricharan taskrun Vadapalli Rossel REPLACEME cloudnativesampleapp artifactoryuntar untar Hotspot devtoolsservices Piyum Zonooz Farr Kamal Arora Laszewski  Roadmap roadmap Istio Packt buildpacks automatable ksonnet jsonnet targetport podsiks SIGTERM SIGKILL minikube apiserver multitenant kubelet multizone Burstable checksetup handson  stockbffnode codepatterns devenvsetup newwindow preconfigured cloudantcredentials apikey Indexyaml classname  errorcondition tektonpipeline gradlew gitsecret viewapp cloudantgitpodscreen crwopenlink cdply crwopenapp -->
+
+Develop an example application with a three-tier microservices architecture and deploy it into Red Hat OpenShift on premises, on AWS, Azure or IBM Cloud. This OpenShift development environment has been pre-configured with a sample [SDLC](https://cio-wiki.org/wiki/Software_Development_Life_Cycle_(SDLC)) (Software Delivery Life Cycle).
+
+## Business Need
+
+In this guide, imagine you have completed an Enterprise Design Thinking Workshop and the result is an MVP statement that defines the desired business outcomes. Use the steps below to help deliver this MVP quickly while following [Garage Method best practices](https://www.ibm.com/garage/method/cloud/).
+
+### MVP Statement
+
+An **MVP** is a **first hill**. Here's the hill statement for the MVP we're going to build:
+
+- **Who**: Distribution employees in each of the regional warehouses
+
+- **What**: A secure web application that enables easy access to list of product [SKU](https://en.wikipedia.org/wiki/Stock_keeping_unit) inventory levels and inventory locations
+
+- **Wow**: Make the system appealing and easy to use. Develop it quickly as a minimum viable product. Use the latest managed container runtimes and DevOps best practices to enable post MVP feature improvements. Simulate a release to a _Test_ environment.
+
+## Architecture
+
+We will build an application that is made up of microservices in three-tier architecture. Each tier encapsulates a clean separation of concerns. Each app microservice component will be modelled using _microservices_ and use a number of [polyglot](https://searchsoftwarequality.techtarget.com/definition/polyglot-programming) programming languages and frameworks. Data will be stored in a NoSQL Database.
+
+![Architecture](images/architecture.png)
+
+### User interface
+
+The user experience for the application has been designed by the design team and this drives the requirements for the development team.
+
+### Technical Requirements
+
+The Micro services should adhere to the following technical requirements:
+
+- Microservices
+    - Stateless
+    - REST APIs
+    - Polyglot
+- DevOps with CI/CD (continuous integration and continuous delivery) 
+    - Use in cluster CI technology to be efficient and secure
+    - Use latest GitOps best practices
+    - Monitoring and logging
+    - Code analysis
+    - App security
+- Deployed to Red Hat OpenShift cluster which is based on Kubernetes open source technology
+- Follow the [Carbon Design System](https://www.carbondesignsystem.com/) user experience
+
+## Guide
+
+You will approach creating the microservices bottom up, meaning you will start by creating the backend microservice that manages integration with the data persistence and then build out the digital channel using a backend for frontend pattern. Finally, you will add a web UI to the solution.
diff --git a/docs/labs/inventory-app/inventory-bff/images/bff-overview.jpeg b/docs/labs/inventory-app/inventory-bff/images/bff-overview.jpeg