Skip to content

Commit 16d1074

Browse files
authored
Update setup-the-toolkit.md
1 parent c1d5aef commit 16d1074

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

cd3-automation-toolkit/setup-the-toolkit/setup-the-toolkit.md

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ Make sure the [prerequisites](#prerequisites) are met before proceeding.
108108

109109
- Paste the contents of the **PEM public key** in the dialog box and click **Add**.
110110

111-
3. Open *tenancyconfig.properties* file and fill the details in **Required parameters** and **Auth Details Parameters** sections.
111+
3. Navigate to ```/cd3user/oci_tools/cd3_automation_toolkit/user-scripts/```
112+
4. Edit ```tenancyconfig.properties``` file and fill the details in **Required parameters** and **Auth Details Parameters** sections.
112113

113114
Below are the sample values for **API_Key Auth mechanism**.
114115

@@ -147,26 +148,71 @@ Make sure the [prerequisites](#prerequisites) are met before proceeding.
147148
>**Note:** If you selected Instance Principal or session token method for authentication, follow the commented guidelines in the *tenancyconfig.properties* file or [Auth Mechanisms documentation](https://github.com/oracle-devrel/cd3-automation-toolkit) and proceed accordingly.
148149

149150

150-
4. Under **Deployment Parameters** section in tenancyconfig.properties file, Leave the default value for **outdir structure file** parameter to group your generated terraform auto.tfvars files for each service.
151+
5. Under **Deployment Parameters** section in ```tenancyconfig.properties``` file, Leave the default value for **outdir structure file** parameter to group your generated terraform auto.tfvars files for each service.
151152

152153
>**Note:** To place all the generated terraform auto.tfvars files directly under the region folder, comment the parameter with the default outdirectory structure file path and uncomment the one above it.
153154

154155

155-
5. Under **Advanced parameters for DevOps** section in tenancyconfig.properties file set the parameter ```use_oci_devops_git=yes``` to use the toolkit with **Jenkins**.
156+
6. Under **Advanced parameters for DevOps** section in tenancyconfig.properties file set the parameter ```use_oci_devops_git=yes``` to use the toolkit with **Jenkins**.
156157

157158
>**Note:** If you plan to use the toolkit with CLI, skip this section. Since we are using API-key Auth mechanism, the **User details** section can be skipped.
158159

159-
6. **Initialise** your environment to use the Automation Toolkit.
160+
7. **Initialise** your environment to use the Automation Toolkit.
160161

161162
```bash
162163
python createTenancyConfig.py tenancyconfig.properties
163164
```
164165

165-
7. You should see an output similar to below:
166+
8. You should see an output similar to below:
166167

167-
![tenancyconfigoutput](./images/tenancyconfigoutput.png)
168+
```
169+
[cd3user@109c63ee4ec0 user-scripts]$ python createTenancyConfig.py tenancyconfig.properties
170+
=================================================================
171+
NOTE: Make sure the API Public Key is added to the OCI Console!!!
172+
=================================================================
168173
169-
8. After the createTenancyConfig.py script is successfully executed, customer specific files are created under ```/cd3user/tenancies/<customer_name>```.
174+
Using different directories for OCI services as per the input outdir_structure_file..........
175+
176+
Copying Private Key File..........
177+
178+
Creating Tenancy specific config.................
179+
Updated OCI_Regions file !!!
180+
181+
182+
Creating Tenancy specific remote tfstate Items - bucket, S3 credentials.................
183+
Creating new customer secret key
184+
185+
Creating Tenancy specific setUpOCI.properties.................
186+
Creating Tenancy specific region directories, terraform provider , variables files.................
187+
188+
Creating Tenancy specific DevOps Items - Topic, Project and Repository.................
189+
190+
The toolkit has been setup successfully. !!!
191+
192+
Customer Specific Working Directory Path: /cd3user/tenancies/rg-sep
193+
194+
Remote State Bucket Name: rg-sep-automation-toolkit-bucket in us-sanjose-1.
195+
Common Jenkins Home: /cd3user/tenancies/jenkins_home
196+
DevOps Project Name and Repo Name: rg-sep-automation-toolkit-project, rg-sep-automation-toolkit-repo in us-sanjose-1.
197+
Folder configured for OCI DevOps GIT: /cd3user/tenancies/rg-sep/terraform_files/ Initial Commit ID from createTenancyConfig.py: df73e44
198+
199+
#########################################
200+
Next Steps for using toolkit via Jenkins
201+
#########################################
202+
Start Jenkins using - /usr/share/jenkins/jenkins.sh &
203+
Access Jenkins using - https://<IP Address of the machine hosting docker container>:8443
204+
205+
######################################
206+
Next Steps for using toolkit via CLI
207+
######################################
208+
Modify /cd3user/tenancies/rg-sep/rg-sep_setUpOCI.properties with input values for cd3file and workflow_type
209+
cd /cd3user/oci_tools/cd3_automation_toolkit/
210+
python setUpOCI.py /cd3user/tenancies/rg-sep/rg-sep_setUpOCI.properties
211+
==================================================================================================================================
212+
```
213+
214+
215+
10. After the createTenancyConfig.py script is successfully executed, customer specific files are created under ```/cd3user/tenancies/prefix```.
170216

171217
In this lab, we have learnt how to **setup CD3 toolkit container** and **connect** it to OCI tenancy.
172218

0 commit comments

Comments
 (0)