History

Ludovico Magnocavallo 1ac3fe4460 New tfdoc version (#396 ) * update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos		2021-12-21 08:51:51 +01:00
..
README.md	New tfdoc version (#396 )	2021-12-21 08:51:51 +01:00
main.tf	Apigee add paid only variables and examples	2021-08-05 13:21:57 +02:00
outputs.tf	Adding Apigee Environments as output for apigee-organization module	2021-11-24 18:57:29 +01:00
variables.tf	Add more validations to linter	2021-10-08 18:26:04 +02:00
versions.tf	Use the same versions file everywhere, pin to tf 1.0+ provider 4.0+ (#355 )	2021-11-03 15:05:43 +01:00

README.md

Google Apigee Organization Module

This module allows managing a single Apigee organization and its environments and environmentgroups.

Examples

Apigee X Evaluation Organization

module "apigee-organization" {
  source     = "./modules/apigee-organization"
  project_id = "my-project"
  analytics_region = "us-central1"
  runtime_type = "CLOUD"
  authorized_network = "my-vpc"
  apigee_environments = [
    "eval1",
    "eval2"
  ]
  apigee_envgroups = {
    eval = {
      environments = [
        "eval1",
        "eval2"
      ]
      hostnames    = [
        "eval.api.example.com"
      ]
    }
  }
}
# tftest:modules=1:resources=6

Apigee X Paid Organization

module "apigee-organization" {
  source     = "./modules/apigee-organization"
  project_id = "my-project"
  analytics_region = "us-central1"
  runtime_type = "CLOUD"
  authorized_network = "my-vpc"
  database_encryption_key = "my-data-key"
  apigee_environments = [
    "dev1",
    "dev2",
    "test1",
    "test2"
  ]
  apigee_envgroups = {
    dev = {
      environments = [
        "dev1",
        "dev2"
      ]
      hostnames    = [
        "dev.api.example.com"
      ]
    }
    test = {
      environments = [
        "test1",
        "test2"
      ]
      hostnames    = [
        "test.api.example.com"
      ]
    }
  }
}
# tftest:modules=1:resources=11

Apigee hybrid Organization

module "apigee-organization" {
  source     = "./modules/apigee-organization"
  project_id = "my-project"
  analytics_region = "us-central1"
  runtime_type = "HYBRID"
  apigee_environments = [
    "eval1",
    "eval2"
  ]
  apigee_envgroups = {
    eval = {
      environments = [
        "eval1",
        "eval2"
      ]
      hostnames    = [
        "eval.api.example.com"
      ]
    }
  }
}
# tftest:modules=1:resources=6

Variables

name	description	type	required	default
analytics_region	Analytics Region for the Apigee Organization (immutable). See https://cloud.google.com/apigee/docs/api-platform/get-started/install-cli.	`string`	✓
project_id	Project ID to host this Apigee organization (will also become the Apigee Org name).	`string`	✓
runtime_type	Apigee runtime type. Must be `CLOUD` or `HYBRID`.	`string`	✓
apigee_envgroups	Apigee Environment Groups.	`map(object({…}))`		`{}`
apigee_environments	Apigee Environment Names.	`list(string)`		`[]`
authorized_network	VPC network self link (requires service network peering enabled (Used in Apigee X only).	`string`		`null`
database_encryption_key	Cloud KMS key self link (e.g. `projects/foo/locations/us/keyRings/bar/cryptoKeys/baz`) used for encrypting the data that is stored and replicated across runtime instances (immutable, used in Apigee X only).	`string`		`null`
description	Description of the Apigee Organization.	`string`		`"Apigee Organization created by tf module"`
display_name	Display Name of the Apigee Organization.	`string`		`null`

Outputs

name	description	sensitive
envs	Apigee Environments.
org	Apigee Organization.
org_ca_certificate	Apigee organization CA certificate.
org_id	Apigee Organization ID.
subscription_type	Apigee subscription type.