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
<li>createTenancyConfig.py script will use the config file located at /cd3user/.oci path. And toolkit supports profile name as DEFAULT only.</li>
2405
+
<li>connectCloud.py script will use the config file located at /cd3user/.oci path. And toolkit supports profile name as DEFAULT only.</li>
2406
2406
<li>Generated session token will have maximum 60 minutes validity. You will have to follow from step 1 if new session token is required after expiry. The User should have administrator access to the tenancy to use complete functionality of the toolkit.</li>
Copy file name to clipboardExpand all lines: v2025.2.0/cd3-jenkins/index.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2422,7 +2422,7 @@ <h1 id="set-up-oci-using-automation-toolkit-with-jenkins"><strong>Set Up OCI usi
2422
2422
<hr/>
2423
2423
<p>Jenkins integration with the toolkit is provided to jump start your journey with CI/CD for IaC in OCI. A beginner level of understanding of Jenkins is required.</p>
2424
2424
<h2id="pre-reqs-for-jenkins-configuration"><strong>Pre-reqs for Jenkins Configuration</strong></h2>
2425
-
<p>The required configurations for Jenkins setup are done when executing createTenancyConfig.py in <ahref="../connect-container-to-oci-tenancy"><u>Connect CD3 Container to OCI Tenancy</u></a>. Here are the validation steps:</p>
2425
+
<p>The required configurations for Jenkins setup are done when executing connectCloud.py in <ahref="../connect-container-to-oci-tenancy"><u>Connect CD3 Container to OCI Tenancy</u></a>. Here are the validation steps:</p>
2426
2426
<ul>
2427
2427
<li>jenkins.properties file is created under <code>/cd3user/tenancies/jenkins_home</code> as per input parameters in tenancyconfig. properties<br></li>
2428
2428
<li>An Object Storage bucket is created in OCI in the specified compartment to manage tfstate remotely. <br></li>
@@ -2437,7 +2437,7 @@ <h2 id="bootstrapping-of-jenkins-in-the-toolkit"><strong>Bootstrapping of Jenkin
2437
2437
<divclass="admonition info">
2438
2438
<pclass="admonition-title">Jenkins configuration for new prefix</p>
2439
2439
<ul>
2440
-
<li>If createTenancyConfig.py has been run again for a new prefix, then first kill the existing jenkins process and start new after that.</li>
2440
+
<li>If connectCloud.py has been run again for a new prefix, then first kill the existing jenkins process and start new after that.</li>
2441
2441
<li>Command to get Jenkins process id - <code>ps -ef | grep jenkins</code></li>
2442
2442
<li>Command to kill - <code>kill -9 <process_id></code></li>
2443
2443
<li>Start Jenkins using - <code>/usr/share/jenkins/jenkins.sh &</code></li>
<p><I>Compartment Network does not exist in OCI.</I>→ This error means that the component is not found in OCI. So, please make sure to create the Compartment "Network" before validating other tabs.</p>
2430
2430
</li>
2431
2431
<li>
2432
-
<p><I>Either "Region" ashburn is not subscribed to tenancy or toolkit is not yet configured to be used for this region.</I> → If this is a new region subscribed to the tenancy after toolkit was setup initially then Please re run createTenancyConfig.py with same connectOCI.properties to configure the toolkit with the new region.</p>
2432
+
<p><I>Either "Region" ashburn is not subscribed to tenancy or toolkit is not yet configured to be used for this region.</I> → If this is a new region subscribed to the tenancy after toolkit was setup initially then Please re run connectCloud.py with same connectOCI.properties to configure the toolkit with the new region.</p>
<td>Customer Specific properties file for outdir structure.
2639
-
This file will not be generated if 'outdir_structure_file' parameter was set to empty(single outdir)in connectOCI.properties while running createTenancyConfig.py</td>
2639
+
This file will not be generated if 'outdir_structure_file' parameter was set to empty(single outdir)in connectOCI.properties while running connectCloud.py</td>
2640
2640
</tr>
2641
2641
<tr>
2642
2642
<td>Region based directories</td>
@@ -2727,7 +2727,7 @@ <h1 id="connect-cd3-container-to-oci-tenancy"><strong>Connect CD3 Container to O
2727
2727
<p><br></p>
2728
2728
<divclass="admonition abstract">
2729
2729
<pclass="admonition-title">Subscribing to a new OCI Region?</p>
2730
-
<p>When a new region is subscribed to the tenancy, rerun <code>createTenancyConfig.py</code> by using the same <code>connectOCI.properties</code> file that was originally used.<br>
2730
+
<p>When a new region is subscribed to the tenancy, rerun <code>connectCloud.py</code> by using the same <code>connectOCI.properties</code> file that was originally used.<br>
2731
2731
✅ It will create new directory for the new region under <code>/cd3user/tenancies/<prefix>/terraform_files</code> without modifying the existing ones <br>
2732
2732
✅ It will also commit the latest terraform_files folder to OCI DevOps GIT repo.</p>
Copy file name to clipboardExpand all lines: v2025.2.0/delete-prefix/index.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2364,10 +2364,10 @@
2364
2364
<h1id="delete-prefix-and-its-supporting-resources-in-oci"><strong>Delete prefix and its supporting resources in OCI</strong></h1>
2365
2365
<hr/>
2366
2366
<p>Users can delete an existing prefix if they are not using it anymore to ensure no prefix-specific residual resources or components remain and also to avoid naming conflicts in future executions.<br>
2367
-
🔁 This is also beneficial for users who want to re-run <code>createTenancyConfig.py</code> with the same prefix after an unsuccessful execution.</p>
2367
+
🔁 This is also beneficial for users who want to re-run <code>connectCloud.py</code> with the same prefix after an unsuccessful execution.</p>
2368
2368
<p><br></p>
2369
-
<p><spanstyle="color: teal;"><b>Resources created with createTenancyConfig.py execution:</b></span></p>
2370
-
<p>When executing createTenancyConfig.py during <ahref="../connect-container-to-oci-tenancy"><u>Connect Container to OCI</u></a>, the following components are created:</p>
2369
+
<p><spanstyle="color: teal;"><b>Resources created with connectCloud.py execution:</b></span></p>
2370
+
<p>When executing connectCloud.py during <ahref="../connect-container-to-oci-tenancy"><u>Connect Container to OCI</u></a>, the following components are created:</p>
2371
2371
<ul>
2372
2372
<li>Config files under <code>/cd3user/tenancies/<prefix></code> folder</li>
<p>Make sure to use a clean outdir without any .tfvars or .tfstate file. Also use a blank CD3 Excel sheet as export process will overwrite the data in the respective tab.</p>
2369
2369
<p><strong>3. If I am already using the toolkit and my OCI tenancy has been subscribed to a new region, how do i use the new region with toolkit?</strong>
2370
2370
<br><br/>
2371
-
Re-run createTenancyConfig.py with same details in tenancyConfig.properties file. It will keep existing region directories as is and create new directory for newly subscribed region.</p>
2371
+
Re-run connectCloud.py with same details in connectOCI.properties file. It will keep existing region directories as is and create new directory for newly subscribed region.</p>
2372
2372
<p><strong>4. How do I upgrade an existing version of the toolkit to the new one without disrupting my existing tenancy files/directories?</strong>
2373
2373
<br><br/>
2374
2374
Check out <ahref="../upgrade-toolkit"><u>Steps to Upgrade Your Toolkit</u></a></p>
<p>Here, the network and nsg directories have been renamed to <strong>demo_network</strong> and <strong>demo_nsg</strong> respectively. The next steps to run the toolkit remain the same as specified in <ahref="../greenfield-cli"><u>Greenfield workflow</u></a></p>
2390
2390
<ol>
2391
2391
<li>
2392
-
<p>Run <code>python createTenancyConfig.py connectOCI.properties</code> from <code>cd3_automation_toolkit</code> folder. This will create prefix folder as <code>/cd3user/tenancies/<prefix>/</code> and configure a seperate directory for each service inside region folder subscribed to the tenancy.</p>
2392
+
<p>Run <code>python connectCloud.py oci connectOCI.properties</code> from <code>cd3_automation_toolkit</code> folder. This will create prefix folder as <code>/cd3user/tenancies/<prefix>/</code> and configure a seperate directory for each service inside region folder subscribed to the tenancy.</p>
2393
2393
</li>
2394
2394
<li>
2395
2395
<p>Go to <code>/cd3user/tenancies/<prefix>/<prefix>_setUpOCI.propertiesfile</code> and add the CD3 Excel path. </p>
@@ -2418,7 +2418,7 @@ <h1 id="grouping-set-of-resources-into-a-single-tf-state-file">Grouping set of r
<p>Run <code>python createTenancyConfig.py connectOCI.properties</code> from <code>cd3_automation_toolkit</code> folder. This will create prefix folder as <code>/cd3user/tenancies/<prefix>/</code> and tfvars/state file for each service inside the region folder subscribed for the region.</p>
2421
+
<p>Run <code>python connectCloud.py oci connectOCI.properties</code> from <code>cd3_automation_toolkit</code> folder. This will create prefix folder as <code>/cd3user/tenancies/<prefix>/</code> and tfvars/state file for each service inside the region folder subscribed for the region.</p>
2422
2422
</li>
2423
2423
<li>
2424
2424
<p>Rest of the steps to run the toolkit remain the same.</p>
<pclass="admonition-title">Multi-prefix with Jenkins</p>
2369
2369
<ul>
2370
-
<li>With the toolkit release v2024.4.1, the toolkit supports executing createTenancyConfig.py with different values for <strong>prefix</strong> per container when using Jenkins.</li>
2370
+
<li>With the toolkit release v2024.4.1, the toolkit supports executing connectCloud.py with different values for <strong>prefix</strong> per container when using Jenkins.</li>
<p>You can copy connectOCI.properties file as tenancyconfig_<prefix>.properties and edit this file instead of directly editing connectOCI.properties.<br>
2385
-
This will help retain the input properties files used for different executions of the createTenancyConfig.py</p>
2384
+
<p>You can copy connectOCI.properties file as connectOCI_<prefix>.properties and edit this file instead of directly editing connectOCI.properties.<br>
2385
+
This will help retain the input properties files used for different executions of the connectCloud.py</p>
2386
2386
</div>
2387
2387
<ul>
2388
2388
<li>Different values can be specified for other parameters as well. For instance, one prefix can be configured to have <strong>multiple outdir structure</strong> for the generated terraform files, while another prefix can be set with a <strong>single outdir structure</strong>.</li>
2389
-
<li>Execute <strong>createTenancyConfig.py</strong> with modified <strong>connectOCI.properties</strong> or <strong>tenancyconfig_<prefix>.properties</strong>.</li>
2390
-
<li>After executing <strong>createTenancyConfig.py</strong>, the following screenshots show how the environment specific out directories look like when using the toolkit with CLI and with Jenkins.</li>
2389
+
<li>Execute <strong>connectCloud.py</strong> with modified <strong>connectOCI.properties</strong> or <strong>connectOCI_<prefix>.properties</strong>.</li>
2390
+
<li>After executing <strong>connectCloud.py</strong>, the following screenshots show how the environment specific out directories look like when using the toolkit with CLI and with Jenkins.</li>
2391
2391
</ul>
2392
2392
<p><br></p>
2393
2393
<p><spanstyle="color: teal; font-weight: bold;"> Multi Prefix with CLI</span></p>
Copy file name to clipboardExpand all lines: v2025.2.0/remotestate/index.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2375,12 +2375,12 @@ <h1 id="store-terraform-state-into-object-storage-bucket">Store Terraform State
2375
2375
<p><br></p>
2376
2376
<ul>
2377
2377
<li>Toolkit provides the option to store terraform state file(tfstate) into Object Storage bucket.</li>
2378
-
<li>This can be achieved by setting <code>use_remote_state=yes</code> under Advanced Parameters in <code>connectOCI.properties</code> file while executing <code>createTenancyConfig.py</code>.</li>
2378
+
<li>This can be achieved by setting <code>use_remote_state=yes</code> under Advanced Parameters in <code>connectOCI.properties</code> file while executing <code>connectCloud.py</code>.</li>
2379
2379
<li>
2380
2380
<p>Upon setting above parameter the script will -</p>
2381
2381
<ul>
2382
2382
<li>create a versioning enabled bucket in OCI tenancy in the specified region(if you don't specify anything in <code>remote_state_bucket_name</code> parameter to use an existing bucket)</li>
2383
-
<li>create a new customer secret key for the user, and configure it as S3 credentials to access the bucket. Before executing the createTenancyConfig.py script, ensure that the specified user in the DevOps User Details or identified by the user OCID does not already have the maximum limit of two customer secret keys assigned. </li>
2383
+
<li>create a new customer secret key for the user, and configure it as S3 credentials to access the bucket. Before executing the connectCloud.py script, ensure that the specified user in the DevOps User Details or identified by the user OCID does not already have the maximum limit of two customer secret keys assigned. </li>
0 commit comments