Oracle Visual Builder Studio (VB Studio) is a robust application development platform that helps your team effectively plan and manage your work throughout all stages of the app dev lifecycle: design, build, test, and deploy. By integrating the terraform scripts in the VB Studio, we can automate the OCI resource provisioning.
In the current usecase, we will explore how we can use Oracle VB Studio and terraform scripts to achieve the following.
- Provision the VB Studio and acquire the access
- Setup a VBS Project
- Setup a GIT repository with required terraform files in the VBS project
- Define a build job to run the terraform script files from GIT repo to provision the OCI resources
- Run the VBS build to verify the automated OCI resource provisioning
- Ensure that you have access to VB Studio instance
- Login to the VB Studio to access the home page
-
From the Organization tab in the home page, click on Create
-
Enter the project name and description and click Next
-
In the Template selection page, select Initial Respository and click Next
-
Select Import Existing repository and enter the Importing repository URL as https://github.com/subhashchandrab/oci-vbs-terraform.git. Leave the other fields with default values and click Finish
-
Wait for the project provisioning to be completed. Once done, you can see the project home page.
-
Login to OCI console and select User Settings option from the Profile menu.
-
Navigate to API Keys and click on Add API Key button.
-
In the Add API Key dialog, keep the default option(Generate API Key Pair). Download both the private and public key files using the respective buttons available in the dialog. Now click on Add. Make sure that you download the public and private keys before clicking the Add button
-
Save the above private and public key in a location where you can refer them later when adding key files to GIT repository in the next section
-
After the API Key is added, select View Configuration File option from the action menu of the created API key
-
Make a note of the entries user, fingerprint, tenancy and region. You need these values in the next section.
- Go to VBS project home page and navigate to GIT page
- Select the folder oci-keys and click on +File button.
- Enter oci_api_key_private.pem in the file name field. Paste the content from the private key file downloaded in the previous section. Click on Commit. In the Commit dialog, click Commit again. The private key file oci_api_key_private.pem will be added to the GIT repository of the VBS project.
- Perform the same step and create a new file oci_api_key_pub.pem under the directory oci-keys with the content of public key file downloaded in the previous section.
- Navigate to terraform folder in the GIT repository and select env_vars file. Click on Edit File and update the values using the values copied in previous section and click on Commit
- Go to VBS home and navigate to Organization page. Select Build Executor Templates and click on Create Template.
- In the dialog for New Build Executor Template, enter the name as Terraform Build and any description. Select Platform as Oracle Linux 7 and click Create
- Select the created template Terraform Build and click on Configure Software. Search for terraform and select it so that it gets added to the selected software. Click Done.
- Select the tab VM Build Executors. Click on Create VM. Select the previously selected Build Executor Template Terraform Build. Make sure the region selected is the same region where the VBS instance is running. Select one of the available shapes. Leave the VCN selection to default and click Add.
- Select the created VM build executor Terraform Build and click on Start from the action menu and wait for the status to show as Ready
- Go to VBS Project Home and select Builds. Click on Create Job
- Enter the name and description and select the previously created template from the dropdown. Click on Create.
- Go to the job details page and click on Configure.
- In the Git tab of Job Configuration page, click on Add Git. Select vbs-terraform-integration.git from the Repository dropdown.
- Go to Steps tab and click on Add Step - > Common Build Tools -> Unix Shell
- Copy the contents of /build/run_terraform.sh from VBS Git repository into the Unix Shell Script. Click on Save.
- From the Build Job Details page, click on Build Now. Wait for the build to be completed. In case of any errors, verify the steps in previous section to ensure that all the configurations related to OCI authentication are added properly.
- After the build is succesful, click on View Build Log from the Actions against the last build. Scroll to the end of the build to locate the public IP address of the compute instance created through terraform. The log looks as shown below.
[2021-09-28 11:41:56] �[0mhttpd_url = "http://130.61.131.111/"
[2021-09-28 11:41:56] instance_public_ip = "130.61.131.111"
[2021-09-28 11:41:56] END shell script execution
- Go to the browser and enter the URL http://compute_instance_public_ip(Public IP can be retrieved from the log). You should see Apache httpd server home page as the terraform script installs the httpd server on the compute instance.
- Also, you can go to the OCI console to verify the compartment, VCN, Internet Gateway, public subnet and compute instances created through terraform using VBS build job.
We verified how we can add terraform scripts to provision the OCI resources can be added to the GIT repository of VBS projects to automate the OCI resource provisioning using the build jobs.