A Terraform provider for managing Instaclustr Platform resources.

It provides a flexible set of resources for provisioning and managing Instaclustr based clusters via the use of Terraform.

For general information about Terraform, visit the official website and GitHub project page.

For further information about Instaclustr, please see FAQ and Support

• Removes the need to write custom code integration directly with the Instaclustr API
• Instaclustr based infrastructure as code deployments with minimal effort
• Ease of integration into existing terraform or automated CI/CD based workflows
• Ease of customisation and configuration in order to meet operational requirements
• Use of existing Instaclustr authentication methodologies

• Terraform v0.10.x - .v0.12.28 (we are actively working towards supporting v.0.13.0 and above).
• Go 1.14 or higher

Clone the provider source code

$ mkdir -p $GOPATH/src/github.com/instaclustr; cd $GOPATH/src/github.com/instaclustr
$ git clone https://github.com/instaclustr/terraform-provider-instaclustr.git

Build the source into executable binary

$ cd $GOPATH/src/github.com/instaclustr/terraform-provider-instaclustr
$ make build

Install the provider

$ cd $GOPATH/src/github.com/instaclustr/terraform-provider-instaclustr
$ make install

For further details on Provider installation please see the Terraform installation guide.

This provider requires an API Key in order to provision Instaclustr resources. To create an API key, please log into the Instaclustr Console or signup for an account here if you dont have one. Navigate to Account -> API Keys page, locate the Provisioning role and click Generate Key. This username and API key combination should then be placed into the provider configuration:

provider "instaclustr" {
    username = "<Your instaclustr username here>"
    api_key = "<Your provisioning API key here>"
}

or just input them when Terraform indicates you.

resource "instaclustr_cluster" "example" {
    cluster_name = "testcluster"
    node_size = "t3.small"
    data_centre = "US_WEST_2"
    sla_tier = "NON_PRODUCTION"
    cluster_network = "192.168.0.0/18"
    private_network_cluster = false
    pci_compliant_cluster = false
    cluster_provider = {
        name = "AWS_VPC"
    }
    rack_allocation = {
        number_of_racks = 3
        nodes_per_rack = 1
    }
    bundle {
        bundle = "APACHE_CASSANDRA"
        version = "3.11.4"
        options = {
          auth_n_authz = true
        }
      }
      bundle {
        bundle = "SPARK"
        version = "apache-spark:2.3.2"
      }
      bundle {
        bundle = "ZEPPELIN"
        version = "apache-zeppelin:0.8.0-spark-2.3.2"
      }
}

A resource for managing clusters on Instaclustr Managed Platform. A cluster contains a base application and several add-ons.

cluster_provider

rack_allocation

bundle

bundle.options - all properties listed are optional

A resource for managing cluster firewall rules on Instaclustr Managed Platform. A firewall rule allows access to your Instaclustr cluster. Note: Either rule_cidr OR rule_security_group_id must be provided per rule (but not both)

rules

resource "instaclustr_firewall_rule" "example" {
    cluster_id = "${instaclustr_cluster.example.id}"
    rule_cidr = "10.1.0.0/16"
    rules = [
        { 
            type = "CASSANDRA"
        }
    ]
}

A resource for managing VPC peering connections on Instaclustr Managed Platform. This is only avaliable for clusters hosted with the AWS provider.

When creating this resource, the process will wait for target cluster to be in the PROVISIONED or RUNNING status. The process will time out after 60 seconds of waiting.

resource "instaclustr_vpc_peering" "example_vpc_peering" {
    cluster_id = "${instaclustr_cluster.example.cluster_id}"
    peer_vpc_id = "vpc-123456"
    peer_account_id = "1234567890"
    peer_subnet = "10.0.0.0/20"
}

A resource for managing EBS encryption of nodes with KMS keys. This is only avaliable for clusters hosted with the AWS provider.

resource "instaclustr_encryption_key" "example_encryption_key" {
    alias = "virginia 1"
    arn = "arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789abc"
}

Resources for managing Kafka user for a Kafka cluster. Kafka user list is a read-only data source used to get the list of kafka user in a cluster, while Kafka user is a resource used to create, update password, and delete Kafka users.

Note: There is a possibility that someone else delete the Kafka user through other means, e.g., instaclustr console and API. This will cause the Kafka user resource to be not in sync because it does not have read. In such case, to recreate the user just remove the Kafka user resource, and then create a new one.

instaclustr_kafka_user

instaclustr_kafka_user_list

resource "instaclustr_kafka_user" "kafka_user_charlie" {
  cluster_id = "${instaclustr_cluster.kafka_cluster.cluster_id}"
  username = "charlie"
  password = "charlie1!"
  initial_permissions = "none"
}


data "instaclustr_kafka_user_list" "kafka_user_list" {
  cluster_id = "${instaclustr_cluster.kafka_cluster.cluster_id}"
}

A schema change has been made from 0.0.1 which no longer supports the bundles argument and uses bundle blocks instead. This change can cause terraform apply to fail with a message that bundles has been removed and/or updating isn't supported. To resolve this -

1. Change all usages of the bundles argument → bundle blocks (example under example/main.tf)
2. In the .tfstate files, replace all keys named bundles with bundle in resources under the Instaclustr provider.

Firstly thanks! We value your time and will do our best to review the PR as soon as possible.

1. Install golang
2. Clone repository to: $GOPATH/src/github.com/instaclustr/terraform-provider-instaclustr
3. Build the provider by $ make build
4. Run the tests by $ make test
5. Set up all of the environmental variables listed below to prepare for acceptance testing.
6. Run the acceptance tests $ make testacc
7. Create a PR and send it our way :)

These environment variables are optional and only required when we want to do acceptance tests for Kafka Connect. It is toggled by setting IC_TEST_KAFKA_CONNECT environment variable.

This provider makes use of the Instaclustr API. For further information including latest updates and value definitions, please see the provisioning API documentation.

Please see https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/ for Instaclustr support status of this project.

Apache2 - See the included LICENSE file for more details.