Skip to content

Commit a0d63d6

Browse files
Shikha MaheshwariShikha Maheshwari
authored andcommitted
add DA prefix doc
1 parent 329970c commit a0d63d6

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ You can see the published documentation at https://terraform-ibm-modules.github.
2121
- Maintaining the GitHub project
2222
- [Maintainers contribution process](https://terraform-ibm-modules.github.io/documentation/#/maintain-module.md)
2323
- [About merging pull requests](https://terraform-ibm-modules.github.io/documentation/#/merging.md)
24+
- Deployable Architecture Reference Docs
25+
- [Prefix Usage Guide](https://terraform-ibm-modules.github.io/documentation/#/DA-prefix.md)
2426
- Reference
2527
- [Module authoring guidelines](https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines.md)
2628
- [Design guidelines](https://terraform-ibm-modules.github.io/documentation/#/design-guidelines.md)

docs/DA-prefix.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Prefix in Deployable Architecture
2+
3+
The **`prefix`** input variable allows you to prepend a custom string to the names of all resources created by this automation. This is especially useful for:
4+
5+
- **Avoiding naming collisions** when deploying the same solution multiple times within the same account.
6+
- **Creating identical infrastructure** across multiple regions or environments.
7+
- **Improving resource traceability** by embedding environment or region identifiers into resource names.
8+
9+
If you do not wish to use a prefix, you may set the value to `null` or an empty string (`""`).
10+
11+
**Important**: The automation automatically inserts a hyphen between the prefix and the resource name. Therefore, you do not need to include a hyphen in the prefix yourself.
12+
13+
### Examples
14+
15+
Here are some common patterns for using the prefix:
16+
17+
- **Environment-based**:
18+
- `dev`, `test`, `prod`
19+
- **Environment + Region**:
20+
- `dev-eu-gb`, `prod-us-south`, `test-jp-tok`
21+
- **Project-specific**:
22+
- `webapp-dev`, `ml-prod`, `iot-test`
23+
- **Team or department identifiers**:
24+
- `fin-dev`, `hr-prod`, `eng-test`
25+
- **Date or version-based** (for temporary or experimental deployments):
26+
- `exp-202505`, `v2-dev`
27+
28+
These conventions help ensure that resources are clearly grouped and easily identifiable, especially in shared or multi-tenant accounts.
29+
30+
### Naming Rules
31+
32+
To ensure compatibility and consistency, the prefix must follow these rules:
33+
34+
- Must begin with a **lowercase letter**
35+
- May contain only **lowercase letters**, **digits**, and **hyphens (`-`)**
36+
- Must **not end** with a hyphen (`-`)
37+
- Must **not contain consecutive hyphens** (`--`)
38+
- Maximum length: **16 characters**

0 commit comments

Comments
 (0)