Skip to content

Commit

Permalink
docs: minor fixes (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
vburckhardt authored May 8, 2024
1 parent b9eb876 commit 90ad610
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 23 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,23 +95,13 @@ Two approaches to deploy the architecture:

* Clone the repository at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/tree/main
* Ensure you are logged in to the account containing the Cloud project with the stack using `ibmcloud login`.
* Execute `./deploy-many.sh` with the project name, stack name, and optional configuration name pattern. The selected non-stack configurations will be processed by their name in alphabetical order. Using the configuration name pattern (regex can be used - make sure to enclose it in quotes), you can choose which configurations are deployed.
* Execute `./deploy-many.sh` with the project name, stack name, and optional configuration name pattern.

Example 1 - Update stack inputs for stack configuration `dev` and process all non-stack configurations in the project:
Example - Process all configurations in the project:
```bash
./deploy-many.sh my-test-project dev
```

Example 2 - Update stack inputs and process some configurations in the project:
```bash
./deploy-many.sh my-test-project dev 'RAG-1|RAG-4|RAG-5'
```

Example 3 - Simulate updating stack inputs and validating some configurations in the project in dry-run mode (no changes or actual validation or deployments are done):
```bash
DRY_RUN=true ./deploy-many.sh my-test-project dev 'RAG-1|RAG-4|RAG-5'
```

Tips: If deployment fail for one of the configuration, you may re-run the script as is. It will skip existing installed configurations and continue where it last failed.

## 5. Post deployment steps
Expand Down
10 changes: 0 additions & 10 deletions deploy-many.sh
Original file line number Diff line number Diff line change
Expand Up @@ -149,16 +149,6 @@ function validate_and_deploy()

parse_params "$@"
get_config_ids
set_stack_inputs

# Loop through the configuration IDs and execute the functions
# for CONFIG_ID in "${CONFIG_IDS[@]}"
# do
# validate_and_deploy
# done


####

# Run base config + key management first
for CONFIG_ID in "${CONFIG_IDS[@]:0:2}"; do
Expand Down
2 changes: 1 addition & 1 deletion ibm_catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
"type": "password",
"description": "The key used to sign the application image built by the CI pipeline deployed in this solution; please refer to the documentation at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/blob/main/README.md for generating the key; if not set, all resources will deploy successfully, but the initial CI pipeline execution will fail at the signing step.",
"display_name": "Multiline secure value",
"default_value": "",
"default_value": "replace",
"required": false,
"custom_config": {
"type": "multiline_secure_value",
Expand Down

0 comments on commit 90ad610

Please sign in to comment.