Skip to content

feat(iam): add docs for onboarding of new role binding resources #1446

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.

Sign up for GitHub

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

Open
rubenhoenle wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(iam): add docs for onboarding of new role binding resources #1446

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc66a8d
feat(iam): add docs for onboarding of new role binding resources
rubenhoenle May 7, 2026
49c32b6
Apply suggestions from code review
rubenhoenle May 7, 2026
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
35 changes: 34 additions & 1 deletion CONTRIBUTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,40 @@ If you want to onboard resources of a STACKIT service `foo` that was not yet in
You can find an annotated example of such tests in:

https://github.com/stackitcloud/terraform-provider-stackit/blob/main/.github/docs/contribution-guide/resource.go


### Onboarding new IAM role binding resources and datasources

The IAM role binding is a standardized, distributed API across multiple STACKIT services.
The standardization of this API allowed us to implement some generic approach for the implementation of new IAM role binding resources and datasources.

To implement a new IAM role binding resource and the corresponding datasource you just need to follow these steps:

1. Create a new package for the IAM role binding resources of your STACKIT service (in case there doesn't exist one already):

https://github.com/stackitcloud/terraform-provider-stackit/tree/main/stackit/internal/services/iam/rolebindings/v1/services

2. Create some new file with factories to create your new resource and datasource.

https://github.com/stackitcloud/terraform-provider-stackit/blob/main/stackit/internal/services/iam/rolebindings/v1/services/secretsmanager/instance.go

3. Register your new IAM role binding resource and datasource in the file below. **Note that you don't have to provide
examples or import statements for IAM role binding resources and datasources. They will be automatically generated for you!**

https://github.com/stackitcloud/terraform-provider-stackit/blob/main/stackit/internal/services/iam/rolebindings/v1/rolebindings.go

4. After your new IAM role binding resource and datasource should have been registered in the Terraform provider,
it's time to continue with implementing the acceptance tests. Here we've got you covered with some generic approach you can use.

In the package you created during the first step create some `testdata` directory. Place some terraform configuration file
in it for your new IAM role binding resource, which looks like the one below. Adjust it so it bootstraps everything you
need to test your new IAM role binding resource and datasource.

https://github.com/stackitcloud/terraform-provider-stackit/blob/main/stackit/internal/services/iam/rolebindings/v1/services/secretsmanager/testdata/instance.tf

Then create some acceptance test file in your package, you created during step one, which looks like the one below.
You will have to adjust it to your needs.

https://github.com/stackitcloud/terraform-provider-stackit/blob/main/stackit/internal/services/iam/rolebindings/v1/services/secretsmanager/iam_rolebindings_secretsmanager_acc_test.go

### Local development

Expand Down
Loading