Skip to content

Commit 0ce5888

Browse files
MarcGueurykaylienanooshapilli
authored
WMS 11499: new version with fix to OCI Cloud Shell + Change of build.sh to starter.sh (oracle-livelabs#445)
* OpenSearch - ObjectStorage V1 * Opensearch v2 * v3 * V3 * Image Alternative Texts * V2 * V2 * v4 * V4 * Update manifest.json * additional step * various fixes * various fixes * OCI Starter * OpenSearch New version screen user/password * Update visual_builder.md * 2023-03-18 * 2023-03-18 * 2023-03-18 * 2023-03-21 * APIM * APIM * Update test.md * Update test.md * APIM * APIM * Update test.md * APIM * APIM * APIM * APIM * APIM * APIM * APIM * APIM * APIM * Formatting * Formatting * Numbering * Update intro.md * Lab 2 Task 2 indentation * - * 2023-06-05 * 2023-06-05 * 2023-06-05 * 2023-06-05 * 2023-06-05 * 2023-06-06 * 2023-06-06 * 2023-06-12 * 2023-06-12 * 2023-07-31 * 2023-08-01 * 2023-08-01 * Videos * Video * Update integration.md * Update integration.md * oci-starter-lab v1 * Update intro.md * OCI-Starter V2 * push oci-portal * OCI Starter Lab v1 * QA * . files removed * Removed beta remark. * oci starter - formatting * OCI-Starter * oci-starter bullets * Introduction tag * Green Button (1rst version) * LiveLabs Green Button * Small title change * Instance Pool Lab * Instance Pool * TLS * ARM * ARM * TLS * Database Actions * Database Action v2 * oci-starter 3.2 --------- Co-authored-by: Kaylien Phan <[email protected]> Co-authored-by: Anoosha Pilli <[email protected]>
1 parent fd68e07 commit 0ce5888

File tree

13 files changed

+276
-144
lines changed

13 files changed

+276
-144
lines changed

oci-starter-lab/advanced/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ There are 4 ways to have a TLS certificate:
101101

102102
* Author - Marc Gueury
103103
* Contributors - Ewan Slater
104-
* Last Updated - Nov, 2th 2023
104+
* Last Updated - Jan, 20th 2025

oci-starter-lab/compute/compute.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,22 @@ Please read the chapter: Introduction and Get Started.
5656
- Click *Open*
5757
![Editor File Open](images/starter-compute-dir.png)
5858
2. The main files are:
59-
- Commands:
60-
- build.sh : Build the whole program: Run Terraform, Configure the DB, Build the App, Build the UI
61-
- destroy.sh : Destroy the objects created by Terraform
62-
- env.sh : Contains the settings of your project
63-
- Directories:
64-
- src : Sources files
65-
- app : Source of the Backend Application (Command: build_app.sh)
66-
- ui : Source of the User Interface (Command: build_ui.sh)
67-
- db : SQL files of the database
68-
- terraform : Terraform scripts (Command: plan.sh / apply.sh)
69-
- compute : Contains the deployment files to Compute
70-
- bin : with some helper commands
71-
- bin/ssh\_compute.sh (to ssh to the Compute)
72-
- bin/ssh\_bastion.sh (to ssh to the Bastion)
59+
60+
| | | | Description |
61+
| ----------- | ---------- | --------- | ---|
62+
| Commands | | | |
63+
| | starter.sh | | Build or destroy a project. Show a menu with commands if not argument is given |
64+
| | env.sh | | Settings of your project |
65+
| Directories | | | Commands used by starter.sh |
66+
| | bin/ | | Commands used by starter.sh |
67+
| | src/ | | Sources files |
68+
| | | app | Backend Application (Command: build_app.sh) |
69+
| | | ui | User Interface (Command: build_ui.sh) |
70+
| | | db | Database initialisation files (SQL, ...) |
71+
| | | terraform | Terraform scripts |
72+
| | | compute | Deployment to Compute |
73+
| | target/ | | Output directory |
74+
7375
3. Edit the env.sh file:
7476
- Choose the env.sh file.
7577
- Look for \_\_TO_FILL\_\_ in the file
@@ -79,7 +81,7 @@ Please read the chapter: Introduction and Get Started.
7981
- If not, the script will create a "oci-starter" compartment
8082
![Editor env.sh](images/starter-compute-env.png)
8183
82-
## Task 3: Build.sh
84+
## Task 3: Starter.sh
8385
8486
During the build, Terraform will create:
8587
- Network resources: VCN, Subnet
@@ -92,9 +94,11 @@ During the build, Terraform will create:
9294
- then run:
9395
```
9496
<copy>
95-
./build.sh
97+
./starter.sh
9698
</copy>
9799
```
100+
- Choose **Build**
101+
![Result](images/starter-starter-build.png)
98102
- It will build all and at the end you will see:
99103
```
100104
<copy>
@@ -119,13 +123,23 @@ Please also check the "Lab 6 - How to Customize" to see how to customize this s
119123
### SSH
120124
121125
During the build, it has generated 2 files:
122-
- id\_starter\_rsa : a ssh private key to login to the compute and bastion
123-
- id\_starter\_rsa.pub : the public ssh private key installed in the compute and bastion
126+
- ssh\_key\_starter : a ssh private key to login to the compute and bastion
127+
- ssh\_key\_starter.pub : the public ssh private key installed in the compute and bastion
128+
129+
You can login to the compute by
130+
- running:
131+
```
132+
<copy>
133+
./starter.sh
134+
</copy>
135+
```
136+
- Choose **Advanced**
137+
- Then **SSH / Compute**
124138
125-
You can login to the compute by running:
139+
It is identical to run this command:
126140
```
127141
<copy>
128-
bin/ssh_compute.sh
142+
./starter.sh ssh compute
129143
</copy>
130144
```
131145
@@ -138,7 +152,7 @@ The interesting directories are:
138152
1. To clean up, run
139153
```
140154
<copy>
141-
./destroy.sh
155+
./starter.sh destroy
142156
</copy>
143157
```
144158
@@ -153,5 +167,5 @@ The interesting directories are:
153167
154168
* Author - Marc Gueury
155169
* Contributors - Ewan Slater
156-
* Last Updated - Nov, 2th 2023
170+
* Last Updated - Jan, 20th 2025
157171

oci-starter-lab/compute/compute_green.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -69,28 +69,30 @@ We will use to Advanced tab to work with the limits of the LiveLab sandbox. (Exi
6969
- Click *Open*
7070
![Editor File Open](images/starter-compute-dir.png)
7171
2. The main files are:
72-
- Commands:
73-
- build.sh : Build the whole program: Run Terraform, Configure the DB, Build the App, Build the UI
74-
- destroy.sh : Destroy the objects created by Terraform
75-
- env.sh : Contains the settings of your project
76-
- Directories:
77-
- src : Sources files
78-
- app : Source of the Backend Application (Command: build_app.sh)
79-
- ui : Source of the User Interface (Command: build_ui.sh)
80-
- db : SQL files of the database
81-
- terraform : Terraform scripts (Command: plan.sh / apply.sh)
82-
- compute : Contains the deployment files to Compute
83-
- bin : with some helper commands
84-
- bin/ssh\_compute.sh (to ssh to the Compute)
85-
- bin/ssh\_bastion.sh (to ssh to the Bastion)
72+
73+
| | | | Description |
74+
| ----------- | ---------- | --------- | ---|
75+
| Commands | | | |
76+
| | starter.sh | | Build or destroy a project. Show a menu with commands if not argument is given |
77+
| | env.sh | | Settings of your project |
78+
| Directories | | | Commands used by starter.sh |
79+
| | bin/ | | Commands used by starter.sh |
80+
| | src/ | | Sources files |
81+
| | | app | Backend Application (Command: build_app.sh) |
82+
| | | ui | User Interface (Command: build_ui.sh) |
83+
| | | db | Database initialisation files (SQL, ...) |
84+
| | | terraform | Terraform scripts |
85+
| | | compute | Deployment to Compute |
86+
| | target/ | | Output directory |
87+
8688
3. Check the env.sh file:
8789
- Choose the env.sh file.
8890
- Since we are in LiveLasbs installation, all the settings will be found automatically.
8991
- TF_VAR\_compartment\_ocid, TF\_VAR\_vcn\_ocid / TF\_VAR\_public\_subnet\_ocid, TF\_VAR\_private\_subnet\_ocid will be found automatically.
9092
- The database password, if not filled, will be randomly generated.
9193
![Editor env.sh](images/starter-compute-env.png)
9294
93-
## Task 3: Build.sh
95+
## Task 3: Starter.sh
9496
9597
During the build, Terraform will reuse the
9698
- Network resources: VCN, Subnet
@@ -101,12 +103,12 @@ Then create:
101103
102104
1. In the code editor,
103105
- in the menu *Terminal / New Terminal*.
104-
- then run:
105-
```
106+
- run
106107
<copy>
107-
./build.sh
108+
./starter.sh
108109
</copy>
109-
```
110+
- choose Build
111+
![Result](images/starter-starter-build.png)
110112
- It will build all and at the end you will see:
111113
```
112114
<copy>
@@ -124,7 +126,7 @@ Then create:
124126
125127
## Task 4: More info
126128
127-
OCI Starter running in your own tenancy or not has a lot more options like Kubernetes or Container Instances.
129+
This livelab is limited to Compute. If you use your own tenancy, there are a lot more options like Kubernetes or Container Instances.
128130
129131
You can also check how it works and how to customize what you built.
130132
@@ -135,17 +137,17 @@ Please also check the "Lab 3 - How to Customize" to see how to customize this s
135137
### SSH
136138
137139
During the build, it has generated 2 files:
138-
- id\_starter\_rsa : a ssh private key to login to the compute and bastion
139-
- id\_starter\_rsa.pub : the public ssh private key installed in the compute and bastion
140+
- ssh\_key\_starter : a ssh private key to login to the compute and bastion
141+
- ssh\_key\_starter.pub : the public ssh private key installed in the compute and bastion
140142
141143
You can login to the compute by running:
142144
```
143145
<copy>
144-
bin/ssh_compute.sh
146+
./starter.sh ssh compute
145147
</copy>
146148
```
147149
148-
The interesting directories are:
150+
When you are on the compute, the interesting directories are:
149151
- $HOME/app with the compiled application
150152
- /usr/share/nginx/html/ with the HTML pages
151153
@@ -154,7 +156,7 @@ The interesting directories are:
154156
1. To clean up, run
155157
```
156158
<copy>
157-
./destroy.sh
159+
./starter.sh destroy
158160
</copy>
159161
```
160162
@@ -169,5 +171,5 @@ The interesting directories are:
169171
170172
* Author - Marc Gueury
171173
* Contributors - Ewan Slater
172-
* Last Updated - Nov, 2th 2023
174+
* Last Updated - Jan, 20th 2025
173175
17.6 KB
Loading

oci-starter-lab/container_instance/container_instance.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,22 @@ Please read the chapter: Introduction and Get Started.
5656
- Click *Open*
5757
![Editor File Open](images/starter-compute-dir.png)
5858
2. The main files are:
59-
#### Commands
60-
- build.sh : Build the whole program: Run Terraform, Configure the DB, Build the App, Build the UI
61-
- destroy.sh : Destroy the objects created by Terraform
62-
- env.sh : Contains the settings of your project
63-
#### Directories
64-
- src : Sources files
65-
- app : Source of the Backend Application (Command: build_app.sh)
66-
- ui : Source of the User Interface (Command: build_ui.sh)
67-
- db : SQL files of the database
68-
- terraform : Terraform scripts (Command: plan.sh / apply.sh)
69-
- compute : Contains the deployment files to Compute
70-
- bin : with some helper commands
71-
- bin/ssh\_compute.sh (to ssh to the Compute)
72-
- bin/ssh\_bastion.sh (to ssh to the Bastion)
73-
3. Edit the env.sh file:
59+
60+
| | | | Description |
61+
| ----------- | ---------- | --------- | ---|
62+
| Commands | | | |
63+
| | starter.sh | | Build or destroy a project. Show a menu with commands if not argument is given |
64+
| | env.sh | | Settings of your project |
65+
| Directories | | | Commands used by starter.sh |
66+
| | bin/ | | Commands used by starter.sh |
67+
| | src/ | | Sources files |
68+
| | | app | Backend Application (Command: build_app.sh) |
69+
| | | ui | User Interface (Command: build_ui.sh) |
70+
| | | db | Database initialisation files (SQL, ...) |
71+
| | | terraform | Terraform scripts |
72+
| | target/ | | Output directory |
73+
74+
3. (Optional) Edit the env.sh file:
7475
- Choose the env.sh file.
7576
- Look for \_\_TO_FILL\_\_ in the file
7677
- You may leave it like this.
@@ -79,7 +80,7 @@ Please read the chapter: Introduction and Get Started.
7980
- If not, the script will create a "oci-starter" compartment
8081
![Editor env.sh](images/starter-kubernetes-env.png)
8182
82-
## Task 3: Build.sh
83+
## Task 3: Starter.sh
8384
8485
During the build, Terraform will create:
8586
- Network resources: VCN, Subnet
@@ -92,11 +93,12 @@ During the build, Terraform will create:
9293
- then run:
9394
```
9495
<copy>
95-
./build.sh
96+
./starter.sh
9697
</copy>
9798
```
98-
99-
It will build all and at the end you will see:
99+
- Choose **Build**
100+
![Result](../compute/images/starter-starter-build.png)
101+
- It will build all and at the end you will see:
100102
```
101103
<copy>
102104
- User Interface : https://xxxx.apigateway.eu-xxxx.oci.customer-oci.com/starter/
@@ -122,7 +124,7 @@ Please also check the "Lab 6 - How to Customize" to see how to customize this s
122124
1. To clean up, run
123125
```
124126
<copy>
125-
./destroy.sh
127+
./starter.sh destroy
126128
</copy>
127129
```
128130
@@ -137,4 +139,4 @@ Please also check the "Lab 6 - How to Customize" to see how to customize this s
137139
138140
* Author - Marc Gueury
139141
* Contributors - Ewan Slater
140-
* Last Updated - Nov, 2th 2023
142+
* Last Updated - Jan, 20th 2025

oci-starter-lab/customize/customize.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Let's say that we deploy a Java / SpringBoot on a Compute with an Database.
2222
unzip starter.zip
2323
cd starter
2424
cat README.md
25-
# ./build.sh
25+
# ./starter.sh build
2626
</copy>
2727
````
28-
2. When you run the build.sh script, the program will:
28+
2. When you run the **./starter.sh build** script, the program will:
2929
1. Create resources (compute/database/....) with "Terraform" (src/terraform)
3030
2. Create tables in the database (src/db)
3131
3. Compile the "Backend Application (app)" (src/app)
@@ -58,15 +58,10 @@ In the next task, we will go inside each directory to see what it contains.
5858
````
5959
````
6060
<copy>
61-
apply.sh atp.tf bastion.tf compute.tf datasource.tf destroy.sh network.tf output.tf plan.sh terraform_local.tf variable.tf
61+
atp.tf bastion.tf compute.tf datasource.tf network.tf output.tf terraform_local.tf variable.tf
6262
</copy>
6363
````
64-
2. We see 2 type of files:
65-
1. *.sh : scripts to run terraform (normal or resource manager):
66-
- plan.sh: test the terraform resources to see if apply will work. But it does nothing.
67-
- apply.sh: create the terraform resources
68-
- destroy.sh: destroy the terrraform resources
69-
2. *.tf : terraform files to create resources
64+
2. We see *.tf files. They are terraform files to create resources
7065
- compute.tf : create the compute
7166
- atp.tf: create an autonomous database
7267
- network.tf: create the network (VCN, subnets, security list)
@@ -123,7 +118,7 @@ In the next task, we will go inside each directory to see what it contains.
123118
3. You may customize all these files to your needs. For example, to use your own SpringBoot Application.
124119
- overwrite the pom.xml and src directory with your files.
125120
- change the start.sh
126-
- and rerun $STARTER_HOME/build.sh
121+
- and rerun $STARTER_HOME/starter.sh build
127122
128123
## Task 5 - Check User Interface Directory: src/ui
129124
@@ -148,10 +143,10 @@ In the next task, we will go inside each directory to see what it contains.
148143
- directory ui: containing static HTML files
149144
3. You may customize all these files to your needs. For example, to use your own HTML files
150145
- overwrite the HTML files in the ui directory with your files.
151-
- Then rerun $STARTER_HOME/build.sh to update the server
146+
- Then rerun $STARTER_HOME/starter.sh build to update the server
152147
153148
## Acknowledgements
154149
155150
* Author - Marc Gueury
156151
* Contributors - Ewan Slater
157-
* Last Updated - Nov, 2th 2023
152+
* Last Updated - Jan, 20th 2025

0 commit comments

Comments
 (0)