CD3 stands for Cloud Deployment Design Deliverable.
The CD3 Automation toolkit has been developed to help in automating the OCI resource object management.
It reads input data in the form of CD3 Excel sheets and generates the terraform files instead of handling the task through the OCI console manually. The toolkit also reverse engineers the components in OCI back to the Excel sheet and Terraform configuration. This generated Terraform code can be used by the OCI Resource Manager or leveraged by the organisations’ CI/CD processes.
To ease the execution of toolkit, we have provided the steps to build an image which encloses the code base and its package dependencies. Follow the steps provided below to clone the repo and build the image.
- Git
- Any docker cli compatible platform such as Docker or Rancher.
- OCI Tenancy Access Requirement - Appropriate IAM policies must be in place for each of the resources that the user may try to create. Minimum requirement for the user to get started is to have the ability to read to the tenancy.
- Open your terminal and change the directory to the one where you want to download the git repo.
- Run the git clone command as shown below: git clone https://github.com/oracle-devrel/cd3-automation-toolkit
- Once the cloning command completes successfully, the repo will replicate to the local directory.
- Change directory to cd3-automation-toolkit(i.e. the cloned repo in your local).
- Run docker build --platform linux/amd64 -t cd3toolkit:${image_tag} -f Dockerfile --pull --no-cache .
Note : ${image_tag} should be replaced with suitable tag as per your requirements/standards.
- Run docker save cd3toolkit:${image_tag} | gzip > cd3toolkit_${image_tag}.tar.gz
- Run docker run --platform linux/amd64 -it -d -v <path_in_local_system_where_the_files_must_be_generated>:/cd3user/tenancies <image_name>:<image_tag>
- Run docker ps
- Run docker exec -it <container_id> bash
Follow the toolkit docs i.e. from the section "Configuring the Docker Container to connect to OCI Tenancy" in CD3 Automation Tookit - End To End Process Documentation. Please download the document from Github.
CD3 Quick Start template can be found at CD3 CIS Template
CD3 Sample Excel templates can be found at Excel Templates
Note : The above steps have been tested on Windows (Git Bash) and MacOS.
This project is open source. Please submit your contributions by raising an Issue or through Discussion topic in this repository. Currently, we do not accept any pull requests. Oracle appreciates any contributions that are made by the open source community.
Copyright (c) 2022 Oracle and/or its affiliates.
Licensed under the Universal Permissive License (UPL), Version 1.0.
See LICENSE for more details.
ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK.