Skip to content

Commit 308c610

Browse files
authored
Merge pull request #15 from oracle-devrel/develop
Update README.md
2 parents 2627131 + 269bf37 commit 308c610

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
## Introduction
77
CD3 stands for Cloud Deployment Design Deliverable.
88
The CD3 Automation toolkit has been developed to help in automating the OCI resource object management.
9-
<br>
10-
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. This simplifies the management of the company's infrastructure as code.
11-
<br>
9+
<br><br>
10+
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.
11+
<br><br>
1212
<img width="715" alt="Screenshot 2022-12-30 at 11 57 41 AM" src="https://user-images.githubusercontent.com/103475219/210041258-258601c4-dd1d-48a1-b6d7-df1bda764190.png">
1313
<br><br>
1414

@@ -37,10 +37,8 @@ Minimum requirement for the user to get started is to have the ability to read t
3737
### To build an image
3838

3939
* Change directory to cd3-automation-toolkit(i.e. the cloned repo in your local).
40-
* Run docker build -t cd3toolkit:${image_tag} -f Dockerfile --pull --no-cache .
41-
42-
<b>Note</b> : <i>${image_tag} should be replaced with suitable tag as per your requirements/standards.</i>
43-
<br>
40+
* Run docker build -t cd3toolkit:${image_tag} -f Dockerfile --pull --no-cache .<br/>
41+
<br /><b>Note</b> : <i>${image_tag} should be replaced with suitable tag as per your requirements/standards.</i>
4442

4543
### To save the image (Optional)
4644
* Run docker save cd3toolkit:${image_tag} | gzip > cd3toolkit_${image_tag}.tar.gz
@@ -51,13 +49,15 @@ Minimum requirement for the user to get started is to have the ability to read t
5149
* Run docker ps
5250
* Run docker exec -it <container_id> bash
5351
<br><br>
54-
Follow the toolkit docs i.e. from section "Configuring the Docker Container to connect to OCI Tenancy" of "01 CD3 Automation Tookit - End to End Process" inside cd3_automation_toolkit/documentation/user_guide to know HOW TO use to toolkit further.
55-
<br><br>
56-
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
57-
<br><br>
58-
Please download the document from Github.
52+
Follow the toolkit docs i.e. from the section <i>"Configuring the Docker Container to connect to OCI Tenancy"</i> in
53+
<a href="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.
54+
<br>
55+
<i>CD3 Quick Start template can be found at <b><a href="https://github.com/oracle-devrel/cd3-automation-toolkit/blob/develop/cd3_automation_toolkit/example/CD3-CIS-template.xlsx">CD3 CIS Template</a></b></i>
56+
<br>
57+
<i>CD3 Sample Excel templates can be found at <b><a href="https://github.com/oracle-devrel/cd3-automation-toolkit/tree/develop/cd3_automation_toolkit/example">Excel Templates</a> </b></i>
58+
<br>
5959
<br>
60-
<b>Note</b> : <i>The above steps have been tested on Windows (Git Bash) and MacOS.</i>
60+
<b>Note</b> : <i>The above steps have been tested on Windows (Git Bash) and MacOS.</i><br/>
6161

6262
## Contributing
6363
This project is open source. Please submit your contributions by forking this repository and submitting a pull request! Oracle appreciates any contributions that are made by the open source community.

0 commit comments

Comments
 (0)