Skip to content

Commit 051f671

Browse files
committed
Deployed c0812c8 to v2024.3.0 with MkDocs 1.5.3 and mike 2.1.1
1 parent 0962fb2 commit 051f671

File tree

6 files changed

+108
-118
lines changed

6 files changed

+108
-118
lines changed

v2024.3.0/connect-container-to-oci-tenancy/index.html

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2149,8 +2149,8 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
21492149
<div class="admonition note">
21502150
<p class="admonition-title">Note</p>
21512151
<ul>
2152-
<li>With the toolkit release v2024.1.0, the toolkit supports only a single <strong>prefix</strong> per container when using Jenkins.</li>
2153-
<li>When a new region is subscribed to the tenancy, rerun createTenancyConfig.py by using the same tenancyconfig.properties file that was originally used. It will create new directory for the new region under <code>/cd3user/tenancies/&lt;prefix&gt;/terraform_files</code> without touching the existing ones and will commit the latest terraform_files folder to DevOps GIT repo.</li>
2152+
<li>With the toolkit release v2024.1.0, the toolkit supports only a single <strong>customer_name</strong> per container when using Jenkins.</li>
2153+
<li>When a new region is subscribed to the tenancy, rerun createTenancyConfig.py by using the same tenancyconfig.properties file that was originally used. It will create new directory for the new region under <code>/cd3user/tenancies/&lt;customer_name&gt;/terraform_files</code> without touching the existing ones and will commit the latest terraform_files folder to DevOps GIT repo.</li>
21542154
</ul>
21552155
</div>
21562156
<p><strong>Step 1 - Login (Exec) into the Container</strong>:</p>
@@ -2182,7 +2182,7 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
21822182
<th>Example</th>
21832183
</tr>
21842184
<tr>
2185-
<td>prefix</td>
2185+
<td>customer_name</td>
21862186
<td>Friendly name for the Customer Tenancy</td>
21872187
<td>demo</td>
21882188
</tr>
@@ -2221,17 +2221,10 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
22212221
<td>The outdir_structure_file defines the grouping of the terraform auto.tf.vars for the various generated resources.To group resources into different directories within each region - specify the absolute path to the file.To have all the files generated in a single directory in the corresponding region, leave this variable blank.</td>
22222222
<td>Defaults to /cd3user/oci_tools/cd3_automation_toolkit/user-scripts/outdir_structure_file.properties</td>
22232223
</tr>
2224-
2225-
<tr>
2226-
<td>tf_or_tofu</td>
2227-
<td>IaC Tool to be configured - Terraform or OpenTofu</td>
2228-
<td>terraform</td>
2229-
</tr>
2230-
<tr>
22312224
<tr>
22322225
<td>ssh_public_key</td>
22332226
<td>SSH Key for launched instances; Use '\n' as the delimiter to add multiple ssh keys.</td>
2234-
<td>ssh-rsa AAXXX......yhdlo\nssh-rsa AAxxskj...edfwf</td>
2227+
<td>"ssh-rsa AAXXX......yhdlo\nssh-rsa AAxxskj...edfwf"</td>
22352228
</tr>
22362229
</table>
22372230
</details>
@@ -2256,7 +2249,7 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
22562249
</tr>
22572250
<tr>
22582251
<td>remote_state_bucket_name</td>
2259-
<td>Specify bucket name if you want to use existing bucket else leave empty.If left empty, Bucket with name ${prefix}-automation-toolkit-bucket will be created/reused in ${region}.</td>
2252+
<td>Specify bucket name if you want to use existing bucket else leave empty.If left empty, Bucket with name ${customer_name}-automation-toolkit-bucket will be created/reused in ${region}.</td>
22602253
<td>demo_bucket</td>
22612254
</tr>
22622255
<tr>
@@ -2266,7 +2259,7 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
22662259
</tr>
22672260
<tr>
22682261
<td>oci_devops_git_repo_name</td>
2269-
<td>Specify Repo name if you want to use existing OCI Devops GIT Repository else leave empty Format: <project_name/repo_name\>. If left empty, DevOps items with names <b>${prefix}-automation-toolkit-project/repo/topic</b> will be created/reused in ${region}.</td>
2262+
<td>Specify Repo name if you want to use existing OCI Devops GIT Repository else leave empty Format: <project_name/repo_name\>. If left empty, DevOps items with names <b>${customer_name}-automation-toolkit-project/repo/topic</b> will be created/reused in ${region}.</td>
22702263
<td>demo_repo</td>
22712264
</tr>
22722265
<tr>
@@ -2280,7 +2273,7 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
22802273
</tr>
22812274
<tr>
22822275
<td>oci_devops_git_key</td>
2283-
<td>When left empty, same key file from $(key_path) used for $(auth_mechanism) as api_key will be copied to <b>/cd3user/tenancies/&lt;prefix&gt;/</b> and used for GIT Operations. Make sure the api key file permissions are rw(600) for cd3user</td>
2276+
<td>When left empty, same key file from $(key_path) used for $(auth_mechanism) as api_key will be copied to <b>/cd3user/tenancies/&lt;customer_name&gt;/</b> and used for GIT Operations. Make sure the api key file permissions are rw(600) for cd3user</td>
22842277
<td>/cd3user/tenancies/keys/oci_api_private.pem</td>
22852278
</tr>
22862279
</table>
@@ -2292,7 +2285,6 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
22922285
<p class="admonition-title">Important</p>
22932286
<ul>
22942287
<li>Have the details ready for Authentication mechanism you are planning to use.<br></li>
2295-
<li>Choose whether the outdir needs to be configured with OpenTofu or Terraform. Its a one time selection for that prefix and cannot be modified later.<br></li>
22962288
<li>Review <strong>outdir_structure_file</strong> parameter as per requirements. It is recommended to use separate outdir structure to manage a large number of resources. <br></li>
22972289
<li>Review Advanced Parameters Section for CI/CD setup. <strong>The toolkit can be used either with CLI or with Jenkins.</strong> If you plan to use the toolkit with Jenkins then be ready with user details that will be used to connect to DevOps Repo in OCI. Specifying these parameters as <strong>'yes'</strong> in properties file will create Object Storage Bucket and Devops Git Repo/Project/Topic in OCI and enable toolkit usage with Jenkins. The toolkit supports users in primary IDCS stripes or default domains only for DevOps GIT operations.<br></li>
22982290
</ul>
@@ -2327,49 +2319,49 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
23272319
</tr>
23282320
<tr>
23292321
<td>setUpOCI.properties</td>
2330-
<td>/cd3user/tenancies/&lt;prefix&gt;/&lt;prefix>_setUpOCI.properties</td>
2322+
<td>/cd3user/tenancies/&lt;customer_name&gt;/&lt;customer_name>_setUpOCI.properties</td>
23312323
<td>Customer Specific properties</td>
23322324
</tr>
23332325
<tr>
23342326
<td>outdir_structure_file.properties</td>
2335-
<td>/cd3user/tenancies/&lt;prefix&gt;/&lt;prefix&gt;_outdir_structure_file</td>
2327+
<td>/cd3user/tenancies/&lt;customer_name&gt;/&lt;customer_name&gt;_outdir_structure_file</td>
23362328
<td>Customer Specific properties file for outdir structure.
23372329
This file will not be generated if 'outdir_structure_file' parameter was set to empty(single outdir)in tenancyconfig.properties while running createTenancyConfig.py</td>
23382330
</tr>
23392331
<tr>
23402332
<td>Region based directories</td>
2341-
<td>/cd3user/tenancies/&lt;prefix&gt;/terraform_files</td>
2333+
<td>/cd3user/tenancies/&lt;customer_name&gt;/terraform_files</td>
23422334
<td>Tenancy's subscribed regions based directories for the generation of terraform files.
23432335
Each region directorywill contain individual directory for each service based on the parameter 'outdir_structure_file'</td>
23442336
</tr>
23452337
<tr>
23462338
<td>Variables File,Provider File, Root and Sub terraform modules</td>
2347-
<td>/cd3user/tenancies/&lt;prefix&gt;/terraform_files/&lt;region></td>
2339+
<td>/cd3user/tenancies/&lt;customer_name&gt;/terraform_files/&lt;region></td>
23482340
<td>Required for terraform to work. Variables file and Provider file willbe genrated based on authentication mechanism chosen.</td>
23492341
</tr>
23502342
<tr>
23512343
<td>out file</td>
2352-
<td>/cd3user/tenancies/&lt;prefix&gt;/createTenancyConfig.out</td>
2344+
<td>/cd3user/tenancies/&lt;customer_name&gt;/createTenancyConfig.out</td>
23532345
<td>This file contains acopy of information displayed as the console output.</td>
23542346
</tr>
23552347
<tr>
23562348
<td>OCI Config File</td>
2357-
<td>/cd3user/tenancies/&lt;prefix&gt;/.config_files/&lt;prefix&gt;_oci_config</td>
2349+
<td>/cd3user/tenancies/&lt;customer_name&gt;/.config_files/&lt;customer_name&gt;_oci_config</td>
23582350
<td>Customer specific Config file for OCI API calls. This will havedata based on authentication mechanism chosen.</td>
23592351
</tr>
23602352
<tr>
23612353
<td>Public and Private Key Pair</td>
2362-
<td>Copied from /cd3user/tenancies/keys/ to /cd3usertenancies/&lt;prefix&gt;/.config_files</td>
2354+
<td>Copied from /cd3user/tenancies/keys/ to /cd3usertenancies/&lt;customer_name&gt;/.config_files</td>
23632355
<td>API Key for authentication mechanism as API_Key arecopied to customer specific out directory locations for easy access.</td>
23642356
</tr>
23652357
<tr>
23662358
<td>GIT Config File</td>
2367-
<td>/cd3user/tenancies/&lt;prefix&gt;/.config_files/&lt;prefix&gt;_git_config</td>
2359+
<td>/cd3user/tenancies/&lt;customer_name&gt;/.config_files/&lt;customer_name&gt;_git_config</td>
23682360
<td>Customer specific GIT Config file for OCI Dev Ops GIT operations.This is generated only if use_oci_devops_git is set to yes</td>
23692361
</tr>
23702362
<tr>
23712363
<td>S3 Credentials File</td>
2372-
<td>/cd3user/tenancies/&lt;prefix&gt;/.config_files/&lt;prefix&gt;_s3_credentials</td>
2364+
<td>/cd3user/tenancies/&lt;customer_name&gt;/.config_files/&lt;customer_name&gt;_s3_credentials</td>
23732365
<td>This file contains access key and secret for S3 compatible OSbucket to manage remote terraform state. This is generated only if use_remote_state is set to yes</td>
23742366
</tr>
23752367
<tr>
@@ -2379,7 +2371,7 @@ <h1 id="connect-container-to-oci-tenancy"><strong>Connect container to OCI Tenan
23792371
</tr>
23802372
<tr>
23812373
<td>tenancyconfig.properties</td>
2382-
<td>/cd3user/tenancies/&lt;prefix&gt;/.config_files/&lt;prefix&gt;_tenancyconfig.properties</td>
2374+
<td>/cd3user/tenancies/&lt;customer_name&gt;/.config_files/&lt;customer_name&gt;_tenancyconfig.properties</td>
23832375
<td>The input properties file used to execute the script is copied to custome folder to retain for future reference. This can be used when the script needs tobe re-run with same parameters at later stage.</td>
23842376
</tr>
23852377

v2024.3.0/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)