Merge pull request #88 from oracle-devrel/develop

Automation Toolkit Release v2024.1.0

README.md

@@ -2,6 +2,9 @@
 
 [![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)
 <ul>
+  <kbd>
+<img width="1018" alt="Screenshot 2024-02-06 at 1 11 21 PM" src="https://github.com/oracle-devrel/cd3-automation-toolkit/assets/103508105/f989efee-45cc-413b-a706-e1bfe7f2a8fc">
+</kbd><br><br>
   <li> <a href= "#introduction">Introduction</a></li>
   <li> <a href = "https://github.com/oracle-devrel/cd3-automation-toolkit/releases/tag/v2024.1.0">What's new in this release</a></li>
   <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/CD3ExcelTabs.md">Toolkit Supported OCI Services</a></li>
@@ -51,7 +54,7 @@
  ### Existing Users
 <ul> 
   <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Upgrade_Toolkit.md">Steps to Upgrade Your Toolkit</a></li>
-  <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Jobs_Migration.md">Migrating Jenkins Jobs</a></li>
+
 </ul> 
 
 ### Videos
@@ -72,20 +75,21 @@
    <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/CISFeatures.md">Additional CIS Compliance Features</a></li>
    <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportForCD3Validator.md">CD3 Validator Features</a></li>   
    <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/learn_more/SupportforAdditionalAttributes.md">Support for Additional Attributes</a></li>
+  <li> <a href = "/cd3_automation_toolkit/documentation/user_guide/Jobs_Migration.md">Migrate Jenkins configuration to Customer Environment</a></li>
 </ul>
-
+
+<br>
+
 ## Introduction
 CD3 stands for <b>C</b>loud <b>D</b>eployment <b>D</b>esign <b>D</b>eliverable.
 The CD3 Automation toolkit has been developed to help in automating the OCI resource object management. 
 <br><br>
 It reads input data in the form of CD3 Excel sheet and generates 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. The toolkit can be used throughout the lifecycle of tenancy to continuously create or modify existing resources. The generated Terraform code can be used by the OCI Resource Manager or can be integrated into organization's existing devops CI/CD ecosystem.
 <br><br>
 <kbd>
-<img width="923" alt="Screenshot 2024-02-02 at 8 23 51 PM" src="https://github.com/oracle-devrel/cd3-automation-toolkit/assets/103508105/c2d06575-1bcb-4cb3-9c49-682bf19f3ac9">
-
+<img width="1018" alt="Screenshot 2024-02-06 at 1 11 21 PM" src="https://github.com/oracle-devrel/cd3-automation-toolkit/assets/103508105/f989efee-45cc-413b-a706-e1bfe7f2a8fc">
 </kbd>
 <br>
-
 #### OCI Services Currently Supported by Automation Toolkit
 
 | OCI Services | Details |

cd3_automation_toolkit/documentation/user_guide/Intro-Jenkins.md

@@ -35,7 +35,7 @@ Below table shows the stages executed in this pipeline along with their descript
 ### 2. terraform_files Folder
 
 This is equivalent to **/cd3user/tenancies/<customer_name>/terraform_files** folder on your local system.
-The region directories along with all service directories, are present under this terraform_files folder.
+The region directories along with all service directories, are present under this terraform_files folder. The toolkit will generate the .tfvars files for all resources under the service directory.
 Inside each service directory, pipelines for **terraform-apply** and **terraform-destroy** are present.
 
 The terraform pipelines are either triggered automatically from setUpOCI pipeline or they can be triggered manually by navigating to any service directory path.

cd3_automation_toolkit/documentation/user_guide/Launch_Docker_container.md

@@ -33,6 +33,8 @@ To ease the execution of toolkit, we have provided the steps to build an image w
   Eg for Mac: ```docker run --platform linux/amd64 -it -p 8443:8443 -d -v /Users/<user_name>/mount_path:/cd3user/tenancies cd3toolkit:v2024.1.0```
 
   Eg for Windows: ```docker run --platform linux/amd64 -it -p 8443:8443 -d -v D:/mount_path:/cd3user/tenancies cd3toolkit:v2024.1.0```
+
+> If you are launching the container on cloud, Please make sure to use a private server or a bastion connected server with restricted access(i.e. not publicly available) to host the container.
 
 * Run  ```docker ps```
 

cd3_automation_toolkit/documentation/user_guide/LearningVideos.md

@@ -1,18 +1,17 @@
 # Automation Toolkit Learning Videos
 
 * [CD3 Automation Toolkit Explained in 1 minute](https://www.youtube.com/watch?v=TSNu0pUHYsE&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=1)
-* [Introduction to Automation Toolkit Part 1](https://www.youtube.com/watch?v=rwxjbYWNbTo&t=57s)
-* [How to Install and Configure Rancher Desktop Part 2](https://www.youtube.com/watch?v=2QNAOJpeJZc)
-* [How to Create the Image and Run the container with CD3 Part 3](https://www.youtube.com/watch?v=FUUiSZmDFI4)
-* [How to Connect the Container to Tenancy with CD3 Part 4](https://www.youtube.com/watch?v=Nv3oXhrDnoU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=5)
-* [How to Group Generated Terraform Files Part 5](https://www.youtube.com/watch?v=iASN7ZTbOKQ&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=6)
-* [How to use CD3 Excel Sheets Part 6](https://www.youtube.com/watch?v=79laRDhvKiE&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=7)
-* [What Are Greenfield Tenancies? Part 7](https://www.youtube.com/watch?v=8wecHuY08Ps&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=8)
-* [How to upload CD3 stack to Resource Manager Part 8](https://www.youtube.com/watch?v=OifKu-t57CU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=9)
-* [Management Services - CD3 Automation Toolkit Part 9](https://www.youtube.com/watch?v=wFkECxy209s&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=10)
-* [Non-Greenfield Tenancies - CD3 Automation Toolkit Part 10](https://www.youtube.com/watch?v=l_lUEF3XYoM&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=11)
-* [Support for Additional Attributes - CD3 Automation toolkit Part 11](https://www.youtube.com/watch?v=6bWWbchS2vk&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=12)
-* [Provisioning of OCI Object Storage Buckets - CD3 Automation toolkit Part 12](https://youtu.be/1lVQw3pDp4U)
-* [Configuring OCI Private DNS - CD3 Automation toolkit Part 13](https://youtu.be/RE-36ip68ZE)
+* [Part 1- Introduction to CD3 Automation Toolkit](https://www.youtube.com/watch?v=rwxjbYWNbTo&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=3)
+* [Part 2 - How to Install and Configure Rancher Desktop with CD3](https://www.youtube.com/watch?v=2QNAOJpeJZc&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=3)
+* [Part 3 - How to Create the Image and Run the Container with CD3](https://www.youtube.com/watch?v=FUUiSZmDFI4&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=4)
+* [Part 4 - Connect CD3 Automation toolkit container to OCI tenancy](https://www.youtube.com/watch?v=E_9RRokDiUs&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=5)
+* [Part 5 - How to use CD3 Excel Sheets](https://www.youtube.com/watch?v=79laRDhvKiE&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=6)
+* [Part 6 - Execute the CD3 Automation toolkit using CLI to create resources in OCI](https://www.youtube.com/watch?v=pnPy1edO278&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=7)
+* [Part 7 - Execute CD3 Automation Toolkit using CLI to export resources in OCI](https://www.youtube.com/watch?v=v54HfX-Pvys&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=8)
+* [Part 8 - Execute the CD3 Automation toolkit using Jenkins to create resources in OCI](https://www.youtube.com/watch?v=buchK2gfTpk&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=9)
+* [Part 9 - Execute the CD3 Automation toolkit using Jenkins to export resources from OCI](https://www.youtube.com/watch?v=p4NGLAMs5us&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=10)
+* [Part 10 - Support for Additional Attributes - CD3 Automation toolkit](https://www.youtube.com/watch?v=6bWWbchS2vk&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=11)
+* [Configuring OCI Private DNS using CD3](https://www.youtube.com/watch?v=9Ie4t4TzgqQ&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=12)
+* [Provisioning OCI Object storage Buckets using CD3](https://www.youtube.com/watch?v=NOexp3lqxHU&list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp&index=13)
 
-  <br>[Here](https://www.youtube.com/playlist?list=PLPIzp-E1msrbJ3WawXVhzimQnLw5iafcp) is the Youtube playlist link for all these videos.
+<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/NonGreenField-Jenkins.md

@@ -1,5 +1,6 @@
 # Export Resources from OCI via Jenkins(Non-Greenfield Workflow)
 
+>Note: Please make sure that service for which export is done does not have existing tfvars/state file.
 
 **Step 1**: 
 <br>Choose the appropriate CD3 Excel sheet template from [Excel Templates](/cd3_automation_toolkit/documentation/user_guide/ExcelTemplates.md)

cd3_automation_toolkit/documentation/user_guide/NonGreenField.md

@@ -1,7 +1,7 @@
 # Export Resources from OCI (Non-Greenfield Workflow)
 
-  > **Note**
-   
+  > **Note**<br>
+  Please make sure that service for which export is done does not have existing tfvars/state file.<br><br>
   >Course of actions involved in Exporting objects from OCI-     
   > * Automation Tool Kit fetches the data for the supported services. You can chose to export the data from a specific region or the compartment. Exported data is written to appropriate sheets of the CD3 Excel Sheet based on the resources being exported.
   > * Tool Kit then generates the TF configuration files/auto.tfvars files for these exported resources.

cd3_automation_toolkit/documentation/user_guide/Workflows-jenkins.md

@@ -20,6 +20,7 @@ Jenkins integraton with the toolkit is provided to jump start your journey with
     > Notes:
      > - \<Port> is the port mapped with local system while docker container creation Eg: 8443.
      > -  Network Connectivity should be allowed on this host and port.
+     > -  Please make sure to use a private server or a bastion connected server with restricted access(i.e. not publicly available).
   - It will prompt you to create first user to access Jenkins URL. This will be the admin user.
   - The Automation Toolkit only supports a single user Jenkins setup in this release.
   - Once you login, Jenkins Dashbord will be displayed.

cd3_automation_toolkit/documentation/user_guide/remote_state.md

@@ -32,8 +32,11 @@
   }  
   ```
 
-* For single outdir, tfstate for all subscribed regions will be stored as ```<region>\terraform.tfstate``` eg ```london\terraform.tfstate``` for london ```phoenix\terraform.tfstate``` for phoenix.
-* For multi outdir, tfstate for all services in all subscribed regions will be stored as ```<region>\<service_dir_name>\terraform.tfstate``` eg ```london\tagging\terraform.tfstate``` for tagging dir in london region
+* For single outdir, tfstate for all subscribed regions will be stored as ```<region>/terraform.tfstate``` eg ```london/terraform.tfstate``` for london ```phoenix/terraform.tfstate``` for phoenix. See below screenshot showing objects in the bucket storing remote state:
+  <img width="1297" alt="Screenshot 2024-02-06 at 8 07 45 PM" src="https://github.com/oracle-devrel/cd3-automation-toolkit/assets/103508105/79c6939c-d785-43e7-99a3-41a95cf90cc8">
+
+* For multi outdir, tfstate for all services in all subscribed regions will be stored as ```<region>/<service_dir_name>/terraform.tfstate``` eg ```london/tagging/terraform.tfstate``` for tagging dir in london region. See below screenshot showing objects in the bucket storing remote state:
+    <img width="1485" alt="Screenshot 2024-02-06 at 3 57 02 PM" src="https://github.com/oracle-devrel/cd3-automation-toolkit/assets/103508105/ee7dd418-f998-4ee8-bfe9-f7bd7d0e30ff">
 
 <br><br>
 <div align='center'>