cloud-foundation-fabric/modules/endpoints
Lorenzo Caggioni 825a159990 Correct typos
Rename module to be consistent with the real name of the GCP service
Add link to the module on READMEs
2020-06-24 17:59:57 +02:00
..
README.md Correct typos 2020-06-24 17:59:57 +02:00
main.tf Correct typos 2020-06-24 17:59:57 +02:00
outputs.tf Correct typos 2020-06-24 17:59:57 +02:00
variables.tf Correct typos 2020-06-24 17:59:57 +02:00
versions.tf Correct typos 2020-06-24 17:59:57 +02:00

README.md

Google Cloud Endpoints

This module allows simple management of 'Google Cloud Endpoints' services. It supports creating 'OpenAPI' or 'gRPC' endpoints.

Examples

OpenAPI

module "endpoint" {
  source         = "../../modules/endpoint"
  project_id     = "my-project"
  service_name   = "my-project"
  openapi_config = "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
  iam_roles      = ["servicemanagement.serviceController"]
  iam_members    = {
    "servicemanagement.serviceController" = ["serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com"]
  }
}

Here you can find an example of an openapi.yaml file. Once created the endpoint, remember to activate the service at project level.

Variables

name description type required default
grpc_config The configuration for a gRPC enpoint. Either this, openapi_config must be specified. object({...})
openapi_config The configuration for an OpenAPI endopoint. Either this, grpc_config must be specified. object({...})
service_name The name of the service. Usually of the form '$apiname.endpoints.$projectid.cloud.goog'. string
iam_members Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved. map(list(string)) {}
iam_roles Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. list(string) []
project_id The project ID that the service belongs to. string null

Outputs

name description sensitive
endpoints A list of Endpoint objects.
endpoints_service The Endpoint service resource.
service_name The name of the service..