Skip to content

feat: adding stackit #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,106 @@ Refer to each module's README.md for specific usage instructions such as needed

The meshStack Hub is a 🌤️ [cloudfoundation.org community](https://cloudfoundation.org/?ref=github-collie-cli) project.
Reach out to us on the [cloudfoundation.org slack](http://cloudfoundationorg.slack.com).

## 🛠️ How to Contribute

Thank you for your interest in contributing Terraform modules or building blocks to **meshstack-hub**! To ensure high quality and consistency, please follow the steps below:

---

### 1. Fork & Clone

```bash
git clone git@github.com:<your-username>/meshstack-hub.git
cd meshstack-hub
git checkout -b feature/your-module
```

---

### 2. Enter Nix Development Shell

The repository provides a `flake.nix` that includes pre-commit hooks, formatting, validation, and docs generation:

```bash
nix develop
```

This prepares the environment with `terraform`, `terraform-docs`, `pre-commit`, and any other needed tools automatically.

---

### 3. Write and Organize Your Terraform Module

- Add your module under the correct provider folder (e.g. `aws/`, `azure/`, `gcp/`).
- Include:
- `main.tf`, `variables.tf`, `outputs.tf`, `versions.tf`, `providers.tf`, `APP_TEAM_README.md`
- A `README.md` describing the module’s purpose and usage.

---

### 4. Run Pre‑commit Hooks

Hooks are already available in your shell:

```bash
pre-commit run --all-files
```

They include checks like `terraform fmt`, `terraform validate` and automated docs via `terraform-docs`.

Commiting will auto-run them:

```bash
git add .
git commit -m "feat: add new vpc module"
```

---

This is typically triggered via pre-commit hooks during commits.

---

### 7. Add or Update Tests

- Run them inside `nix develop`, for example:

Ensure all tests pass and code/formats stay clean.

---

### 8. Push & Open a Pull Request

```bash
git push origin feature/your-module
```

In your PR description include:
- Module purpose, inputs/outputs
- Provider details
- Any breaking changes or migration notes
- Confirmation that all tests and checks passed

---

### 9. Review & Merge

CI will rerun all hooks/tests. A maintainer will review and merge or request adjustments.

---

## ✅ Summary Checklist

1. [ ] Module in the correct provider folder
2. [ ] `main.tf`, `variables.tf`, `outputs.tf`, `README.md`
3. [ ] `nix develop` used to enter environment ✅
4. [ ] `pre-commit run --all-files` passed ✅
5. [ ] `terraform init`, `validate`, `fmt` passed ✅
6. [ ] `terraform-docs markdown .` docs generated ✅
7. [ ] Tests added/updated and passing ✅
8. [ ] PR includes description & proof that all checks passed ✅

---

Thanks again for helping to improve **meshstack-hub**! 🚀
Binary file added modules/stackit/stackit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/public/assets/logos/stackit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions website/public/assets/logos/stackit.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion website/public/assets/platform-logos.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@
"gcp": "assets/logos/gcp.png",
"github": "assets/logos/github.png",
"ionos": "assets/logos/ionos.png",
"stackit": "assets/logos/stackit.png",
"openshift": "assets/logos/openshift.png",
"openstack": "assets/logos/openstack.png",
"ovh": "assets/logos/ovh.png",
"sapbtp": "assets/logos/sapbtp.png",
"tencentcloud": "assets/logos/tencentcloud.png"
}
}
2 changes: 2 additions & 0 deletions website/src/app/shared/platform/platform.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ export class PlatformService {
return { name: 'Azure Kubernetes Service', logo: logoUrl };
case 'ionos':
return { name: 'IONOS', logo: logoUrl };
case 'stackit':
return { name: 'STACKIT', logo: logoUrl };
case 'datadog':
return { name: 'DataDog', logo: logoUrl };
case 'cloudfoundry':
Expand Down
Loading