Giter Club home page Giter Club logo

cd3-automation-toolkit's Introduction

cd3-automation-toolkit

License: UPL Quality gate

Introduction

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.

Screenshot 2022-12-30 at 11 57 41 AM

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.

OCI Services Currently Supported by CD3

Screenshot 2022-12-30 at 1 05 59 PM

Getting Started

Pre-requisites

  • 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.

To clone the repo

  • 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.

To build an image

  • 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.

To save the image (Optional)

  • Run docker save cd3toolkit:${image_tag} | gzip > cd3toolkit_${image_tag}.tar.gz

To run the CD3 container and exec into it

  • 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.

Contributing

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.

License

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.

cd3-automation-toolkit's People

Contributors

shrusubra avatar xs2suruchi avatar ttscoff avatar dipeshrath avatar divya44das avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.