Skip to content

Commit f12b026

Browse files
authored
docs: update doc (#126)
* docs: minor fixes * docs: customization doc * docs: update region rc project wording * chore: merge with main * docs: update to doc for auto-deploy capability in projects * docs: update to doc for auto-deploy capability in projects * docs: remove deprecated sections * docs: undeploy
1 parent 17c1d54 commit f12b026

File tree

4 files changed

+17
-44
lines changed

4 files changed

+17
-44
lines changed

README.md

Lines changed: 17 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,21 @@ You should be directed to a screen looking like:
7474
Note: in some rare occurences, the first member of the stack may not be marked as "Ready to validate". Refreshing the page in your browser window should solve this problem.
7575

7676
Two approaches to deploy the architecture:
77-
1. Through the UI
78-
2. Automated - `./deploy-many.sh` is provided.
77+
1. **Fully Automated End-to-End**. Recommended for demo or non-critical environments. This approach allows Project to validate, approve, and deploy all stack members automatically.
78+
2. **Member-by-Member**. Recommended for critical environments, such as production. This approach enables a detailed review of changes from each stack member before automation is executed, ensuring precise control over the deployment process.
7979

80-
### Approach 1: Deployment through the UI
80+
81+
### Approach 1: Fully Automated End-to-End
82+
83+
To enable auto-deployment:
84+
1. Go to **Manage** > **Settings** > **Auto-deploy** and toggle **On**.
85+
![auto-deploy](./images/15-auto-deploy.png)
86+
2. Return to the **Configurations** tab and click **Validate** under stack configuration.
87+
![validate button](./images/16-validate.png)
88+
89+
The project will then validate, approve, and deploy each stack member, taking approximately one hour to complete.
90+
91+
### Approach 2: Member-by-Member
8192

8293
1. Click on validate
8394

@@ -95,19 +106,6 @@ Two approaches to deploy the architecture:
95106

96107
5. Repeat step 1 for the next configuration in the architecture. Note that as you progress in deploying the initial base configuration, you will be given the option to validate and deploy multiple configuration in parallel.
97108

98-
### Approach 2: Run ./deploy-many.sh
99-
100-
* Clone the repository at https://github.com/terraform-ibm-modules/stack-retrieval-augmented-generation/tree/main
101-
* Ensure you are logged in to the account containing the Cloud project with the stack using `ibmcloud login`.
102-
* Execute `./deploy-many.sh` with the project name, stack name, and optional configuration name pattern.
103-
104-
Example - Process all configurations in the project:
105-
```bash
106-
./deploy-many.sh my-test-project dev
107-
```
108-
109-
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.
110-
111109
## 5. Post deployment steps
112110

113111
At this point, the infrastructure has been successfully deployed in the target account, and the initial build of the sample application has started in the newly-provisioned DevOps service.
@@ -139,18 +137,6 @@ After the application has been built and is running in Code Engine, there are ad
139137

140138
The deployable architecture can only be deployed with an API Key associated with a user. It is not compatible with API Keys associated with a serviceId. Additionally, it cannot be deployed using the Project trusted profile support.
141139

142-
### Known UI Issue: "Unable to validate your configuration"
143-
144-
After approving the configuration, you may encounter an error message stating "Unable to validate your configuration". This is a known UI issue that can be resolved by simply **refreshing your browser window**. This will allow you to continue with the deployment process.
145-
146-
### Using the ./deploy-many.sh Script
147-
148-
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:
149-
- Modify the stack definition in your project (beyond specifying inputs at the stack level)
150-
- Or, deploy the stack in an existing project
151-
152-
Use the **Project UI** to deploy; do not use the script.
153-
154140
### Notification of New Configuration Versions ("Needs Attention")
155141

156142
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.
@@ -252,22 +238,9 @@ Those resources are not destroyed automatically as part of undeploying the stack
252238

253239
### 2. Undeploy Configurations in the Project
254240

255-
Undeploy each configuration in the project, one by one, via UI, starting from the "6 - Sample RAG app configuration" and working your way up in the stack up to, and inclusive of "2a - Security Service - Key Management". Wait for full undeployment of a configuration before starting to undeploy the next configuration up in the stack.
256-
257-
### 3. Delete Reclamation Claims
258-
259-
Before undeploying the "1 - Account Infrastructure Base", you will need to manually delete the reclamation claims for the resources deleted from the previous steps. Reclamation allows you to restore deleted resources for up to one week. However, any reclamation that is still active prevents from deleting the resource group managed by the "1 - Account Infrastructure Base":
260-
* Log in to the target IBM Cloud account with the CLI
261-
* Run `ibmcloud resource reclamations` to view the full list of reclamation. You may identify the exact reclamations to delete as they are planned to be deleted in one week after the date for which the resource was deleted.
262-
* For each reclamation, execute `ibmcloud resource reclamation-delete <reclamation-id>`. The reclamation-id is the id provided in the results from ibmcloud resource reclamations listing.
263-
* Run `ibmcloud resource reclamations` again to ensure the reclamations have been fully deleted
264-
265-
More details are available [here](https://cloud.ibm.com/docs/account?topic=account-resource-reclamation&interface=cli).
266-
267-
### 4. Undeploy "1 - Account Infrastructure Base"
268-
269-
You may now undeploy "1 - Account Infrastructure Base" in the project.
241+
Select "Undeploy" option in the menu associated with the stack in the project.
242+
![undeploy](./images/17-undeploy.png)
270243

271-
### 5. Delete Project
244+
### 3. Delete Project
272245

273246
Once all configurations are undeployed, you may delete the project.

images/15-auto-deploy.png

40.1 KB
Loading

images/16-validate.png

72.2 KB
Loading

images/17-undeploy.png

26.8 KB
Loading

0 commit comments

Comments
 (0)