Advanced
Terraform Provider
Terraform is available on Pro and Enterprise plans.
Set up All Quiet Terraform Provider
Open the latest version of the All Quiet Terraform Provider.- Click on
Use Provider. - Copy the code and paste it into your terraform configuration file. If you haven’t set up a terraform file yet, follow the instructions on Terraform’s website.
- Run
terraform initin your terminal.
To use our Terraform provider, you need to create an API Key, next.
Create API Key
Creating an API Key requires you to be the Owner or Administrator of an Organization. To set up an Organization, please follow the related documentation.
The account that creates the Organization cannot be provisioned via Terraform. Therefore, we recommend to create the Organization with a root user that is not bound to a specific employee, like admin@allquiet.app. This way, you ensure all “real” on-call users and employee accounts can be provisioned.
If you already set up the Org with your personal account, you can change your account’s email address via the Web app on /app/account to a root user email and later provision your personal email and account via Terraform.
- Copy the code snippet and paste it into your configuration file.
- In the file, set your
api_regiondepending on your organization’s data storage region. - Next, you need to generate “your_api_key”.
Generating the API key has to be done in the All Quiet Web App. Afterwards, you can set up everything via our Terraform Provider.
- In the Web App, open
Organizations. - Select the correct organization and click
API Keys
Click Create API Key
Approve the API Key creation by clicking Yes, Create.
Now, copy the generated API Key…
…and paste it into your configuration file
Congrats, your good to go and can use All Quiet via Terraform!
All Quiet Resources in Terraform
Please find the documentation of our resources attached.- allquiet_user
-
When provisioning users and you want them use OIDC, Google or Microsoft login, we first need to setup OIDC before they can log in. If you want them to use password login on All Quiet, we don’t have to prepare anything.
-
- allquiet_team
- allquiet_team_memberships
- allquiet_team_escalations
- allquiet_integration
- allquiet_integration_mapping
- If you don’t use this resource, your integrations will implicitly follow our default mappings. If you want to adjust the mapping, we’ve prepared template
allquiet_integration_mapping.- Template Download (Example with Integration_ID = “Datadog”): https://allquiet.app/api/integrations/terraform/default/Datadog.tf.
- Each Integration_ID can be found here: https://allquiet.app/api/public/v1/inbound-integration/types
- If you don’t use this resource, your integrations will implicitly follow our default mappings. If you want to adjust the mapping, we’ve prepared template
- allquiet_integration_maintenance_window
- allquiet_outbound_integration
- allquiet_routing
- allquiet_organization_membership
-
There’s no
allquiet_organizationresource as the API Key you use for your Terraform config is always bound to a specific organization. Allallquiet_organization_membershipresources are bound to this organization
-
- allquiet_service
- allquiet_status_page
To learn more about Terraform commands, please check their tutorials.
Provisioned Resources Cannot Be Edited Via Web App
To ensure that the resources managed by your Terraform provider stay in sync with your setup, we lock provisioned resources within the Web App. This means these resources cannot be edited or deleted directly through the Web App’s interface. Provisioned resources are marked with an icon, and hovering over it will display a message explaining why the resource is locked and cannot be modified via the Web App.
Our Terraform provider is designed to help you configure and manage your standard setup seamlessly. However, temporary changes — such as on-call schedule overrides or maintenance windows — will always be able to be added via the Web’s interface.
Find Provisioned Users in All Quiet
To see the users currently provisioned via Terraform in All Quiet,- select your Organization
- and open the
Userstab. Here, you can see all users of your organization. - Users provisioned via Terraform can be identified by
Source= Terraform
If you provision the phone numbers of your users via Terraform, they still have to confirm their phone number via notification settings.
