You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CD3 stands for <b>C</b>loud <b>D</b>eployment <b>D</b>esign <b>D</b>eliverable.
7
33
The CD3 Automation toolkit has been developed to help in automating the OCI resource object management.
8
34
<br><br>
9
-
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.
35
+
It reads input data in the form of CD3 Excel sheet and generates the terraform files which can be used to provision the resources in OCI 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.
10
36
<br><br>
37
+
<kbd>
11
38
<imgwidth="748"alt="Screenshot 2022-12-30 at 11 57 41 AM"src="https://user-images.githubusercontent.com/111430850/210614513-5d2e97a6-3c1e-4a2b-a793-3a1b6410c856.png">
39
+
</kbd>
12
40
<br>
13
41
14
42
#### OCI Services Currently Supported by CD3
@@ -25,51 +53,16 @@ It reads input data in the form of CD3 Excel sheets and generates the terraform
`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.`
29
-
<br>
30
-
31
-
## Getting Started
32
56
33
-
###Pre-requisites
57
+
## Pre-requisites
34
58
* Git
35
59
* Any docker CLI compatible platform such as Docker or Rancher.
36
60
* Local Directory - A directory in your local system that will be shared with the container to hold the generated Terraform files.
37
61
* OCI Tenancy Access Requirement -
38
62
Appropriate IAM policies must be in place for each of the resources that the user may try to create.
39
63
Minimum requirement for the user to get started is to have the ability to read to the tenancy.
40
64
41
-
42
-
### To clone the repo
43
-
* Open your terminal and change the directory to the one where you want to download the git repo.
<br /><b>Note</b> : ${image_tag} should be replaced with suitable tag as per your requirements/standards.
53
-
<br /> The period at the end of the docker build command is required.
54
-
55
-
### To save the image (Optional)
56
-
* Run <i>"docker save cd3toolkit:${image_tag} | gzip > cd3toolkit_${image_tag}.tar.gz"</i>
57
-
58
-
59
-
### To run the CD3 container and exec into it
60
-
* Run <i>"docker run --platform linux/amd64 -it -d -v <directory_in_local_system_where_the_files_must_be_generated>:/cd3user/tenancies <image_name>:<image_tag>"</i>
61
-
* Run <i>"docker ps"</i>
62
-
* Run <i>"docker exec -it <container_id> bash"</i>
63
-
<br><br>
64
-
Follow the toolkit docs i.e. from the section <i>"Configuring the Docker Container to connect to OCI Tenancy"</i> in
65
-
<ahref="https://github.com/oracle-devrel/cd3-automation-toolkit/blob/develop/cd3_automation_toolkit/documentation/user_guide/01%20CD3%20Automation%20Toolkit%20-%20End%20to%20End%20Process.pdf">CD3 Automation Tookit - End To End Process Documentation</a>. Please download the document from Github.
66
-
<br>
67
-
<i>CD3 Quick Start template can be found at <b><ahref="https://github.com/oracle-devrel/cd3-automation-toolkit/blob/develop/cd3_automation_toolkit/example/CD3-CIS-template.xlsx">CD3 CIS Template</a></b></i>
68
-
<br>
69
-
<i>CD3 Sample Excel templates can be found at <b><ahref="https://github.com/oracle-devrel/cd3-automation-toolkit/tree/develop/cd3_automation_toolkit/example">Excel Templates</a> </b></i>
70
-
<br>
71
-
<br>
72
-
<b>Note</b> : <i>The above steps have been tested on Windows (Git Bash) and MacOS.</i><br/>
65
+
[Click here](/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md) to get started and manage your OCI Infra!!!
73
66
74
67
## Contributing
75
68
This project is open source. Please submit your contributions by raising an <b>Issue</b> or through <b>Discussion topic</b> in this repository. Currently, we do not accept any pull requests. Oracle appreciates any contributions that are made by the open source community.
@@ -81,4 +74,4 @@ Licensed under the Universal Permissive License (UPL), Version 1.0.
81
74
82
75
See [LICENSE](LICENSE) for more details.
83
76
84
-
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.
77
+
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.
0 commit comments