Skip to content

Commit a652608

Browse files
authored
docs: Update doc (#91)
* docs: minor fixes * docs: customization doc
1 parent 53f72fb commit a652608

13 files changed

+74
-10
lines changed

README.md

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,25 @@ Ensure that you are familiar with the "Important Deployment Considerations" loca
3939

4040
![image](./images/min/1-catalog.png)
4141

42-
* Select "Create new" and input IBM Cloud Project details.
43-
- Name and description. eg: "Retrieval Augmented Generation Pattern"
44-
- Region and resource group for the project. Note that this is the region and resource group where the runtime (IBM Cloud Schematics) executiong the automation code is located. You can still deploy the resources to any region, any resource group, and any account.
45-
- Configuration name - for example: "dev" or "prod".
42+
* Select **Create new** and enter the following details:
43+
- Name and Description (e.g., "Retrieval Augmented Generation Pattern")
44+
- Region and Resource Group for the project (central hub for IaC automation, where code is run, with separate deployment options for provisioned infrastructure later)
45+
- Configuration Name (name of the automation in the project, e.g., "dev" or "prod", ideally matching the deployment target, but this can be any name)
4646

4747
![project](./images/min/2-project.png)
4848

49-
* Click "Add" to complete.
49+
* Click the **Add** button (or **Create** if this is the first project in the account) at the bottom right of the modal popup to complete.
5050

5151
## 3. Set the Input Configuration for the Stack
5252

5353
After completing `Step 2 - Deploy the Stack in a New Project from Catalog`, you are directed to a page allowing you to enter the configuration for you deployment:
5454
* Under Security -> Authentication, enter the API Key from the prereqs in the `api_key` field.
55-
* Under Required, input the signing key
56-
* Under Optional, input `signing_key` field. This is recommended by not necessary to be able to deploy the Cloud resources. It is necessary to enable the building and deployment of the sample app however.
55+
![inputs](./images/min/3-inputs.png)
56+
* Under Required, input a prefix. This prefix will be appended to the name of most resources created by automation, ensuring uniqueness and avoiding clashes when provisioning names in the same account.
57+
* Under Optional, input the signing_key field. While not necessary for deploying Cloud resources, it is recommended and required to enable the building and deployment of the sample app.
5758

5859
You may explore the other available inputs, such as the region and resource group name (under optional tab), leave them as is, or modify them as needed.
5960

60-
![inputs](./images/min/3-inputs.png)
61-
6261
Once ready, click the "Save" button at the top of the screen.
6362

6463
## 4. Deploy the Architecture
@@ -144,4 +143,69 @@ After approving the configuration, you may encounter an error message stating "U
144143

145144
### Using the ./deploy-many.sh Script
146145

147-
The provided ./deploy-many.sh script is designed to deploy the stack of configurations as provided out of the box. If you make any changes to the stack definition in your project, besides specifying inputs, you should deploy your version through the Project UI instead of using the script.
146+
The provided `deploy-many.sh` script is designed to deploy the stack of configurations as provided out of the box, and when following the instructions in this page. However, if you:
147+
- Modify the stack definition in your project (beyond specifying inputs at the stack level)
148+
- Or, deploy the stack in an existing project
149+
150+
Use the **Project UI** to deploy; do not use the script.
151+
152+
### Notification of New Configuration Versions ("Needs Attention")
153+
154+
You may see notifications in IBM Cloud Project indicating that one or more configurations in the stack have new versions available. You can safely ignore these messages at this point, as they will not prevent you from deploying the stack. No specific action is required from you.
155+
156+
![new version](./images/min/10-new-version.png)
157+
158+
Please note that these notifications are expected, as we are rapidly iterating on the development of the underlying components. As new stack versions become available, the versions of the underlying components will also be updated accordingly.
159+
160+
161+
# Customization options
162+
163+
There are numerous customization possibilities available out of the box. This section explores some common scenarios, but is not exhaustive.
164+
165+
## Editing Individual Configurations
166+
167+
Each configuration in the deployed stack surfaces a large number of input parameters. You can directly edit each parameter to tailor your deployment by selecting the **Edit** option in the menu for the corresponding configuration on the right-hand side.
168+
169+
![edit config](./images/min/11-edit-config.png)
170+
171+
This approach enables you to:
172+
- Fine-tune account settings
173+
- Deploying additional Watson components, such as Watsonx Governance
174+
- Deploy to an existing resource group
175+
- Reuse existing key protect keys
176+
- Tuning the parameter of the provisioned code engine project
177+
- ...
178+
179+
## Removing Configurations from the Stack
180+
181+
You can remove any configuration from the stack, provided there is no direct dependency in later configurations, by selecting the **Remove from Stack** option in the right-hand side menu for the corresponding configuration.
182+
183+
This applies to the following configurations:
184+
- Observability
185+
- Security and Control Center
186+
187+
![edit config](./images/min/12-remove-config.png)
188+
189+
## Managing Stack-Level Inputs and Outputs
190+
191+
You can add or remove inputs and outputs surfaced at the stack level by following these steps:
192+
1. Select the stack configuration
193+
194+
![stack def](./images/min/13-define-stack.png)
195+
1. You are presented with a screen allowing you to promote any of the configuration inputs or outputs at the stack level
196+
197+
![stack def](./images/min/14-stack-def.png)
198+
199+
200+
## Sharing Modified Stacks through a Private IBM Cloud Catalog
201+
202+
Once you have made modifications to your stack in Project, you can share it with others through a private IBM Cloud Catalog. To do so, follow these steps:
203+
1. Deploy the stack at least once: You need to deploy the stack first to allow importing the stack definition to a private catalog.
204+
2. Select the "Add to private catalog" option in the menu located on the stack configuration.
205+
206+
This will allow you to share your modified stack with others through a private IBM Cloud Catalog.
207+
208+
209+
## Customizing for Your Application
210+
211+
As you deploy your own application, you may want to remove the last configuration (Sample RAG app configuration), which is specific to the sample app provided out of the box. You can use the code of this sample automation as a guide to implement your own, depending on your application needs. The code is available at [https://github.com/terraform-ibm-modules/terraform-ibm-rag-sample-da](https://github.com/terraform-ibm-modules/terraform-ibm-rag-sample-da).

images/10-new-version.png

48.7 KB
Loading

images/11-edit-config.png

57.3 KB
Loading

images/12-remove-config.png

58.3 KB
Loading

images/13-define-stack.png

51.9 KB
Loading

images/14-stack-def.png

71.8 KB
Loading

images/min/1-catalog.png

0 Bytes
Loading

images/min/1-catalog.png~

66.1 KB
Binary file not shown.

images/min/10-new-version.png

84 KB
Loading

images/min/11-edit-config.png

63.5 KB
Loading

0 commit comments

Comments
 (0)