Skip to main content

Get started with Aiven Provider for Terraform

This example shows you how to use the Aiven Provider to set up your data infrastructure by creating a single Aiven for Caching service in an Aiven project.

caution

Recreating stateful services with Terraform may delete the service and all its data before creating it again. Some properties, like project and resource name, cannot be changed and it will trigger a resource replacement. Run the Terraform plan command to find out whether a service will be deleted or replaced.

You can set the termination_protection property to true on production services, topics, and databases to prevent Terraform from removing them. However, logical databases, topics, or other configurations may still be removed even with this setting enabled.

Prerequisites​

Configure your project and services​

In this section, you'll learn how to structure a simple Terraform project.

Terraform files declare the structure of the infrastructure, the dependencies, and configuration. These can be grouped together in one file, but it's ideal to put them in separate files.

Set up the Terraform project in an empty folder:

  1. Create a Terraform file, provider.tf, to declare a dependency on the Aiven Provider for Terraform.

    Add the following code to the file and specify the version in the required_providers block. The latest version is shown on the Aiven Provider page.

    terraform {
      required_providers {
        aiven = {
          source  = "aiven/aiven"
          version = ">=4.0.0, < 5.0.0"
        }
      }
    }

    provider "aiven" {
      api_token = var.aiven_api_token
    }

  2. Create a file named redis.tf.

    Add the following code to define the configuration of a single-node Aiven for Caching service:

    # Caching service

    resource "aiven_redis" "single-node-aiven-redis" {
      project                 = var.project_name
      cloud_name              = "google-northamerica-northeast1"
      plan                    = "startup-4"
      service_name            = "gcp-single-node-redis1"
      maintenance_window_dow  = "monday"
      maintenance_window_time = "10:00:00"

      redis_user_config {
        redis_maxmemory_policy = "allkeys-random"

        public_access {
          redis = true
        }
      }
    }

  3. Create a file named variables.tf. This is used to avoid including sensitive information in source control.

    Add the following code to declare the token and project name variables:

    variable "aiven_api_token" {
      description = "Aiven token"
      type        = string
    }

    variable "project_name" {
      description = "Aiven console project name"
      type        = string
    }

  4. Create a file named terraform.tfvars to define the values of the sensitive information.

    Add the following code, replacing AIVEN_TOKEN with your token and AIVEN_PROJECT_NAME with the name of your project:

    aiven_api_token = "AIVEN_TOKEN"
    project_name    = "AIVEN_PROJECT_NAME"

Plan and apply the configuration​

  1. The init command prepares the working directly for use with Terraform. Use it to automatically find, download, and install the necessary Aiven Provider plugins:

    terraform init

  2. Run the plan command to create an execution plan and preview the changes that will be made (for example, what resources will be created or modified):

    terraform plan

  3. To create the resources, run:

    terraform apply --auto-approve

The output will be similar to the following:

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

You can also see the new Caching service in the Aiven Console.

Clean up​

To delete the service and its data:

  1. Create a destroy plan and preview the changes to your infrastructure with the following command:

    terraform plan -destroy

  2. To delete the resources and all data, run:

    terraform destroy

  3. Enter "yes" to confirm. The output will be similar to the following:

    Do you really want to destroy all resources?
    Terraform will destroy all your managed infrastructure, as shown above.
    There is no undo. Only 'yes' will be accepted to confirm.

    Enter a value: yes
    ...
    Destroy complete! Resources: 1 destroyed.

Next steps​