Difficulty: beginner
Estimated Time: 15 minutes

In this scenario you will create a compute instance using the OCI CLI. This compute instance will host an NGINX web server. The compute instance will live in the compartment that we are using in all our scenarios: lab-compartment. The compute instance will live in the region you decide it, and will use a VM with shape VM.Standard2.1.

This scenario will help you to understand:

  • How to create a compute instance using the OCI CLI
  • How to automate the installation of components within the compute instance

Important notes to use this scenario:

  • If you are following to learn how to create an OCI compute instance using the OCI CLI, then this is also useful for you. The result of following it will be an NGINX installed with a welcome index page.
  • Depending on your region you will use a different image id. Every region has a different OCID for the image id, and therefore you need to set it accordingly. We will provide you the OCID for your region in step 1

At the end of the scenario you will get something like this:



This complets the scenario for OCI compute instance creation. This scenario also helped us to create a proxy server for our OKE API Server.

OCI Compute Instance Creation

Step 1 of 3

Step 1 - Prepare the environment with OCI CLI

Wait for OCI CLI (and Fn CLI) to be installed

You need to provide details on the OCI tenancy you will work in and the OCI user you will work as. Please edit these two files:

  • ~/.oci/config
  • ~/.oci/oci_api_key.pem

Paste the contents provided by the workshop instructor into these two files.

Do not continue until you see the file /root/allSetInBackground appear. If it appears, then the OCI CLI has been installed and you can continue.

Set the environment variable LAB_ID to the number provided to you by the workshop instructor.

export LAB_ID=1

Try out the following command to get a list of all namespaces you currently have access to - based on the OCI Configuration defined above.

oci os ns get

If you get a proper response, the OCI is configured correctly and you can proceed. If you run into an error, ask for help from your instructor.

Note: the assumption here is a compartment called lab-compartment. In that compartment we will create our compute instance and we will use ASHBURN-AD-1 for the region (you can use your own region, just set the value in variable REGION in the following steps).
We will use shape VM.Standard2 for our compute instance. If you are interested on which other shapes exist, please take a look at here.

The name of our compute instance is going to be nginxLAB+LAB_ID (e.g. ngninxLAB1).

When creating your keys, please use the path /root/keys/lab.

Now let's prepare some environment variables:

export CS=$(oci iam compartment list)
export COMPARTMENT_OCID=$(echo $CS | jq -r --arg display_name "lab-compartment" '.data | map(select(."name" == $display_name)) | .[0] | .id')
export VCNS=$(oci network vcn list -c $COMPARTMENT_OCID)
export VCNID=$(echo $VCNS | jq -r --arg display_name "vcn-lab" '.data | map(select(."display-name" == $display_name)) | .[0] | .id')
export SUBNETS=$(oci network subnet list  -c $COMPARTMENT_OCID --vcn-id $VCNID)
export SUBNETID=$(echo $SUBNETS | jq -r --arg display_name "Public Subnet-vcn-lab" '.data | map(select(."display-name" == $display_name)) | .[0] | .id')
export NSS=$(oci os ns get)
export NAMESPACE=$(echo $NSS | jq -r '.data')
export REGION=us-ashburn-1
export ADOMAINS=$(oci iam availability-domain list --compartment-id $COMPARTMENT_OCID)
export AVAILABILITY_DOM=$(echo $ADOMAINS | jq -r '.data | .[0] | .name')
export IMG_ID=ocid1.image.oc1.iad.aaaaaaaavzjw65d6pngbghgrujb76r7zgh2s64bdl4afombrdocn4wdfrwdq
export SHAPE=VM.Standard2.1
export KEY_PUB=/root/keys/lab.pub
export CONFIG=/root/computeInstanceConfig.txt

echo "Compartment OCID: $COMPARTMENT_OCID"
echo "Namespace: $NAMESPACE"

Now please set the Region environment variable using this command:

