2021-08-05 02:57:22 -07:00
# Google Apigee Organization Module
2021-08-04 08:09:44 -07:00
2021-08-05 02:57:22 -07:00
This module allows managing a single Apigee organization and its environments and environmentgroups.
2021-08-04 08:09:44 -07:00
## Examples
### Apigee X Evaluation Organization
```hcl
2021-08-05 04:21:57 -07:00
module "apigee-organization" {
source = "./modules/apigee-organization"
2021-08-04 08:09:44 -07:00
project_id = "my-project"
analytics_region = "us-central1"
runtime_type = "CLOUD"
2021-08-05 02:57:22 -07:00
authorized_network = "my-vpc"
2021-08-04 08:09:44 -07:00
apigee_environments = [
"eval1",
"eval2"
]
apigee_envgroups = {
eval = {
environments = [
"eval1",
"eval2"
]
hostnames = [
"eval.api.example.com"
]
}
}
}
2021-08-05 02:57:22 -07:00
# tftest:modules=1:resources=6
2021-08-04 08:09:44 -07:00
```
2021-08-05 04:21:57 -07:00
### Apigee X Paid Organization
```hcl
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
2021-08-04 08:09:44 -07:00
```hcl
2021-08-05 04:21:57 -07:00
module "apigee-organization" {
source = "./modules/apigee-organization"
2021-08-04 08:09:44 -07:00
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
```
<!-- BEGIN TFDOC -->
2021-08-05 05:25:50 -07:00
## Variables
| name | description | type | required | default |
|---|---|:---: |:---:|:---:|
2021-08-05 06:55:23 -07:00
| analytics_region | Analytics Region for the Apigee Organization (immutable). See https://cloud.google.com/apigee/docs/api-platform/get-started/install-cli. | < code title = "" > string< / code > | ✓ | |
2021-08-05 05:25:50 -07:00
| project_id | Project ID to host this Apigee organization (will also become the Apigee Org name). | < code title = "" > string< / code > | ✓ | |
2021-10-08 09:26:04 -07:00
| runtime_type | Apigee runtime type. Must be `CLOUD` or `HYBRID` . | < code title = "string validation { condition = contains(["CLOUD", "HYBRID"], var.runtime_type) error_message = "Allowed values for runtime_type \"CLOUD\" or \"HYBRID\"." }" > string</ code > | ✓ | |
2021-08-12 08:30:53 -07:00
| *apigee_envgroups* | Apigee Environment Groups. | < code title = "map(object({ environments = list(string) hostnames = list(string) }))" > map(object({...}))</ code > | | < code title = "" > {}</ code > |
2021-08-05 05:25:50 -07:00
| *apigee_environments* | Apigee Environment Names. | < code title = "list(string)" > list(string)</ code > | | < code title = "" > []</ code > |
2021-08-05 06:55:23 -07:00
| *authorized_network* | VPC network self link (requires service network peering enabled (Used in Apigee X only). | < code title = "" > string</ code > | | < code title = "" > null</ code > |
| *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). | < code title = "" > string</ code > | | < code title = "" > null</ code > |
2021-08-05 05:25:50 -07:00
| *description* | Description of the Apigee Organization. | < code title = "" > string</ code > | | < code title = "" > Apigee Organization created by tf module</ code > |
| *display_name* | Display Name of the Apigee Organization. | < code title = "" > string</ code > | | < code title = "" > null</ code > |
## Outputs
| name | description | sensitive |
|---|---|:---:|
2021-11-24 09:50:38 -08:00
| envs | Apigee Environments. | |
2021-08-05 05:25:50 -07:00
| org | Apigee Organization. | |
| org_ca_certificate | Apigee organization CA certificate. | |
| org_id | Apigee Organization ID. | |
| subscription_type | Apigee subscription type. | |
2021-08-04 08:09:44 -07:00
<!-- END TFDOC -->