diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..96f383a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +- v1.0.0 + - Initial Release \ No newline at end of file diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..199ed2d --- /dev/null +++ b/MAINTAINERS.md @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index bfe993c..268297f 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,11 @@ Follow these steps to implement the template: The following variables can be configured. -| Variable Name | Description | Type | Default Value | Required | -| --- | --- | --- | --- | --- | -| `project_id` | The STACKIT project ID. | `string` | `null` | Yes | -| `region` | The region where resources will be created. | `string` | `eu01` | No | -| `...` | ... | `...` | `...` | ... | +| Variable Name | Description | Type | Default Value | Required | +|---------------|---------------------------------------------|----------|---------------|----------| +| `project_id` | The STACKIT project ID. | `string` | `null` | Yes | +| `region` | The region where resources will be created. | `string` | `eu01` | No | +| `...` | ... | `...` | `...` | ... | ## 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. * **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 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 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 @@ -92,13 +74,6 @@ This template relies on the following pinned versions: * **Provider [Provider Name, e.g., STACKIT]**: `~> 0.12.0` * **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 All notable changes to this project are documented in the `CHANGELOG.md` file. \ No newline at end of file