export REGION=$(oci iam region-subscription list | jq -r '.data[0]."region-name"')
export REGION_KEY_UPPER=$(oci iam region-subscription list | jq -r '.data[0]."region-key"')
export REGION_KEY=$(echo $REGION_KEY_UPPER | tr '[:upper:]' '[:lower:]')

echo "My region is: $REGION"

If your region is not us-ashburn-1, you need to set the image id to point to the one of your region. Look into the next table, and find your region:

ap-melbourne-1 ocid1.image.oc1.ap-melbourne-1.aaaaaaaavpiybmiqoxcohpiih2gasjgqpsiyz4ggylyhhitmrmf3j2ycucrq
ap-mumbai-1 ocid1.image.oc1.ap-mumbai-1.aaaaaaaarrsp6bazleeeghz6jcifatswozlqkoffzwxzbt2ilj2f65ngqi6a
ap-osaka-1 ocid1.image.oc1.ap-osaka-1.aaaaaaaafa5rhs2n3dyuncddh5oynk6gisvotvcvch3e6xwplji7phwtbqqa
ap-seoul-1 ocid1.image.oc1.ap-seoul-1.aaaaaaaadrnhec6655uedkshgcklewzikoqcwr65sevbu27z7vzagniihfha
ap-sydney-1 ocid1.image.oc1.ap-sydney-1.aaaaaaaaplq4fjdnoooudaqwgzaidh6r3lp3xdhqulx454jivy33t53hokga
ap-tokyo-1 ocid1.image.oc1.ap-tokyo-1.aaaaaaaa5mpgmnwqwacey5gvczawugmo3ldgrjqnleckmnsokrqytcfkzspa
ca-montreal-1 ocid1.image.oc1.ca-montreal-1.aaaaaaaaevu23evecil3r23q5illjliinkpyvtkbdq5nsxmcfqypvlewytra
ca-toronto-1 ocid1.image.oc1.ca-toronto-1.aaaaaaaai25l5mqlzvhjzxvb5n4ullqu333bmalyyg3ki53vt24yn6ld7pra
eu-amsterdam-1 ocid1.image.oc1.eu-amsterdam-1.aaaaaaaayd4knq4bdh23zqgatgjhoajiz3mx4fy3oy62e5f45ll7trwak5ga
eu-frankfurt-1 ocid1.image.oc1.eu-frankfurt-1.aaaaaaaa4cmgko5la45jui5cuju7byv6dgnfnjbxhwqxaei3q4zjwlliptuq
eu-zurich-1 ocid1.image.oc1.eu-zurich-1.aaaaaaaa4nwf5h6nl3u5cdauemg352itja6izecs7ol73z6jftsg4agpdsma
me-jeddah-1 ocid1.image.oc1.me-jeddah-1.aaaaaaaazrvioeng7va7w4qsuqny4jtxbvnxlf5hu7g2twn6rcwdu35u4riq
sa-saopaulo-1 ocid1.image.oc1.sa-saopaulo-1.aaaaaaaalfracz4kuew4yxvgydpnbitip6qsreaz7kpxlkr4p67ravvi4jnq
uk-gov-london-1 ocid1.image.oc4.uk-gov-london-1.aaaaaaaaslh4pip7u6iopbpxujy2twi7diqrs6kfvqfhkl27esdadkqa76mq
uk-london-1 ocid1.image.oc1.uk-london-1.aaaaaaaa2uwbd457cd2gtviihmxw7cqfmqcug4ahdg7ivgyzla25pgrn6soa
us-ashburn-1 ocid1.image.oc1.iad.aaaaaaaavzjw65d6pngbghgrujb76r7zgh2s64bdl4afombrdocn4wdfrwdq
us-gov-ashburn-1 ocid1.image.oc3.us-gov-ashburn-1.aaaaaaaa7wmye6amfr23dztsa3vmxhkl5nsbb2aanxp2vbrimaar63r4rpvq
us-gov-chicago-1 ocid1.image.oc3.us-gov-chicago-1.aaaaaaaarvaddol5drkpwuyh4nq5zb5xyninkg7fo2i62lc3p4nqcvg75qeq
us-gov-phoenix-1 ocid1.image.oc3.us-gov-phoenix-1.aaaaaaaacjspozvgtaoxd2ajkrivlumfzozuj62geia43lh4luddcfrgprpq
us-langley-1 ocid1.image.oc2.us-langley-1.aaaaaaaauckkms7acrl6to3cuhmv6hfjqwlnoxzuzophaose7pi2sfk4dzna
us-luke-1 ocid1.image.oc2.us-luke-1.aaaaaaaadxeycutztmvaeefvilc57lfqool2rlgl2r34juyu4jkbodx2xspq
us-phoenix-1 ocid1.image.oc1.phx.aaaaaaaacy7j7ce45uckgt7nbahtsatih4brlsa2epp5nzgheccamdsea2yq
ap-hyderabad-1 ocid1.image.oc1.ap-hyderabad-1.aaaaaaaaq5m4tcqcean4n7vkwxk6ssizepq5xuqr4dqtqap7gxzchd6vz3fq

