Skip to content

Commit 5db62e3

Browse files
xs2suruchixs2suruchi
authored
Merge pull request #44 from oracle-devrel/develop
Develop
2 parents 6a98cca + cd93c3f commit 5db62e3

13 files changed

+102
-64
lines changed

‎README.md

Lines changed: 66 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,71 @@
22

33
[![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=oracle-devrel_cd3-automation-toolkit)](https://sonarcloud.io/dashboard?id=oracle-devrel_cd3-automation-toolkit)
44

5-
## Table of Contents :bookmark:
6-
7-
1. [Introduction](#introduction)
8-
2. [Pre-requisites](#pre-requisites)
9-
3. [Launch Docker container](/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md)
10-
4. [Connect container to OCI Tenancy](/cd3_automation_toolkit/documentation/user_guide/Connect_container_to_OCI_Tenancy.md)
11-
5. [Getting Started with Automation Toolkit](/cd3_automation_toolkit/documentation/user_guide/RunningAutomationToolkit.md)
12-
6. [Using the Automation Toolkit](/cd3_automation_toolkit/documentation/user_guide/Workflows.md)
13-
- [Green Field Tenancies](/cd3_automation_toolkit/documentation/user_guide/GreenField.md)
14-
- [Non-Green Field Tenancies](/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md)
15-
7. MUST READ...
16-
- [Managing Network for Green Field Tenancies](/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md)
17-
- [Managing Network for Non Green Field Tenancies](/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md)
18-
8. [Grouping of generated Terraform files](/cd3_automation_toolkit/documentation/user_guide/RestructuringOutDirectory.md)
19-
9. [Expected Behaviour Of Automation Toolkit](/cd3_automation_toolkit/documentation/user_guide/KnownBehaviour.md)
20-
10. [FAQs](/cd3_automation_toolkit/documentation/user_guide/FAQ.md)
21-
11. [What's new in this release!!](https://github.com/oracle-devrel/cd3-automation-toolkit/releases/tag/v10.1)
22-
12. [Steps to Upgrade Your Toolkit](/cd3_automation_toolkit/documentation/user_guide/Upgrade_Toolkit.md)
23-
13. Learn More...
24-
- CD3 Excel Information
25-
- [Excel Templates](/cd3_automation_toolkit/documentation/user_guide/RunningAutomationToolkit.md#excel-sheet-templates)
26-
- [Toolkit Supported OCI Services](/cd3_automation_toolkit/documentation/user_guide/learn_more/CD3ExcelTabs.md)
27-
- [CD3 Validator Features](/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportForCD3Validator.md)
28-
- [Additional CIS Compliance Features](/cd3_automation_toolkit/documentation/user_guide/learn_more/CISFeatures.md)
29-
- [OCI Resource Manager Upload](/cd3_automation_toolkit/documentation/user_guide/learn_more/ResourceManagerUpload.md)
30-
- [Support for Additional Attributes](/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportforAdditionalAttributes.md)
31-
14. [Automation Toolkit Learning Videos](/cd3_automation_toolkit/documentation/user_guide/LearningVideos.md)
5+
6+
7+
<ul>
8+
9+
<li> <a href= "#introduction">Introduction</a></li>
10+
11+
<li> <a href = "https://github.com/oracle-devrel/cd3-automation-toolkit/releases/tag/v10.2">What's new in this release</a></li>
12+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/CD3ExcelTabs.md">Toolkit Supported OCI Services</a></li>
13+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/RunningAutomationToolkit.md#excel-sheet-templates">Excel Templates</a></li>
14+
15+
</ul>
16+
17+
### New Users
18+
19+
<ul>
20+
21+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/prerequisites.md">Prerequisites</a></li>
22+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md">Launch Docker container</a></li>
23+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Connect_container_to_OCI_Tenancy.md">Connect container to OCI Tenancy</a></li>
24+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/RunningAutomationToolkit.md">Getting Started with Automation Toolkit</a></li>
25+
26+
27+
<li> <a href="/cd3_automation_toolkit/documentation/user_guide/Workflows.md">Using the Automation Toolkit</a>
28+
<ul>
29+
<li> <a href="/cd3_automation_toolkit/documentation/user_guide/GreenField.md">Green Field Tenancies</a>
30+
<ul>
31+
<li> <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md"</a><b> Must Read :</b> Managing Network for Greenfield Tenancies</li>
32+
</ul>
33+
</ul>
34+
</li>
35+
<ul>
36+
<li> <a href="/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md">Non Greenfield Tenancies</a>
37+
<ul>
38+
<li><a href ="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md"</a><b> Must Read : </b> Managing Network for Non-Greenfield Tenancies</li>
39+
</ul>
40+
</ul>
41+
42+
43+
</ul>
44+
45+
### Existing Users
46+
47+
<ul>
48+
49+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Upgrade_Toolkit.md">Steps to Upgrade Your Toolkit</a></li>
50+
51+
</ul>
52+
53+
### Learn More...
54+
55+
<ul>
56+
57+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/RestructuringOutDirectory.md">Grouping of generated Terraform files</a></li>
58+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/ResourceManagerUpload.md">OCI Resource Manager Upload</a></li>
59+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/CISFeatures.md">Additional CIS Compliance Features</a></li>
60+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportForCD3Validator.md">CD3 Validator Features</a></li>
61+
62+
63+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportforAdditionalAttributes.md">Support for Additional Attributes</a></li>
64+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/LearningVideos.md">Automation Toolkit Learning Videos</a></li>
65+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/KnownBehaviour.md">Expected Behaviour Of Automation Toolkit</a></li>
66+
<li> <a href = "/cd3_automation_toolkit/documentation/user_guide/FAQ.md">FAQs</a></li>
67+
68+
</ul>
69+
3270

3371

3472
## Introduction
@@ -57,15 +95,7 @@ It reads input data in the form of CD3 Excel sheet and generates the terraform f
5795
| [CIS Landing Zone Compliance](/cd3_automation_toolkit/documentation/user_guide/learn_more/CISFeatures.md#additional-cis-compliance-features) | Download and Execute CIS Compliance Check Script, VCN Flow Logs, Cloud Guard, Object Storage, Key Vault, Budget |
5896

5997

60-
## Pre-requisites
61-
* Git
62-
* Any docker CLI compatible platform such as Docker or Rancher.
63-
* Local Directory - A directory in your local system that will be shared with the container to hold the generated Terraform files.
64-
* OCI Tenancy Access Requirement -
65-
Appropriate IAM policies must be in place for each of the resources that the user may try to create.
66-
Minimum requirement for the user to get started is to have the ability to read to the tenancy.
67-
68-
[Click here](/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md) to get started and manage your OCI Infra!
98+
[Click here](/cd3_automation_toolkit/documentation/user_guide/prerequisites.md) to get started and manage your OCI Infra!
6999

70100
## Contributing
71101
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.

‎cd3_automation_toolkit/Release-Notes

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
CD3 Automation Toolkit Tag v10.2
33
----------------------------------
44
1. Bug fixes - tfvars template change for Security Rules to include source port range, RM stack zip file,
5-
nsg TF variable check, encoding issue with cis_reports.py, added ignore life cycle changes for ECMP, multi-line and tags issue for Identity Components.
5+
nsg TF variable check, encoding issue with cis_reports.py, making drg_route_table attributes as optional -
6+
ecmp changes, multi-line and tags issue for Identity Components.
67
2. Restrict directory permissions for cd3user inside the container.
78
3. Fix python package versions in shell scrip while launching container.
89
4. Allowed cloud guard to be enabled from any region and fixed terraform for cloud guard.

‎cd3_automation_toolkit/documentation/user_guide/FAQ.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,4 @@ Please refer the screenshots below -
6868
![image](https://user-images.githubusercontent.com/103508105/215455637-4bcaac18-269d-4029-b273-2214b719563f.png)
6969
<br> - Alternately, please attach a data disk and map the container (/cd3user/tenancies) on a folder that is created on the data disk (your local folder).
7070

71-
<br><br>
72-
<div align='center'>
7371

74-
| <a href="/cd3_automation_toolkit/documentation/user_guide/KnownBehaviour.md">:arrow_backward: Prev</a> | <a href="https://github.com/oracle-devrel/cd3-automation-toolkit/releases/tag/v10.1">Next :arrow_forward:</a> |
75-
| :---- | -------: |

‎cd3_automation_toolkit/documentation/user_guide/GreenField.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Follow the below steps to quickly provision a compartment on OCI.
7878
<br><br>
7979
<div align='center'>
8080

81-
| <a href="/cd3_automation_toolkit/documentation/user_guide/Workflows.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md">Next :arrow_forward:</a> |
81+
| <a href="/cd3_automation_toolkit/documentation/user_guide/Workflows.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md">Next :arrow_forward:</a> |
8282
| :---- | -------: |
8383

8484
</div>

‎cd3_automation_toolkit/documentation/user_guide/KnownBehaviour.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,4 @@
124124
This is how terraform handles newlines in the fields. Pleage ignore this and proceed with terraform apply.
125125

126126

127-
| <a href="/cd3_automation_toolkit/documentation/user_guide/RestructuringOutDirectory.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/FAQ.md">Next :arrow_forward:</a> |
128-
| :---- | -------: |
129-
130-
</div>
127+

‎cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To ease the execution of toolkit, we have provided the steps to build an image w
2626
<br><br>
2727
<div align='center'>
2828

29-
| <a href="/README.md#table-of-contents-bookmark">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/Connect_container_to_OCI_Tenancy.md">Next :arrow_forward:</a> |
29+
| <a href="/cd3_automation_toolkit/documentation/user_guide/prerequisites.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/Connect_container_to_OCI_Tenancy.md">Next :arrow_forward:</a> |
3030
| :---- | -------: |
3131

3232
</div>

‎cd3_automation_toolkit/documentation/user_guide/LearningVideos.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
* [How to Install and Configure Rancher Desktop Part 2](https://www.youtube.com/watch?v=2QNAOJpeJZc)
55
* [How to Create the Image and Run the container with CD3 Part 3](https://www.youtube.com/watch?v=FUUiSZmDFI4)
66
* [How to Connect the Container to Tenancy with CD3 Part 4](https://www.youtube.com/watch?v=Nv3oXhrDnoU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=5)
7-
* [How to use CD3 Excel Sheets Part 5](https://www.youtube.com/watch?v=79laRDhvKiE&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=6)
8-
* [What Are Greenfield Tenancies? Part 6](https://www.youtube.com/watch?v=8wecHuY08Ps&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=7)
9-
* [How to upload CD3 stack to Resource Manager Part 7](https://www.youtube.com/watch?v=OifKu-t57CU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=9)
10-
* [Management Services - CD3 Automation Toolkit Part 8](https://www.youtube.com/watch?v=wFkECxy209s&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=10)
11-
* [Non-Greenfield Tenancies - CD3 Automation Toolkit Part 9](https://www.youtube.com/watch?v=l_lUEF3XYoM&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=11)
12-
* [Support for Additional Attributes - CD3 Automation toolkit Part 10](https://www.youtube.com/watch?v=6bWWbchS2vk&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=12)
7+
* [How to Group Generated Terraform Files Part 5](https://www.youtube.com/watch?v=iASN7ZTbOKQ&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=6)
8+
* [How to use CD3 Excel Sheets Part 6](https://www.youtube.com/watch?v=79laRDhvKiE&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=7)
9+
* [What Are Greenfield Tenancies? Part 7](https://www.youtube.com/watch?v=8wecHuY08Ps&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=8)
10+
* [How to upload CD3 stack to Resource Manager Part 8](https://www.youtube.com/watch?v=OifKu-t57CU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=9)
11+
* [Management Services - CD3 Automation Toolkit Part 9](https://www.youtube.com/watch?v=wFkECxy209s&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=10)
12+
* [Non-Greenfield Tenancies - CD3 Automation Toolkit Part 10](https://www.youtube.com/watch?v=l_lUEF3XYoM&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=11)
13+
* [Support for Additional Attributes - CD3 Automation toolkit Part 11](https://www.youtube.com/watch?v=6bWWbchS2vk&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=12)
1314

1415
<br>[Here](https://www.youtube.com/playlist?list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp) is the Youtube playlist link for all these videos.

‎cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ This completes the modification of NSGs in OCI. Verify the components in console
191191
<br><br>
192192
<div align='center'>
193193

194-
| <a href="/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md">Next :arrow_forward:</a> |
194+
| <a href="/cd3_automation_toolkit/documentation/user_guide/GreenField.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md">Next :arrow_forward:</a> |
195195
| :---- | -------: |
196196

197197
</div>

‎cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Subnets tab:
5757
<br><br>
5858
<div align='center'>
5959

60-
| <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/RestructuringOutDirectory.md">Next :arrow_forward:</a> |
60+
| <a href="/cd3_automation_toolkit/documentation/user_guide/NonGreenField.md">:arrow_backward: Prev</a> | <a href="/README.md#table-of-contents-bookmark">Main Menu :arrow_forward:</a> |
6161
| :---- | -------: |
6262

6363
</div>

‎cd3_automation_toolkit/documentation/user_guide/NonGreenField.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Follow the below steps to quickly export Identity components from OCI.
8282
<br><br>
8383
<div align='center'>
8484

85-
| <a href="/cd3_automation_toolkit/documentation/user_guide/GreenField.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md">Next :arrow_forward:</a> |
85+
| <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosGF.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md">Next :arrow_forward:</a> |
8686
| :---- | -------: |
8787

8888
</div>

‎cd3_automation_toolkit/documentation/user_guide/RestructuringOutDirectory.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,3 @@ With Automation Toolkit release v10.1, it allows you to choose different directo
77
This can be configured while [connecting your container to the OCI tenancy](/cd3_automation_toolkit/documentation/user_guide/Connect_container_to_OCI_Tenancy.md#connect-docker-container-to-oci-tenancy)
88
A new parameter 'outdir_structure_file' has been introduced in tenancyconfig.properties using which you can use to configure single outdir or different outdir for each service.
99

10-
<br><br>
11-
<div align='center'>
12-
13-
| <a href="/cd3_automation_toolkit/documentation/user_guide/NetworkingScenariosNGF.md">:arrow_backward: Prev</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/KnownBehaviour.md">Next :arrow_forward:</a> |
14-
| :---- | -------: |
15-

‎cd3_automation_toolkit/documentation/user_guide/Upgrade_Toolkit.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Steps to Upgrade Your Toolkit (For Existing Customers):
22

3+
## Upgrade to Release v10.2 from v10.1
4+
1. Follow the steps in [Launch Docker Container](/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md) to build new image with latest code and launch the container by specifying same path for <directory_in_local_system_where_the_files_must_be_generated> to keep using same outdir.
5+
2. There are minor upgrades to terraform modules. In order to use the latest modules, copy the contents(modules directory and all .tf files from _/cd3user/oci_tools/cd3\_automation\_toolkit/user-scripts/terraform_ <b>to</b> _/cd3user/tenancies/<customer\_name>/terraform\_files/<region\_dir>_. Move existing _variables\_\<region\>.tf_ to some backup and Copy OCI Connect Variables block from this file into _variables\_example.tf_ file and rename it to _variables\_\<region\>.tf_
6+
37
## Upgrade to Release v10.1 from v10
48
1. Follow the steps in [Launch Docker Container](/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md) to build new image with latest code and launch the container by specifying same path for <directory_in_local_system_where_the_files_must_be_generated> to keep using same outdir.
59
2. There are minor upgrades to terraform modules. In order to use the latest modules, copy the contents(modules directory and all .tf files except variables_example.tf) from _/cd3user/oci_tools/cd3\_automation\_toolkit/user-scripts/terraform_ <b>to</b> _/cd3user/tenancies/<customer\_name>/terraform\_files/<region\_dir>_.
@@ -16,5 +20,6 @@
1620
<br><br>
1721
<div align='center'>
1822

19-
| <a href="/cd3_automation_toolkit/documentation/user_guide/FAQ.md">:arrow_backward: Prev</a> | <a href="/README.md#table-of-contents-bookmark">Next :arrow_forward:</a> |
20-
| :---- | -------: |
23+
| <a href="/README.md#table-of-contents-bookmark">Main menu</a> |
24+
| :---- |
25+
</div>

‎cd3_automation_toolkit/documentation/user_guide/prerequisites.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Prerequisites
2+
3+
- Git
4+
- Any docker CLI compatible platform such as Docker or Rancher.
5+
- Local Directory - A directory in your local system that will be shared with the container to hold the generated Terraform files.
6+
- 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.
7+
8+
<br><br>
9+
<div align='center'>
10+
11+
| <a href="/README.md#table-of-contents-bookmark">:arrow_backward: Main Menu</a> | <a href="/cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md">Next :arrow_forward:</a> |
12+
| :---- | -------: |
13+
14+
</div>

0 commit comments

Comments
 (0)