Skip to content

Commit 23641bd

Browse files
committed
Deployed 72eecd4 to v2025.2.0 with MkDocs 1.5.3 and mike 2.1.1
1 parent 8f63067 commit 23641bd

File tree

15 files changed

+131
-130
lines changed

15 files changed

+131
-130
lines changed

v2025.2.0/authmechanisms/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2402,7 +2402,7 @@ <h2 id="session-token-based-authentication">Session token-based authentication</
24022402
<div class="admonition note">
24032403
<p class="admonition-title">Note</p>
24042404
<ul>
2405-
<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>
24062406
<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>
24072407
</ul>
24082408
</div>

v2025.2.0/cd3-jenkins/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2422,7 +2422,7 @@ <h1 id="set-up-oci-using-automation-toolkit-with-jenkins"><strong>Set Up OCI usi
24222422
<hr />
24232423
<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>
24242424
<h2 id="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 <a href="../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 <a href="../connect-container-to-oci-tenancy"><u>Connect CD3 Container to OCI Tenancy</u></a>. Here are the validation steps:</p>
24262426
<ul>
24272427
<li>jenkins.properties file is created under <code>/cd3user/tenancies/jenkins_home</code> as per input parameters in tenancyconfig. properties<br></li>
24282428
<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
24372437
<div class="admonition info">
24382438
<p class="admonition-title">Jenkins configuration for new prefix</p>
24392439
<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>
24412441
<li>Command to get Jenkins process id - <code>ps -ef | grep jenkins</code></li>
24422442
<li>Command to kill - <code>kill -9 &lt;process_id&gt;</code></li>
24432443
<li>Start Jenkins using - <code>/usr/share/jenkins/jenkins.sh &amp;</code></li>

v2025.2.0/cd3validator/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2429,7 +2429,7 @@ <h1 id="cd3-validator-features">CD3 Validator Features</h1>
24292429
<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>
24302430
</li>
24312431
<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>
24332433
</li>
24342434
<li>
24352435
<p>For policy statements like below:<br>

v2025.2.0/connect-container-to-oci-tenancy/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2636,7 +2636,7 @@ <h1 id="connect-cd3-container-to-oci-tenancy"><strong>Connect CD3 Container to O
26362636
<td>outdir_structure_file.properties</td>
26372637
<td>/cd3user/tenancies/&lt;prefix&gt;/&lt;prefix&gt;_outdir_structure_file</td>
26382638
<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>
26402640
</tr>
26412641
<tr>
26422642
<td>Region based directories</td>
@@ -2727,7 +2727,7 @@ <h1 id="connect-cd3-container-to-oci-tenancy"><strong>Connect CD3 Container to O
27272727
<p><br></p>
27282728
<div class="admonition abstract">
27292729
<p class="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>
27312731
✅ It will create new directory for the new region under <code>/cd3user/tenancies/&lt;prefix&gt;/terraform_files</code> without modifying the existing ones <br>
27322732
✅ It will also commit the latest terraform_files folder to OCI DevOps GIT repo.</p>
27332733
</div>

v2025.2.0/delete-prefix/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2364,10 +2364,10 @@
23642364
<h1 id="delete-prefix-and-its-supporting-resources-in-oci"><strong>Delete prefix and its supporting resources in OCI</strong></h1>
23652365
<hr />
23662366
<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>
23682368
<p><br></p>
2369-
<p><span style="color: teal;"><b>Resources created with createTenancyConfig.py execution:</b></span></p>
2370-
<p>When executing createTenancyConfig.py during <a href="../connect-container-to-oci-tenancy"><u>Connect Container to OCI</u></a>, the following components are created:</p>
2369+
<p><span style="color: teal;"><b>Resources created with connectCloud.py execution:</b></span></p>
2370+
<p>When executing connectCloud.py during <a href="../connect-container-to-oci-tenancy"><u>Connect Container to OCI</u></a>, the following components are created:</p>
23712371
<ul>
23722372
<li>Config files under <code>/cd3user/tenancies/&lt;prefix&gt;</code> folder</li>
23732373
</ul>

