Skip to content

Commit 1ef0b51

Browse files
committed
docs: update READMEs
1 parent 045080b commit 1ef0b51

File tree

3 files changed

+40
-10
lines changed

3 files changed

+40
-10
lines changed

sample-setup/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ We follow the paradigms of a simpel and clear Terraform configuration as laid ou
1717

1818
Ensuring naming conventions is one import aspect when provisioing and managing your SAP BTP account. We will align our samples in accordance to the [Naming Conventions for SAP BTP Accounts](https://help.sap.com/docs/btp/btp-admin-guide/naming-conventions-for-sap-btp-accounts).
1919

20-
To ensure consistent naming of your resources, we encapsulate the guidlines in a dedicated module.
20+
To ensure consistent naming of your resources, we encapsulate the guidlines in dedicated module. Besides the naming we will also include the labels that can be attached to some resources on SAP BTP.
2121

22-
Besides the naming we will also include the labels that can be attached to some resources on SAP BTP.
22+
We have created one module for the level of the [directory](./modules/sap-btp-naming-conventions-directory/README.md) and one for the level of the [subaccount](./modules/sap-btp-naming-conventions-subaccount/README.md).
23+
24+
## Setup of Directories
25+
26+
The setup of directories as a structuring element for the subaccounts is configured in the folder `basic-setup/directory-setup`. The Details about the setup are described in the [README.md](./basic-setup/directory-setup/README.md) file.
27+
28+
## Setup of Subaccounts
29+
30+
The setup of subaccounts is configured in the folder `basic-setup/subaccount-setup`. The Details about the setup are described in the [README.md](./basic-setup/subaccount-setup/README.md) file.

sample-setup/basic-setup/directory-setup/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55
- We assume that we use the directories as structuring element for the subaccounts i.e., un an unmanaged fashion.
66
- We assume that we do the directory setup in one run for all involved departments.
77

8-
## Design Decsion
8+
## Design Decsions
99

10-
We decouple the directory creation i.e., the setup of the basic structure from the creation of the operational units namely the subaccounts inside of the directory. The changes on directory level are probably a rare sceanrio compared to the subaccounts (depending on their stage) and we therefore want to avoid side effects as well as lengthy state refreshes.
10+
We decouple the directory creation i.e., the setup of the basic structure from the creation of the operational units namely the subaccounts inside of the directories. The changes on directory level are probably a rare sceanrio compared to changes in the subaccounts additionally depending on their stage. We want to avoid side effects as well as lengthy state refreshes and keep the state of the directories seperate.
1111

1212
## Directory Setup
1313

14-
We will create directories for the following departments:
14+
The creation of the directories is steered by a map of objects that define the business data relevant for a directory namely:
1515

16-
- HR
17-
- Sales
18-
- Finance
16+
- business_unit (`string`): The business unit that owns the directory e.g., HR, IT, Finance
17+
- costcenter (`string`): Cost center of the business unit
18+
- directory_contacts (`list(string)`): List of email addresses representing the directory contacts
19+
- region (`string`): The geographical region of the directory e.g., EMEA
1920

20-
In addition we create a directory for shared services.
21+
This is input data is reflected by the variables defined in the [variables.tf](./variables.tf) file
2122

22-
All directories are located in EMEA.
23+
The directories are provisioned via the [main.tf](./main.tf) file which delegates to the module [base-directory-setup](../../modules/base-directory-setup/README.md). This module combines the corresponding module containing the naming and labeling conventions for a directory and calls the Terraform resource [btp_directory](https://registry.terraform.io/providers/SAP/btp/latest/docs/resources/directory).
24+
25+
After provisioning the output summarizes the executed setup as given by the [outputs.tf](./outputs.tf) file.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# Setup of a Subaccount
22

3+
## Assumptions
4+
5+
- We assume that we use the directories as structuring element for the subaccounts i.e., un an unmanaged fashion.
6+
- We assume that we do the directory setup in one run for all involved departments.
7+
8+
## Design Decsions
9+
10+
We decouple the directory creation i.e., the setup of the basic structure from the creation of the operational units namely the subaccounts inside of the directory. The changes on directory level are probably a rare sceanrio compared to the subaccounts (depending on their stage) and we therefore want to avoid side effects as well as lengthy state refreshes.
11+
12+
## Subaccount Setup
13+
314
- Basic setup of a subaccount. Every subaccount is created seperately
415
- Naming Conventions and Labels
516
- Validation of Geo Region and Subaccount region
617
- Default Setup of custom IdP
718
- Provision CF env (optional)
819
- Execute default plus à la carte entitlements
20+
21+
### Validations for Geographies and BTP Regions
22+
23+
### Trust Configuration for Custom IdP
24+
25+
### Setup of Entitlements
26+
27+
### Setup of Cloud Foundry Environment

0 commit comments

Comments
 (0)