Skip to content

Commit 366e578

Browse files
docs: Update README.md (#47)
1 parent 584b73c commit 366e578

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,21 @@ Click the "Add to project" button, and select create in new project.
1313
Before deploying the stack, ensure you have:
1414
- Created an API key in the target account with sufficient permissions. Note the API key, as it will be used later.
1515
- For now, grant it admin privileges. The exact permissions required will be refined in future versions.
16+
- Install the IBM Cloud CLI's Project addon using `ibmcloud plugin install project` command. More info here: https://cloud.ibm.com/docs/cli?topic=cli-projects-cli
1617

1718

1819
## 3. Set the input configuration for the stack
1920

20-
- Clone this repository locally - and checkout the dev branch.
21+
- Clone this repository locally.
2122
- Create a file with name ".def.json" with the following content.
22-
- The signing key is the base64 key obtained from the `gpg --export-secret-key <Email Address> | base64` command. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-devsecops-image-signing#cd-devsecops-gpg-export for details.
2323

2424
**Important**:
2525
- Ensure region is either us-south or eu-de as watsonx can only be deployed in those 2 locations for now.
2626
- Ensure that the prefix is globally unique. It is used for the container registry namespace (which needs to be globally unique) in this alpha version.
27+
- The signing key is the base64 key obtained from the `gpg --export-secret-key <Email Address> | base64` command. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-devsecops-image-signing#cd-devsecops-gpg-export for details.
2728
- If specifying `existing_secrets_manager_crn`, the ibmcloud_api_key that is passed as an input must have the documented read and write access to the instance
2829
- If specifying `existing_secrets_manager_crn`, ensure that the default security group does not contain secrets named `signing-key` and `ibmcloud-api-key` . The RAG DA currently always attempt to create secret with those names (temporary issue - to be fixed).
29-
30+
3031
```json
3132
{
3233
"inputs": {
@@ -76,7 +77,7 @@ Example 2 - update stack inputs and process some configurations in the project:
7677
./deploy-many.sh my-test-project RAG 'RAG-1|RAG-4|RAG-5'
7778
```
7879

79-
Example 2 - simulate updating stack inputs and validating some configurations in the project in dry-run mode (no changes or actual validation or deployments is done):
80+
Example 3 - simulate updating stack inputs and validating some configurations in the project in dry-run mode (no changes or actual validation or deployments is done):
8081
```bash
8182
DRY_RUN=true ./deploy-many.sh my-test-project RAG 'RAG-1|RAG-4|RAG-5'
8283
```

0 commit comments

Comments
 (0)