Skip to content

Commit 90ad610

Browse files
authored
docs: minor fixes (#72)
1 parent b9eb876 commit 90ad610

File tree

3 files changed

+3
-23
lines changed

3 files changed

+3
-23
lines changed

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,23 +95,13 @@ Two approaches to deploy the architecture:
9595

9696
* Clone the repository at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/tree/main
9797
* Ensure you are logged in to the account containing the Cloud project with the stack using `ibmcloud login`.
98-
* 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.
98+
* Execute `./deploy-many.sh` with the project name, stack name, and optional configuration name pattern.
9999

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

105-
Example 2 - Update stack inputs and process some configurations in the project:
106-
```bash
107-
./deploy-many.sh my-test-project dev 'RAG-1|RAG-4|RAG-5'
108-
```
109-
110-
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):
111-
```bash
112-
DRY_RUN=true ./deploy-many.sh my-test-project dev 'RAG-1|RAG-4|RAG-5'
113-
```
114-
115105
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.
116106

117107
## 5. Post deployment steps

deploy-many.sh

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -149,16 +149,6 @@ function validate_and_deploy()
149149

150150
parse_params "$@"
151151
get_config_ids
152-
set_stack_inputs
153-
154-
# Loop through the configuration IDs and execute the functions
155-
# for CONFIG_ID in "${CONFIG_IDS[@]}"
156-
# do
157-
# validate_and_deploy
158-
# done
159-
160-
161-
####
162152

163153
# Run base config + key management first
164154
for CONFIG_ID in "${CONFIG_IDS[@]:0:2}"; do

ibm_catalog.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
"type": "password",
166166
"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.",
167167
"display_name": "Multiline secure value",
168-
"default_value": "",
168+
"default_value": "replace",
169169
"required": false,
170170
"custom_config": {
171171
"type": "multiline_secure_value",

0 commit comments

Comments
 (0)