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	Update CI processes (#296 )	2021-08-12 17:30:53 +02:00
outputs.tf	Apigee add paid only variables and examples	2021-08-05 13:21:57 +02:00
variables.tf	Apigee module variable description fixes	2021-08-05 15:53:44 +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 X Instance Module

This module allows managing a single Apigee X instance and its environment attachments.

Examples

Apigee X Evaluation Instance

module "apigee-x-instance" {
  source             = "./modules/apigee-x-instance"
  name               = "my-us-instance"
  region             = "us-central1"
  cidr_mask          = 22

  apigee_org_id      = "my-project"
  apigee_environments = [
    "eval1",
    "eval2"
  ]
}
# tftest:modules=1:resources=3

Apigee X Paid Instance

module "apigee-x-instance" {
  source              = "./modules/apigee-x-instance"
  name                = "my-us-instance"
  region              = "us-central1"
  cidr_mask           = 16
  disk_encryption_key = "my-disk-key"

  apigee_org_id       = "my-project"
  apigee_environments = [
    "dev1",
    "dev2",
    "test1",
    "test2"
  ]
}
# tftest:modules=1:resources=5

Variables

name	description	type	required	default
apigee_org_id	Apigee Organization ID	`string`	✓
cidr_mask	CIDR mask for the Apigee instance	`number`	✓
name	Apigee instance name.	`string`	✓
region	Compute region.	`string`	✓
apigee_envgroups	Apigee Environment Groups.	`map(object({…}))`		`{}`
apigee_environments	Apigee Environment Names.	`list(string)`		`[]`
disk_encryption_key	Customer Managed Encryption Key (CMEK) self link (e.g. `projects/foo/locations/us/keyRings/bar/cryptoKeys/baz`) used for disk and volume encryption (required for PAID Apigee Orgs only).	`string`		`null`

Outputs

name	description	sensitive
endpoint	Internal endpoint of the Apigee instance.
id	Apigee instance ID.
instance	Apigee instance.
port	Port number of the internal endpoint of the Apigee instance.