Goal

- Create Focused, Simplified and Brief Step-by-Step Guide for installing OKIT OCI Designer, the tool that every OCI Solution Architect needs.

 

Prerequisites

- Account on Oracle Cloud Infrastructure

- git installed

- DockerDesktop CE installed

- OCI-CLI installed

- OCI-CLI configured with required credentials for working with OCI account

 

Steps:

 

(1) Write the following command to generate a key pair to include in the config file.

oci setup keys

You will get result like this

Enter a passphrase for your private key (empty for no passphrase): 
Public key written to: /Users/mahmoudrabie/.oci/oci_api_key_public.pem
Private key written to: /Users/mahmoudrabie/.oci/oci_api_key.pem
Public key fingerprint: YOUR_GENERATED_PUBLIC_KEY_FINGERPRINT_HERE

 

(2) Get the content of oci_api_key_public.pem

cat /Users/mahmoudrabie/.oci/oci_api_key_public.pem

and copy the result

-----BEGIN PUBLIC KEY-----
.....
.......
.........
-----END PUBLIC KEY-----

 

(3) In OCI console, go to Identity --> Users --> User Details --> API keys

paste the PUBLIC KEY (must be in pem format)

 

(4) Create the configuration file

touch ~/.oci/config

and fill it by this information like the following example configuration

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys/admin_key.pem
pass_phrase=<your_passphrase>

 

(5) Adjust the config file permissions

oci setup repair-file-permissions --file ~/.oci/config

 

(6) Now, you could run your your OCI commands

 

(7) Clone the OCI Designer Toolkit github repo

git clone -b v0.7.0 --depth 1 https://github.com/oracle/oci-designer-toolkit.git

 

(8) Docker compose

cd oci-designer-toolkit/containers/docker
docker-compose up

 

(9) Build Docker Image

cd oci-designer-toolkit
docker build --tag okit --file ./containers/docker/Dockerfile --force-rm .

 

(10) Start Docker Image

cd oci-designer-toolkit
docker run -d --rm -p 443:443 -p 80:80 --name okit --hostname okit okit

 

(11) Now, you could access the designer from the browser

http://localhost/okit/designer

 

Enjoy!

 

My Twitter Account

My Instagram Account