professional-service-best-practices/best-practice-template
Template
14
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial commit

Browse source
This commit is contained in:
Mauritz_Uphoff 2025-10-31 13:22:18 +01:00
parent 5eec7a8dec
commit 5649935e24
3 changed files with 15 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md Normal file
View file

@ -0,0 +1,2 @@
- v1.0.0
- Initial Release

8
MAINTAINERS.md Normal file
View file

@ -0,0 +1,8 @@
# Maintainers
General maintainers:
* Foo Bar (foo.bar@stackit.cloud)
This BP is actively maintained. The owner is responsible for reviewing and updating dependencies and functionalities on a monthly basis.
For questions, issues, or feature requests, please email general maintainers.
Please include the BP name and version in your request. We will track your request as an issue.

35
README.md
View file

@ -44,11 +44,11 @@ Follow these steps to implement the template:
The following variables can be configured. The following variables can be configured.
| Variable Name | Description | Type | Default Value | Required | | Variable Name | Description | Type | Default Value | Required |
| --- | --- | --- | --- | --- | |---------------|---------------------------------------------|----------|---------------|----------|
| `project_id` | The STACKIT project ID. | `string` | `null` | Yes | | `project_id` | The STACKIT project ID. | `string` | `null` | Yes |
| `region` | The region where resources will be created. | `string` | `eu01` | No | | `region` | The region where resources will be created. | `string` | `eu01` | No |
| `...` | ... | `...` | `...` | ... | | `...` | ... | `...` | `...` | ... |
## Testing ## Testing
@ -59,8 +59,6 @@ This repository includes automated and manual testing procedures to ensure quali
* **Validation**: `terraform validate` is automatically executed on every commit via the CI/CD pipeline. * **Validation**: `terraform validate` is automatically executed on every commit via the CI/CD pipeline.
* **Security Scans**: A secret check is performed on every push to the repository. * **Security Scans**: A secret check is performed on every push to the repository.
Test results are automatically posted to our internal Google Chat room.
### Manual Tests ### Manual Tests
The following aspects should be tested manually after deployment: The following aspects should be tested manually after deployment:
@ -68,22 +66,6 @@ The following aspects should be tested manually after deployment:
* [Manual Test Case 1, e.g., "Verify connectivity to the database instance."] * [Manual Test Case 1, e.g., "Verify connectivity to the database instance."]
* [Manual Test Case 2, e.g., "Check permissions for the created service account."] * [Manual Test Case 2, e.g., "Check permissions for the created service account."]
## Cost Estimation
Using this template will incur costs on your STACKIT account. The estimated monthly cost for a default deployment is approximately **[Amount, e.g., €50-100]**.
This estimation is based on:
* [Resource 1, e.g., 1x Compute Instance of flavor stackit.compute.instance.flex.2-4]
* [Resource 2, e.g., 1x 20 GB Block Storage]
Please note that costs may vary depending on usage and configuration changes.
## Maintenance & Ownership
* **Owner**: [Author's Name or Team Name]
* **Last Review Date**: [YYYY-MM-DD]
This BP is actively maintained. The owner is responsible for reviewing and updating dependencies and functionalities on a monthly basis.
### Dependencies ### Dependencies
@ -92,13 +74,6 @@ This template relies on the following pinned versions:
* **Provider [Provider Name, e.g., STACKIT]**: `~> 0.12.0` * **Provider [Provider Name, e.g., STACKIT]**: `~> 0.12.0`
* **Module [Module Name]**: `~> 1.y.z` * **Module [Module Name]**: `~> 1.y.z`
## Support & Feedback
For questions, issues, or feature requests, please send an email to:
**[your-support-email@example.com]**
Please include the BP name and version in your request. We will track your request as an issue.
## Changelog ## Changelog
All notable changes to this project are documented in the `CHANGELOG.md` file. All notable changes to this project are documented in the `CHANGELOG.md` file.