Now set the following variable (only if you are not in us-ashburn-1), to point to your region OCID image id (copy it from the previous table). For example, if you are in uk-london-1:

export IMG_ID=ocid1.image.oc1.uk-london-1.aaaaaaaa2uwbd457cd2gtviihmxw7cqfmqcug4ahdg7ivgyzla25pgrn6soa

echo "My image id is: $IMG_ID"

Create Public and Private Key

For generating the public and private key that will be used to ssh to the compute instance, execute (remember to use /root/keys/lab):

ssh-keygen -t rsa

This will prompt you for the location where the keys will be stored. Enter /root/keys/lab

After that you will be prompted for a passphrase, you can leave it blank if you do not want to set one.

A similar output like the following one, will appear:

Generating public/private rsa key pair.
Enter file in which to save the key (/root/keys):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in id_rsa.
Your public key has been saved in id_rsa.pub.
The key fingerprint is:

Create an Ingress Rule to open port 80 in your VCN

Now let's update the Security List (Default Security List for vcn-lab) with the ingress rule that will allow TCP traffic through port 80 to the compute instance that we are about to create.

export securitylist=$(oci network security-list list --compartment-id $COMPARTMENT_OCID --vcn-id $VCNID)
export seclistID=$(echo $securitylist | jq -r --arg name "Default Security List for vcn-lab" '.data | map(select(.["display-name"] == $name)) | .[0] | .id')
oci network security-list get --security-list-id $seclistID > seclist.json
jq --argjson ingressRule '{"source": "", "protocol": "6", "isStateless": false, "tcpOptions": {"destinationPortRange": {"max": 80, "min": 80}, "sourcePortRange": null}}' '.data."ingress-security-rules" += [$ingressRule]' seclist.json > seclistupdated.json
export ingress_rules=$(cat seclistupdated.json)
export INGRESS_RULES_UPDATED=$(echo $ingress_rules | jq -r '.data | .["ingress-security-rules"]')
oci network security-list update --security-list-id $seclistID --ingress-security-rules "$INGRESS_RULES_UPDATED"

You will be prompted if you want to continue, choose yes.

(Note. In the previous execution block, we first got the Securit List ID seclistID and then got the detail of it seclist.json. Then we added the rule and created a new json file -seclistupdated.json-. Then we got the ingress security rules element and with that updated the security list).

This is what we added to the Security List:

      "source": "",
      "protocol": "6",
      "isStateless": false,
      "tcpOptions": {
         "destinationPortRange": {
            "max": 80,
            "min": 80
         "sourcePortRange": null

In the Web Console you will see this:

Ingress Rule

Now you have everything you need to create your compute instance within your lab-compartment. Let's go to the next step.