Skip to content

Commit 5b241a9

Browse files
florianowflorianow
committed
feat: pre-commit
1 parent 57831b8 commit 5b241a9

File tree

4 files changed

+149
-0
lines changed

4 files changed

+149
-0
lines changed

‎modules/sapbtp/cloudfoundry/buildingblock/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,43 @@ cf target -o {org-name} -s {space-name}
154154
```
155155

156156
Find your org name in BTP Cockpit → Cloud Foundry → Organizations
157+
158+
<!-- BEGIN_TF_DOCS -->
159+
## Requirements
160+
161+
| Name | Version |
162+
|------|---------|
163+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
164+
| <a name="requirement_btp"></a> [btp](#requirement\_btp) | ~> 1.8.0 |
165+
166+
## Modules
167+
168+
No modules.
169+
170+
## Resources
171+
172+
| Name | Type |
173+
|------|------|
174+
| [btp_subaccount_environment_instance.cloudfoundry](https://registry.terraform.io/providers/sap/btp/latest/docs/resources/subaccount_environment_instance) | resource |
175+
| [btp_subaccount_service_instance.cf_service](https://registry.terraform.io/providers/sap/btp/latest/docs/resources/subaccount_service_instance) | resource |
176+
| [btp_subaccount_service_plan.cf_service_plan](https://registry.terraform.io/providers/sap/btp/latest/docs/data-sources/subaccount_service_plan) | data source |
177+
178+
## Inputs
179+
180+
| Name | Description | Type | Default | Required |
181+
|------|-------------|------|---------|:--------:|
182+
| <a name="input_cf_services"></a> [cf\_services](#input\_cf\_services) | Comma-separated list of Cloud Foundry service instances in format: service.plan (e.g., 'postgresql.small,destination.lite,redis.medium') | `string` | `""` | no |
183+
| <a name="input_cloudfoundry_plan"></a> [cloudfoundry\_plan](#input\_cloudfoundry\_plan) | Cloud Foundry environment plan (standard, free, or trial) | `string` | `"standard"` | no |
184+
| <a name="input_globalaccount"></a> [globalaccount](#input\_globalaccount) | The subdomain of the global account in which you want to manage resources. | `string` | n/a | yes |
185+
| <a name="input_project_identifier"></a> [project\_identifier](#input\_project\_identifier) | The meshStack project identifier (used for CF environment naming). | `string` | n/a | yes |
186+
| <a name="input_subaccount_id"></a> [subaccount\_id](#input\_subaccount\_id) | The ID of the subaccount where Cloud Foundry should be enabled. | `string` | n/a | yes |
187+
188+
## Outputs
189+
190+
| Name | Description |
191+
|------|-------------|
192+
| <a name="output_cloudfoundry_instance_id"></a> [cloudfoundry\_instance\_id](#output\_cloudfoundry\_instance\_id) | ID of the Cloud Foundry environment instance |
193+
| <a name="output_cloudfoundry_instance_state"></a> [cloudfoundry\_instance\_state](#output\_cloudfoundry\_instance\_state) | State of the Cloud Foundry environment instance |
194+
| <a name="output_cloudfoundry_services"></a> [cloudfoundry\_services](#output\_cloudfoundry\_services) | Map of Cloud Foundry service instances created in this subaccount |
195+
| <a name="output_subaccount_id"></a> [subaccount\_id](#output\_subaccount\_id) | The subaccount ID (passthrough for dependency chaining) |
196+
<!-- END_TF_DOCS -->

‎modules/sapbtp/entitlements/buildingblock/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,35 @@ entitlements = "postgresql-db.small,redis-cache.medium"
103103
```
104104
entitlements = "sapappstudio.standard-edition,sap-build-apps.standard"
105105
```
106+
107+
<!-- BEGIN_TF_DOCS -->
108+
## Requirements
109+
110+
No requirements.
111+
112+
## Modules
113+
114+
No modules.
115+
116+
## Resources
117+
118+
| Name | Type |
119+
|------|------|
120+
| [btp_subaccount_entitlement.entitlement_with_quota](https://registry.terraform.io/providers/hashicorp/btp/latest/docs/resources/subaccount_entitlement) | resource |
121+
| [btp_subaccount_entitlement.entitlement_without_quota](https://registry.terraform.io/providers/hashicorp/btp/latest/docs/resources/subaccount_entitlement) | resource |
122+
123+
## Inputs
124+
125+
| Name | Description | Type | Default | Required |
126+
|------|-------------|------|---------|:--------:|
127+
| <a name="input_entitlements"></a> [entitlements](#input\_entitlements) | Comma-separated list of service entitlements in format: service.plan (e.g., 'postgresql-db.trial,destination.lite,xsuaa.application') | `string` | `""` | no |
128+
| <a name="input_globalaccount"></a> [globalaccount](#input\_globalaccount) | The subdomain of the global account in which you want to manage resources. | `string` | n/a | yes |
129+
| <a name="input_subaccount_id"></a> [subaccount\_id](#input\_subaccount\_id) | The ID of the subaccount where entitlements should be added. | `string` | n/a | yes |
130+
131+
## Outputs
132+
133+
| Name | Description |
134+
|------|-------------|
135+
| <a name="output_entitlements"></a> [entitlements](#output\_entitlements) | Map of entitlements created for this subaccount |
136+
| <a name="output_subaccount_id"></a> [subaccount\_id](#output\_subaccount\_id) | The subaccount ID (passthrough for dependency chaining) |
137+
<!-- END_TF_DOCS -->

‎modules/sapbtp/subaccount/buildingblock/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,3 +124,46 @@ After provisioning a subaccount, you can add:
124124
- **Subscriptions**: Use the `subscriptions` building block to subscribe to SaaS applications
125125
- **Cloud Foundry**: Use the `cloudfoundry` building block to provision CF environment and services
126126
- **Custom IdP**: Use the `trust-configuration` building block to integrate external identity providers
127+
128+
<!-- BEGIN_TF_DOCS -->
129+
## Requirements
130+
131+
| Name | Version |
132+
|------|---------|
133+
| <a name="requirement_btp"></a> [btp](#requirement\_btp) | ~> 1.8.0 |
134+
135+
## Modules
136+
137+
No modules.
138+
139+
## Resources
140+
141+
| Name | Type |
142+
|------|------|
143+
| [btp_subaccount.subaccount](https://registry.terraform.io/providers/SAP/btp/latest/docs/resources/subaccount) | resource |
144+
| [btp_subaccount_role_collection_assignment.subaccount_admin](https://registry.terraform.io/providers/SAP/btp/latest/docs/resources/subaccount_role_collection_assignment) | resource |
145+
| [btp_subaccount_role_collection_assignment.subaccount_service_admininstrator](https://registry.terraform.io/providers/SAP/btp/latest/docs/resources/subaccount_role_collection_assignment) | resource |
146+
| [btp_subaccount_role_collection_assignment.subaccount_viewer](https://registry.terraform.io/providers/SAP/btp/latest/docs/resources/subaccount_role_collection_assignment) | resource |
147+
| [btp_directories.all](https://registry.terraform.io/providers/SAP/btp/latest/docs/data-sources/directories) | data source |
148+
149+
## Inputs
150+
151+
| Name | Description | Type | Default | Required |
152+
|------|-------------|------|---------|:--------:|
153+
| <a name="input_globalaccount"></a> [globalaccount](#input\_globalaccount) | The subdomain of the global account in which you want to manage resources. | `string` | n/a | yes |
154+
| <a name="input_parent_id"></a> [parent\_id](#input\_parent\_id) | The parent directory ID for the subaccount. Use this when importing existing subaccounts. Mutually exclusive with subfolder. | `string` | `""` | no |
155+
| <a name="input_project_identifier"></a> [project\_identifier](#input\_project\_identifier) | The meshStack project identifier. | `string` | n/a | yes |
156+
| <a name="input_region"></a> [region](#input\_region) | The region of the subaccount. | `string` | `"eu10"` | no |
157+
| <a name="input_subfolder"></a> [subfolder](#input\_subfolder) | The subfolder name to use for the SAP BTP resources. This is used to create a folder structure in the SAP BTP cockpit. Mutually exclusive with parent\_id. | `string` | `""` | no |
158+
| <a name="input_users"></a> [users](#input\_users) | Users and their roles provided by meshStack | <pre>list(object(<br> {<br> meshIdentifier = string<br> username = string<br> firstName = string<br> lastName = string<br> email = string<br> euid = string<br> roles = list(string)<br> }<br> ))</pre> | `[]` | no |
159+
160+
## Outputs
161+
162+
| Name | Description |
163+
|------|-------------|
164+
| <a name="output_subaccount_id"></a> [subaccount\_id](#output\_subaccount\_id) | The ID of the created subaccount |
165+
| <a name="output_subaccount_login_link"></a> [subaccount\_login\_link](#output\_subaccount\_login\_link) | Link to the subaccount in the SAP BTP cockpit |
166+
| <a name="output_subaccount_name"></a> [subaccount\_name](#output\_subaccount\_name) | The name of the subaccount |
167+
| <a name="output_subaccount_region"></a> [subaccount\_region](#output\_subaccount\_region) | The region of the subaccount |
168+
| <a name="output_subaccount_subdomain"></a> [subaccount\_subdomain](#output\_subaccount\_subdomain) | The subdomain of the subaccount |
169+
<!-- END_TF_DOCS -->

‎modules/sapbtp/subscriptions/buildingblock/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,37 @@ subscriptions = "integrationsuite.enterprise_agreement,mobile-services.standard"
101101
```
102102
subscriptions = "sap-build-apps.standard,build-workzone.standard"
103103
```
104+
105+
<!-- BEGIN_TF_DOCS -->
106+
## Requirements
107+
108+
| Name | Version |
109+
|------|---------|
110+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
111+
| <a name="requirement_btp"></a> [btp](#requirement\_btp) | ~> 1.8.0 |
112+
113+
## Modules
114+
115+
No modules.
116+
117+
## Resources
118+
119+
| Name | Type |
120+
|------|------|
121+
| [btp_subaccount_subscription.subscription](https://registry.terraform.io/providers/sap/btp/latest/docs/resources/subaccount_subscription) | resource |
122+
123+
## Inputs
124+
125+
| Name | Description | Type | Default | Required |
126+
|------|-------------|------|---------|:--------:|
127+
| <a name="input_globalaccount"></a> [globalaccount](#input\_globalaccount) | The subdomain of the global account in which you want to manage resources. | `string` | n/a | yes |
128+
| <a name="input_subaccount_id"></a> [subaccount\_id](#input\_subaccount\_id) | The ID of the subaccount where subscriptions should be added. | `string` | n/a | yes |
129+
| <a name="input_subscriptions"></a> [subscriptions](#input\_subscriptions) | Comma-separated list of application subscriptions in format: app.plan (e.g., 'build-workzone.standard,integrationsuite.enterprise\_agreement') | `string` | `""` | no |
130+
131+
## Outputs
132+
133+
| Name | Description |
134+
|------|-------------|
135+
| <a name="output_subaccount_id"></a> [subaccount\_id](#output\_subaccount\_id) | The subaccount ID (passthrough for dependency chaining) |
136+
| <a name="output_subscriptions"></a> [subscriptions](#output\_subscriptions) | Map of application subscriptions created in this subaccount |
137+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)