v2025.2.0/faq/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2368,7 +2368,7 @@ <h1 id="frequently-asked-questions">Frequently Asked Questions</h1>
23682368
<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>
23692369
<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>
23702370
<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>
23722372
<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>
23732373
<br><br />
23742374
Check out <a href="../upgrade-toolkit"><u>Steps to Upgrade Your Toolkit</u></a></p>

v2025.2.0/group-tf-files/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2381,15 +2381,15 @@ <h1 id="grouping-set-of-resources-into-a-single-tf-state-file">Grouping set of r
23812381
<ul>
23822382
<li>Do not modify the OCI service Names specified on the left hand side.Modify the directory name specified on Right Hand Side only.</li>
23832383
<li>Directory will be created for that service under &lt;region&gt; directory. Do not provide absolute path.</li>
2384-
<li>To make any changes to the directory structure later, it is necessary to rerun the <code>createTenancyConfig.py</code> script from scratch.</li>
2384+
<li>To make any changes to the directory structure later, it is necessary to rerun the <code>connectCloud.py</code> script from scratch.</li>
23852385
<li>It is mandatory to specify the directory name for each service.</li>
23862386
</ul>
23872387
</div>
23882388
<p><img width="953" alt="image" src="../images/grouptf-2.png"></p>
23892389
<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 <a href="../greenfield-cli"><u>Greenfield workflow</u></a></p>
23902390
<ol>
23912391
<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/&lt;prefix&gt;/</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/&lt;prefix&gt;/</code> and configure a seperate directory for each service inside region folder subscribed to the tenancy.</p>
23932393
</li>
23942394
<li>
23952395
<p>Go to <code>/cd3user/tenancies/&lt;prefix&gt;/&lt;prefix&gt;_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
24182418
<img alt="image" src="../images/grouptf-5.png" /></p>
24192419
</li>
24202420
<li>
2421-
<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/&lt;prefix&gt;/</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/&lt;prefix&gt;/</code> and tfvars/state file for each service inside the region folder subscribed for the region.</p>
24222422
</li>
24232423
<li>
24242424
<p>Rest of the steps to run the toolkit remain the same.</p>

v2025.2.0/isv_jenkins/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2522,7 +2522,7 @@ <h2 id="connect-container-to-oci-tenancy">Connect container to OCI Tenancy</h2>
25222522
<ul>
25232523
<li>
25242524
<p>Initialise the environment to use the Automation Toolkit.
2525-
<div class="language-text highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>python createTenancyConfig.py connectOCI.properties
2525+
<div class="language-text highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>python connectCloud.py oci connectOCI.properties
25262526
</span></code></pre></div></p>
25272527
<div class="admonition note">
25282528
<p class="admonition-title">Note</p>

v2025.2.0/multiple-prefixes/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2367,7 +2367,7 @@ <h1 id="connect-container-to-oci-tenancy-multiple-prefixes"><strong>Connect cont
23672367
<div class="admonition note">
23682368
<p class="admonition-title">Multi-prefix with Jenkins</p>
23692369
<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>
23712371
</ul>
23722372
</div>
23732373
<p><br></p>
@@ -2381,13 +2381,13 @@ <h1 id="connect-container-to-oci-tenancy-multiple-prefixes"><strong>Connect cont
23812381
</ul>
23822382
<div class="admonition tip">
23832383
<p class="admonition-title">Tip</p>
2384-
<p>You can copy connectOCI.properties file as tenancyconfig_&lt;prefix&gt;.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_&lt;prefix&gt;.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>
23862386
</div>
23872387
<ul>
23882388
<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_&lt;prefix&gt;.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_&lt;prefix&gt;.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>
23912391
</ul>
23922392
<p><br></p>
23932393
<p><span style="color: teal; font-weight: bold;"> Multi Prefix with CLI</span></p>

v2025.2.0/remotestate/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2375,12 +2375,12 @@ <h1 id="store-terraform-state-into-object-storage-bucket">Store Terraform State
23752375
<p><br></p>
23762376
<ul>
23772377
<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>
23792379
<li>
23802380
<p>Upon setting above parameter the script will -</p>
23812381
<ul>
23822382
<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>
23842384
</ul>
23852385
</li>
23862386
<li>

0 commit comments

Comments
 (0)