Skip to content

Commit f96dd67

Browse files
ChrisJ60klazarz
andauthored
Changes and improvements following initial review. (#22)
* TimesTen: Initial population * Work in progress * Finalising workshop instructions etc. * QA fixes #1 * QA fixes #2 * Typo and grammar corrections * URL fixup, additional minor tweaks. * Minor updates and fixes. * Improve connection instructions. * cleanup migration cleanup migration * clean up after migration clean up after migration * Update to README file * Various improvements based on feedback. * URL corrections * Correcting e-mail address for 'help' Co-authored-by: Kevin Lazarz <kevin.lazarz@oracle.com>
1 parent 5dbeb18 commit f96dd67

File tree

18 files changed

+786
-421
lines changed

18 files changed

+786
-421
lines changed

timesten/cache-introduction/01-introduction/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Estimated Workshop Time: **60 minutes**
1010

1111
### About Oracle TimesTen In-Memory Database
1212

13-
Oracle TimesTen In-Memory Database (TimesTen) delivers real time application performance (low response time and high throughput) by changing the assumptions around where data resides at runtime. By managing data in memory, and optimizing data structures and access algorithms accordingly, database operations execute with maximum efficiency achieving dramatic gains in responsiveness and throughput.
13+
Oracle TimesTen In-Memory Database (TimesTen) delivers real-time application performance (low response time and high throughput) by changing the assumptions around where data resides at runtime. By managing data in memory, and optimizing data structures and access algorithms accordingly, database operations execute with maximum efficiency achieving dramatic gains in responsiveness and throughput.
1414

15-
TimesTen is a relational database, with SQL as its access language and PL/SQL as its procedural language, so you can leverage your existing Oracle Database skills. It supports a wide range of database APIs such as JDBC, ODBC, ODP.NET and Oracle Call Interface (OCI) and several Open Source languages, such as Python and Node.js, are supported via Open Source APIs. TimesTen provides full persistence and has built in high-availability.
15+
TimesTen is a relational database, with SQL as its access language and PL/SQL as its procedural language so that you can leverage your existing Oracle Database skills. It supports many database APIs such as JDBC, ODBC, ODP.NET and Oracle Call Interface (OCI) and several Open Source languages, such as Python and Node.js, are supported via Open Source APIs. TimesTen provides full persistence and has built-in high availability.
1616

17-
TimesTen can be deployed both as a database of record or as a high performance relational cache in front of an Oracle database to acceleratae Oracle database applications. This lab focuses on the cache deployment mode.
17+
TimesTen can be deployed both as a database of record or as a high-performance relational cache in front of an Oracle database to accelerate Oracle database applications. This lab focuses on the cache deployment mode.
1818

1919
![TimesTen Cache Architecture Diagram](./images/tt-cache-architecture.png " ")
2020

@@ -26,7 +26,7 @@ In this workshop you will:
2626
* Create a TimesTen instance
2727
* Execute some basic TimesTen commands
2828
* Prepare the Oracle database for TimesTen caching
29-
* Prepare a TimesTen datbase and set it up as a cache
29+
* Prepare a TimesTen database and set it up as a cache
3030
* Load data from the Oracle database into the cached tables and activate cache refresh
3131
* Verify cache refresh
3232
* Run a simple OLTP benchmark to see the performance benefit of TimesTen

timesten/cache-introduction/02-prepare-setup/prepare-setup.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
In this lab, you will download the Oracle Resource Manager (ORM) stack zip file needed to setup the resource needed to run this workshop. This workshop requires a compute instance and a Virtual Cloud Network (VCN) and subnet.
5+
In this lab, you will download the Oracle Resource Manager (ORM) stack zip file needed to set up the resources needed to run this workshop. This workshop requires a compute instance and a Virtual Cloud Network (VCN) and subnet.
66

77
Estimated Time: **15 minutes**
88

@@ -29,38 +29,46 @@ We strongly recommend using this stack to create a self-contained/dedicated VCN
2929

3030
## Task 2: Adding security rules to an existing VCN
3131

32-
This workshop requires a certain number of ports to be available, a requirement that can be met by using the default ORM stack execution that creates a dedicated VCN. In order to use an existing VCN/subnet the following ports should be added to the Ingress rules.
32+
This workshop requires a certain number of ports to be available, a requirement that can be met by using the default ORM stack execution that creates a dedicated VCN. In order to use an existing VCN/subnet, the following ports should be added to the Ingress rules.
3333

3434
| Port |Description |
3535
| :------------- | :------------------------------------ |
3636
| 22 | SSH |
37-
| 80 | Remote Desktiop using noVNC |
38-
| 6080 | Remote Desktop using noVNC |
37+
| 80 | Remote Desktop using noVNC |
38+
3939

4040
1. Go to *Networking >> Virtual Cloud Networks*
4141

4242
2. Choose your network
4343

4444
3. Under Resources, select *Security Lists*
4545

46-
4. Click on *Default Security Lists *under the Create Security List button
46+
4. Click on *Default Security Lists* under the Create Security List button
4747

48-
5. Click *Add Ingress Rule* button
48+
5. Click the *Add Ingress Rule* button
4949

5050
6. Enter the following:
5151
- Source CIDR: 0.0.0.0/0
52-
- Destination Port Range: *Refer to above table*
52+
- Destination Port Range: *Refer to the above table*
5353

5454
7. Click the Add Ingress Rules button
5555

5656
## Task 3: Setup your OCI compute instance
5757

58-
Using the details from the two steps above, proceed to the lab *Environment Setup* to setup your workshop environment using Oracle Resource Manager (ORM) using one of the following options:
58+
Using the details from the two steps above, proceed to the lab *Environment Setup* to set up your workshop environment using Oracle Resource Manager (ORM) using one of the following options:
5959

6060
- Create Stack: *Compute + Networking*
6161
- Create Stack: *Compute only* using an existing VCN where security lists have been updated as per *Task 2* above
6262

63-
**IMPORTANT:** When deploying the workshop compute instance via the ORM stack, it is strongly recommended that you enable the optional SSH access using either your own SSH public key or a generated SSH key pair. SSH connectivity offers a better user experience, especially for copy/paste, than noVNC connectivity.
63+
**IMPORTANT**
64+
65+
When deploying the workshop compute instance via the ORM stack, as described in the next lab:
66+
67+
1. By default SSH access using a system generated SSH private key is enabled. SSH access is recommended for this workshop as it offers a better user experience, especially for copy/paste, than noVNC connectivity.
68+
69+
2. If you wish to provide your own SSH public key, uncheck the option *Auto Generate SSH Key Pair* and follow the on-screen instructions to either upload or copy/paste your SSH public key.
70+
71+
3. Unless you wish to customize SSH connectivity as desccribed in (2), you can accept all the defaults provided by the ORM stack.
6472

6573
You may now *proceed to the next lab (Environment setup)*.
6674

timesten/cache-introduction/03-connect-to-instance/connect-to-instance.md

Lines changed: 44 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Introduction
44

5-
In this lab you will learn the different ways to connect to the OCI compute instance that hosts the workshop.
5+
In this lab, you will learn the different ways to connect to the OCI compute instance that hosts the workshop.
66

77
The workshop requires you to use a terminal session to run various commands and observe their output. Often you may need to copy and paste commands or text from the workshop instructions into the terminal session.
88

9-
If you chose to run the workshop in the LiveLabs sandbox then the only connection method available to you by default is a GUI session using the browser based VNC mechanism. It is possible to setup SSH connectivity by adding your own SSH key into the instance (follow the instructions provided in the noVNC lab).
9+
If you chose to run the workshop in the LiveLabs sandbox then the only connection method available to you by default is a GUI session using the browser-based VNC mechanism. It is possible to set up SSH connectivity by adding your own SSH key into the instance (follow the instructions provided in the noVNC lab).
1010

11-
If you chose to run the workshop in your own tenancy, or in a free-trial Cloud account, then you can use the same browser based GUI connection method. Also, if you selected the option during deploymemnt via the ORM stack, you also have the option to use SSH connectivity (**strongly recommended)**.
11+
If you chose to run the workshop in your own tenancy, or in a free-trial Cloud account, then you can use the same browser-based GUI connection method. Also, if you selected the option during deployment via the ORM stack, you also have the option to use SSH connectivity (**strongly recommended)**.
1212

1313
Estimated Time: **5 minutes**
1414

@@ -23,46 +23,74 @@ This lab assumes that you have:
2323

2424
- Completed all the previous labs in this workshop, in sequence.
2525

26-
## Task 1: Connect using noVNC
26+
## Task 1: Connect using noVNC remote desktop
27+
28+
All environments support browser based noVNC connections. The lab *Using noVNC Remote Desktop* provides information on using the noVNC remote desktop.
2729

2830
_LiveLabs sandbox_
2931

30-
In the LiveLabs reservation page for your active reservation you will see the URL to use for a noVNC connection to the workshop instance.
32+
In the LiveLabs reservation page for your active reservation, you will see the URL to use for a noVNC connection to the workshop instance.
3133

3234
_Own tenancy or free-trial Cloud account_
3335

34-
At the end of the ORM stack apply job execution report you will see the noVNC connection URL.
36+
At the end of the ORM stack 'apply' job execution log you will see the noVNC connection URL.
37+
38+
```
39+
remote_desktop = [
40+
"http://140.238.65.52/livelabs/vnc.html?password=yO56MG6tnJ&resize=scale&quality=9&autoconnect=true&reconnect=true",
41+
]
42+
```
43+
The noVNC connection URL can also be viewed and copied on the Stack's Application Information tab:
3544

36-
Copy / paste the URL into your browser and you should then see the workshop desktop.
45+
![Workshp noVNC connection URL](./images/orm-novnc-url.png " ")
46+
47+
Copy/paste the URL from the log into your browser and you should then see the workshop desktop.
3748

3849
![Workshp noVNC Desktop](./images/novnc-desktop.png " ")
3950

40-
You can use the *Activities* menu, or double click the *Terminal* icon on the desktop to open a terminal session.
51+
You can use the **Terminal** option under the *Activities* menu, or double-click the *Terminal* icon on the desktop, to open a terminal session.
4152

4253
## Task 2: Connect using SSH (optional but recommended)
4354

4455
You can connect to the instance as the oracle user using an SSH private key.
4556

4657
_LiveLabs sandbox_
4758

48-
You can follow the instructions in the noVNC lab to add an SSH poublic key to the oracle user's SSH **authorized_keys** file. You then connect using the corresponding SSH private key.
59+
Follow the instructions in the lab *Using noVNC Remote Desktop* to add your SSH public key to the **oracle** user's SSH **authorized_keys** file. You can then connect to the workshop compute instance using the corresponding SSH private key.
4960

50-
_Own tenancy or free-trial Cloud account - user provided public key_
61+
_Own tenancy or free-trial Cloud account - user-provided public key_
5162

52-
If you provided your own SSH public key as part of the ORM stack deployment process then you can connect using the corresponding SSH private key.
63+
If you enabled SSH connectivity by providing your own SSH public key as part of the ORM stack deployment process then you can connect using the corresponding SSH private key.
5364

54-
_Own tenancy or free-trial Cloud account - system generated key pair_
65+
_Own tenancy or free-trial Cloud account - system-generated key pair_
5566

56-
The SSH private key needed to connect is displayed at the end of the ORM stack apply job log. Copy/paste the key into a file on your client computer, or import into into your SSH client, and use that file to connect.
67+
If you enabled SSH connectivity using a system generated key as part of the ORM stack deployment process, the SSH private key needed to connect is displayed at the end of the ORM stack 'apply' job execution log.
68+
69+
```
70+
generated_instance_ssh_private_key = -----BEGIN RSA PRIVATE KEY-----
71+
MIIEpAIBAAKCAQEAu8ta42Xs+O/JvkDfpjWo4c2uqb9xkR2IncidGFE1FO4GlMm6
72+
...
73+
2o0ssyrFUAo93fbkfdNfqojnnVJaMjGrpwaTS80Y7tbIrreex2R+9g==
74+
-----END RSA PRIVATE KEY-----
75+
```
76+
77+
The generated SSH private key can also be viewed and copied on the Stack's Application Information tab:
78+
79+
![Workshp SSH private key](./images/orm-ssh-key.png " ")
80+
81+
Copy/paste the key into a file on your client computer, or import into your SSH client, and use it to connect via SSH.
5782

5883
**NOTE:** On Linux and macOS systems, SSH private keys should be stored in your user's .ssh directory (**~/.ssh**) and must have permissions of **600 (rw-------)**.
5984

60-
Assuming that the SSH private key is **~/.ssh/id_livelabs** and the oublic IP address of the workshop compiute instance is **123.123.123.123** then you can connect using:
85+
Assuming that the SSH private key is **~/.ssh/id_livelabs** and the public IP address of the workshop compute instance is **123.123.123.123** then you can connect using:
6186

62-
**ssh -i ~/.ssh/id_livelabs oracle@123.123.123.123**
87+
```
88+
<copy>
89+
ssh -i ~/.ssh/id_livelabs oracle@123.123.123.123
90+
</copy>
91+
```
6392

6493
```
65-
$ ssh -i ~/.ssh/id_livelabs oracle@123.123.123.123 11:55:17
6694
The authenticity of host '123.123.123.123 (123.123.123.123)' can't be established.
6795
ED25519 key fingerprint is SHA256:bm2wv3HgyBIhIRov6+EtId10rQHyq1LXpXglQMpqhqA.
6896
This key is not known by any other names
760 KB
Loading
761 KB
Loading

timesten/cache-introduction/04-initialize-environment/initialize-environment.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
In this lab you will start up all the components required to run the labs making up this workshop.
5+
In this lab, you will start up all the components required to run the labs making up this workshop.
66

77
The workshop uses an Oracle database which runs in its own container (**dbhost**). A second container (**tthost1**) provides the TimesTen environment. These containers, and the host system (**ttlivelabvm**), are all connected using a custom Docker network. This setup provides a realistic multi-host environment with the convenience of just a single compute instance.
88

@@ -20,7 +20,7 @@ This lab assumes that you have:
2020

2121
### Starting over from the beginning
2222

23-
Once you have successfully completed this lab, if at any point you want to start the whole workshop again from the beginning, just go the the **~/lab** directory and run the script **labReset.sh**. That script will take 5-8 minutes to run and it will reset everything back to the way it was after this lab completed.
23+
Once you have successfully completed this lab, if at any point you want to start the whole workshop again from the beginning, just go to the **~/lab** directory and run the script **labReset.sh**. That script will take 5-8 minutes to run and it will reset everything back to the way it will be after this lab is completed.
2424

2525
## Task 1: Connect to the environment
2626

@@ -30,16 +30,21 @@ Connect to the OCI compute instance and open a terminal session, as the user **o
3030

3131
Change to the **lab** directory:
3232

33-
**cd ~/lab**
34-
35-
`[oracle@ttlivelabvm ~] cd ~/lab`
33+
```
34+
<copy>
35+
cd ~/lab
36+
</copy>
37+
```
3638

3739
Initialize the workshop:
3840

39-
**labSetup.sh cache-intro**
41+
```
42+
<copy>
43+
labSetup.sh cache-intro
44+
</copy>
45+
```
4046

4147
```
42-
[oracle@ttlivelabvm ~] labSetup.sh cache-intro
4348
info: setting up workshop 'cache-intro', this will take several minutes...
4449
info: starting hosts: OK
4550
info: host initialization: OK
@@ -48,7 +53,7 @@ info: Oracle Database state successfully reset
4853
info: starting Oracle Database: OK
4954
```
5055

51-
This command will take between 5 and 8 minutes to complete. Once the setup has completed successfully, *proceed to the next lab*. You can keep your terminal session open ready for the next lab.
56+
This command will take between 5 and 8 minutes to complete. Once the setup script has completed successfully, *proceed to the next lab*. You can keep your terminal session open ready for the next lab.
5257

5358
## Acknowledgements
5459

0 commit comments

Comments
 (0)