Skip to content

One-Click Deployment

This method automatically provisions a Linux compute VM in your OCI tenancy and configures the CD3 container using Podman on the instance.

⚙️ Prerequisites

  • The user deploying the stack should have access to provision OCI Resource Manager stack, compute instance and network resources.

Sample Policies

Allow group <group_name> to manage orm-stacks in compartment <compartment_name>
Allow group <group_name> to manage orm-jobs in compartment <compartment_name>
Allow group <group_name> to manage instance-family in compartment <compartment_name>
Allow group <group_name> to manage virtual-network-family in compartment <compartment_name>


🛠️ Steps:

  • Click on the below button to directly navigate to Resource Manager stack in the OCI Tenancy, and fill in required details to launch CD3 Work VM and Container.

    Deploy_To_OCI

Alternate way to deploy the stack if above button does not work (eg for Gov tenancies)
1. Clone the repo using 'Download the Zip' link as highlighted below:
CD3 Container

2. Login to OCI Console and navigate to 'Developer Services' -> 'Stacks' under 'Resource Manager' and click on 'Create Stack'. Choose .zip file and select the downloaded zip file as shown below:
CD3 Container

  • This action initiates login to OCI, provisions the Work VM in the tenancy, and configures the Automation Toolkit within a Podman container on the VM.

  • Enter the required details in the Resource Manager stack and click on create.

Security Warning

To maintain a secure environment, provide a specific source CIDR range to access the VM. Do not use 0.0.0.0/0.

Connectivity requirements for existing VCNs

In case an existing network is chosen to launch the Work VM, it needs to have outbound internet connectivity.
See URLs that need to be whitelisted for outbound connectivity.

  • After the Apply job is successful, click on it and scroll down to the end of logs and find the details for the created VM, and commands to be executed to login to the toolkit container.


Default Security Settings

The VM launched using RM stack will have v1 IMDS endpoints disabled, PV encryption and the bastion plugin enabled.

  • Login to the VM using private key corresponding to the public key provided during stack creation. Use cd3user or opc user to connect to the VM. Same key has been copied for both the users.

  • Follow Steps to transfer the CD3 Excel file to and from the container while executing the toolkit.

  • Verify if container is launched using below command. If this command does not return any running container, wait for the stack to finish processing. The progress logs are available at /cd3user/mount_path/installToolkit.log

sudo podman ps -a

📂 Shared Directory: VM ↔ Container

The path /cd3user/mount_path/ on the VM is mapped to /cd3user/tenancies inside the container. This local path on VM can be used to transfer any files (Eg: Excel templates) to and from the container to the local laptop.

  • If above command shows a running CD3 container then exec into it using below command - 
sudo podman exec -it cd3_toolkit bash