Skip to content

Commit 0c01bfa

Browse files
Matthew PerrinsSean Sundberg
andauthored
Updates (#247)
* Update inventory pages * Update changes for Deploy App * Fixes spelling error Signed-off-by: Sean Sundberg <[email protected]> Co-authored-by: Sean Sundberg <[email protected]>
1 parent c098439 commit 0c01bfa

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

docs/developer-intermediate/inventory-application/index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!--- 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 -->
22

3-
**Develop and deploy an example microservices application**
3+
**Develop and deploy an example microservices application within OpenShift**
44

5-
Develop an example application with a three-tier microservices architecture and deploy it in IBM Cloud Kubernetes Service or Red Hat OpenShift on IBM Cloud using the IBM Garage Cloud-Native Toolkit Developer Environment including its Code Patterns.
5+
Develop an example application with a three-tier microservices architecture and deploy it into a Red Hat OpenShift on AWS, Azure or IBM Cloud. This OpenShift development environment has be pre-configured with a sample [SDLC](https://cio-wiki.org/wiki/Software_Development_Life_Cycle_(SDLC))(Software Delivery Life Cycle) using the [Cloud-Native Toolkit](https://develop.cloudnativetoolkit.dev/).
66

77
## Business Need
88

@@ -20,31 +20,33 @@ An [MVP](https://www.ibm.com/garage/method/practices/think/practice_minimum_viab
2020

2121
## Architecture
2222

23-
We will build the Micro App using a three-tier microservices architecture. Each tier encapsulates a clean separation of concerns. Each app 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 IBM Cloudant and the Micro App will be secured using IBM App ID.
23+
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.
2424

2525
![Architecture](images/architecture.png)
2626

2727
### User interface
2828

29-
The Micro App's user interface will look like this [wireframe](https://www.ibm.com/garage/method/practices/think/practice_wireframes/):
29+
The user experience for the application has been designed by the design team and this drives the requirements for the development team this is a representation of the final user experience [wireframe](https://www.ibm.com/garage/method/practices/think/practice_wireframes/):
3030

3131
![UI Design](images/inventory-ui-design.png)
3232

3333
### Technical Requirements
3434

35-
The Micro App should adhere to the following technical requirements:
35+
The Micro services should adhere to the following technical requirements:
3636

3737
- Microservices
3838
- Stateless
3939
- REST APIs
4040
- Polyglot
41-
- DevOps with CI/CD (continuous integration and continuous delivery)
41+
- DevOps with CI/CD (continuous integration and continuous delivery)
42+
- Use in cluster CI technology to be efficient and secure
43+
- Use latest GitOps best practices
4244
- Monitoring and logging
4345
- Code analysis
4446
- App security
45-
- Deployed to Red Hat OpenShift on IBM Cloud or IBM Cloud Kubernetes Service
47+
- Deployed to Red Hat OpenShift cluster which is based on Kubernetes open source technology
4648
- Follow the [Carbon Design System](https://www.carbondesignsystem.com/) user experience
4749

4850
## Guide
4951

50-
You will approach creating the Micro App 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.
52+
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.

docs/developer-intermediate/inventory-prebuilt-solution/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
<!--- 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 -->
44

5-
If you want to skip the guide and just get the components running, see [Deploy the Inventory App solution](#deploy-the-inventory-app-solution).
65

6+
!!! Info
7+
If you want to skip the step by step guide to how you build out each microservice you can go strait to the completed solution and get it running, see [Deploy the Inventory App solution](#deploy-the-inventory-app-solution). I would advise coming back and working through the steps, you will learn more about how these types of solutions are created and delivered.
78

89
## Deploy the Inventory App solution
910

10-
If you were unable to get everything working, you can deploy the Inventory App solution.
11-
11+
In some cases with self pace hands on labs you may not get everything working. Cloud-Native development is a sort of skill and takes time to hone the craft. If you were unable to get everything working, you can deploy the Inventory App solution using the steps detailed below.
1212

1313
### Inventory Service
1414

1515
- Create a new project from the [Inventory Management Service solution template](https://github.com/ibm-ecosystem-lab/inventory-management-svc-intermediate/generate)
16-
named `inventory-management-svc-solution`
16+
named `inv-man-svc-sol-{initials}`
1717

1818
- Clone the repository to your local machine
1919

@@ -26,7 +26,7 @@ named `inventory-management-svc-solution`
2626
- Register the pipeline [register the pipeline](/developer-intermediate/deploy-app#5.-register-the-application-in-a-devops-pipeline)
2727
2828
```
29-
oc pipeline --tekton
29+
oc pipeline <git repo url> --tekton
3030
```
3131
3232
replacing `{your initials}` with your actual initials
541 KB
Loading

mkdocs.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ nav:
103103
- Artifact Management: developer-intermediate/artifact-management/index.md
104104
- Code Analysis: developer-intermediate/code-analysis/index.md
105105
- Image Registry:
106-
- IBM Cloud: developer-intermediate/image-registry/index.md
107106
- OpenShift: developer-intermediate/ocp-registry/index.md
107+
- IBM Cloud: developer-intermediate/image-registry/index.md
108108
- Log Management:
109-
- IBM Cloud: developer-intermediate/log-management/index.md
110109
- OpenShift: developer-intermediate/log-management/index.md
110+
- IBM Cloud: developer-intermediate/log-management/index.md
111111
- Monitoring:
112-
- IBM Cloud: developer-intermediate/monitoring/index.md
113112
- OpenShift: developer-intermediate/ocp-monitoring/index.md
113+
- IBM Cloud: developer-intermediate/monitoring/index.md
114114
- Inventory App:
115115
- Intro: developer-intermediate/inventory-application/index.md
116116
- Solution: developer-intermediate/inventory-prebuilt-solution/index.md
@@ -123,5 +123,3 @@ nav:
123123
- Database with MongoDB: developer-advanced-1/database-with-mongodb/index.md
124124
- Authentication with AppID: developer-advanced-1/inventory-appid/index.md
125125
- Code Engine: developer-advanced-1/code-engine/index.md
126-
127-

0 commit comments

Comments
 (0)