From 561d2055221f2ee0f42e4baa4b5a2f42b9974299 Mon Sep 17 00:00:00 2001 From: Daniel Strebel Date: Mon, 18 Dec 2023 07:05:53 +0100 Subject: [PATCH] doc: auto-generated tf docs --- modules/apigee-x-core/README.md | 50 --------------------------------- 1 file changed, 50 deletions(-) diff --git a/modules/apigee-x-core/README.md b/modules/apigee-x-core/README.md index 5885fff..cbf2048 100644 --- a/modules/apigee-x-core/README.md +++ b/modules/apigee-x-core/README.md @@ -1,55 +1,5 @@ # Apigee Core Setup -## Providers - -| Name | Version | -|------|---------| -| [google-beta](#provider\_google-beta) | >= 4.20.0 | - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [apigee](#module\_apigee) | github.com/terraform-google-modules/cloud-foundation-fabric//modules/apigee | v26.0.0 | -| [kms-inst-disk](#module\_kms-inst-disk) | github.com/terraform-google-modules/cloud-foundation-fabric//modules/kms | v26.0.0 | -| [kms-org-db](#module\_kms-org-db) | github.com/terraform-google-modules/cloud-foundation-fabric//modules/kms | v26.0.0 | - -## Resources - -| Name | Type | -|------|------| -| [google-beta_google_project_service_identity.apigee_sa](https://registry.terraform.io/providers/hashicorp/google-beta/latest/docs/resources/google_project_service_identity) | resource | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `{}` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string, "Terraform-managed")
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
  }))
| `null` | no | -| [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL). | 
map(object({
    region               = string
    ip_range             = string
    environments         = list(string)
    keyring_create       = optional(bool, true)
    keyring_name         = optional(string, null)
    keyring_location     = optional(string, null)
    key_name             = optional(string, "inst-disk")
    key_rotation_period  = optional(string, "2592000s")
    key_labels           = optional(map(string), null)
    consumer_accept_list = optional(list(string), null)
  }))
| `{}` | no | -| [ax\_region](#input\_ax\_region) | GCP region for storing Apigee analytics data (see https://cloud.google.com/apigee/docs/api-platform/get-started/install-cli). | `string` | n/a | yes | -| [billing\_type](#input\_billing\_type) | Billing type of the Apigee organization. | `string` | `null` | no | -| [network](#input\_network) | Network (self-link) to peer with the Apigee tennant project. | `string` | n/a | yes | -| [org\_description](#input\_org\_description) | Apigee org description | `string` | `"Apigee org created in TF"` | no | -| [org\_display\_name](#input\_org\_display\_name) | Apigee org display name | `string` | `null` | no | -| [org\_key\_rotation\_period](#input\_org\_key\_rotation\_period) | Rotaton period for the organization DB encryption key | `string` | `"2592000s"` | no | -| [org\_kms\_keyring\_create](#input\_org\_kms\_keyring\_create) | Set to false to manage the keyring for the Apigee Organization DB and IAM bindings in an existing keyring. | `bool` | `true` | no | -| [org\_kms\_keyring\_location](#input\_org\_kms\_keyring\_location) | Location of the KMS Key Ring for Apigee Organization DB. Matches AX region if not provided. | `string` | `null` | no | -| [org\_kms\_keyring\_name](#input\_org\_kms\_keyring\_name) | Name of the KMS Key Ring for Apigee Organization DB. | `string` | `"apigee-x-org"` | no | -| [project\_id](#input\_project\_id) | Project id (also used for the Apigee Organization). | `string` | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| [envgroups](#output\_envgroups) | Apigee Environment Groups | -| [environments](#output\_environments) | Apigee Environments | -| [instance\_endpoints](#output\_instance\_endpoints) | Map of instance name -> internal runtime endpoint IP address | -| [instance\_map](#output\_instance\_map) | Map of instance region -> instance object | -| [instance\_service\_attachments](#output\_instance\_service\_attachments) | Map of instance region -> instance PSC service attachment | -| [org\_id](#output\_org\_id) | Apigee Organization ID in the format of 'organizations/' | -| [organization](#output\_organization) | Apigee Organization. | - ## Providers