Initial commit
This commit is contained in:
commit
5eec7a8dec
2 changed files with 105 additions and 0 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
.idea
|
||||||
104
README.md
Normal file
104
README.md
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
# [Name of the Best Practice Template]
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This repository provides a standardized template to solve [specific problem or use case]. It is designed to ensure quality, maintainability, and security for [mention the technology, e.g., Terraform module, CI/CD pipeline, etc.] on **STACKIT**.
|
||||||
|
|
||||||
|
The main goal of this Best Practice (BP) is to [briefly describe the primary benefit, e.g., "deploy a secure and cost-effective Kubernetes cluster on STACKIT"].
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Before using this template, ensure you have the following:
|
||||||
|
|
||||||
|
* **Tools**:
|
||||||
|
* [Tool Name, e.g., Terraform] version `x.y.z` or higher
|
||||||
|
* [Tool Name, e.g., Git]
|
||||||
|
* **Access & Permissions**:
|
||||||
|
* [Required access, e.g., Project Member permissions on a STACKIT project]
|
||||||
|
* STACKIT provider credentials configured
|
||||||
|
|
||||||
|
## How to Use
|
||||||
|
|
||||||
|
Follow these steps to implement the template:
|
||||||
|
|
||||||
|
1. **Clone the repository:**
|
||||||
|
```bash
|
||||||
|
git clone [repository-url]
|
||||||
|
cd [repository-name]
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Configure the variables:**
|
||||||
|
* Create a `terraform.tfvars` file or set environment variables as described in the **Configuration** section below.
|
||||||
|
|
||||||
|
3. **Initialize and apply:**
|
||||||
|
```bash
|
||||||
|
terraform init
|
||||||
|
terraform plan
|
||||||
|
terraform apply
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Verify the deployment:**
|
||||||
|
* [Provide a simple command or step to check if the deployment was successful].
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
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 |
|
||||||
|
| `...` | ... | `...` | `...` | ... |
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
This repository includes automated and manual testing procedures to ensure quality.
|
||||||
|
|
||||||
|
### Automated Tests
|
||||||
|
|
||||||
|
* **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:
|
||||||
|
|
||||||
|
* [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
|
||||||
|
|
||||||
|
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.
|
||||||
Loading…
Reference in a new issue