Skip to content

Commit

Permalink
Merge pull request #10 from oracle-quickstart/doc-update
Browse files Browse the repository at this point in the history
doc: RMS screenshot and save output requirements
  • Loading branch information
andrecorreaneto authored Apr 19, 2024
2 parents de257ed + b87c333 commit b6c261a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,19 @@ Follow these steps for deploying with RMS:
3. Set *Working directory* to "terraform-oci-landing-zones-orchestrator/rms-facade".
4. Give the stack a name in the *Name* field.
5. Set *Terraform version* to 1.2.x. Click *Next*.
6. Configure the input variables:
6. Configure the input variables (see [image below](#rms-stack-input-variables) for an example):
1. Select the deployment *Region* (IAM resources are always automatically deployed in the home region).
2. Select the *Configuration Source*. Each source has distinct input fields, but all of them have *Configuration Files* (Required) and *Dependency Files* (Optional).
3. Select *Save Output?* option for saving the stack output. Optionally provide a prefix to the to-be-saved file. This file can be subsequently referred as a dependency in *Dependency Files* in another stack.
2. Select the *Configuration Source*. Each source has distinct input fields, but all of them have *Configuration Files* (Required) and *Dependency Files* (Optional). The example shows GitHub as the *Configuration Source*, with two configuration files and two dependency files.
3. Select *Save Output?* option for saving the stack output. Optionally provide a prefix to the to-be-saved file. This file can be subsequently referred as a dependency in *Dependency Files* in another stack. The example saves the output to *customers/customer1/output* folder in the GitHub repository.
4. Click *Next*.
8. Uncheck *Run apply* option at the bottom of the screen. Click *Create*.
9. Click the *Plan* button.
10. Upon a successfully created plan, click the *Apply* button and pick the created plan in the *Apply job plan resolution* drop down.

<a name="rms-stack-input-variables">Input variables example:</a>

![rms-stack-input-variables](images/rms-stack-input-variables.png)

### Using Terraform CLI

In this folder, execute the typical Terraform workflow: *terraform init/plan/apply*.
Expand Down
Binary file added images/rms-stack-input-variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions rms-facade/schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ variables:
oci_object_prefix:
type: string
title: "OCI Object Prefix"
description : "The OCI object prefix. Use this to organize the output and avoid overwriting when you run multiple instances of this stack. A generated object name is appended to the provided prefix, like oci_object_prefix/object_name."
description : "The OCI object prefix. Use this to organize the output and avoid overwriting when you run multiple instances of this stack. A generated object name is appended to the provided prefix, like oci_object_prefix/object_name. The executing user must also have write permissions on the bucket."
visible:
and:
- ${save_output}
Expand All @@ -201,7 +201,7 @@ variables:
github_file_prefix:
type: string
title: "GitHub File Prefix"
description : "The GitHub file prefix. Use this to organize the output and avoid overwriting when you run multiple instances of this stack. A generated file name is appended to the provided prefix, like github_file_prefix/file_name."
description : "The GitHub file prefix. Use this to organize the output and avoid overwriting when you run multiple instances of this stack. A generated file name is appended to the provided prefix, like github_file_prefix/file_name. The GitHub token must also have write permissions on the repository."
visible:
and:
- ${save_output}
Expand Down

0 comments on commit b6c261a

Please sign in to comment.