100 lines
3.7 KiB
Markdown
100 lines
3.7 KiB
Markdown
|
# Google Cloud Service Directory Module
|
||
|
|
|
||
|
|
This module allows managing a single [Service Directory](https://cloud.google.com/service-directory) namespace, including multiple services, endpoints and IAM bindings at the namespace and service levels.
|
||
|
|
|
||
|
|
It can be used in conjunction with the [DNS](../dns) module to create service-directory based DNS zones, offloading IAM control of `A` and `SRV` records at the namespace or service level to Service Directory. The last examples shows how to wire the two modules together.
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
### Namespace with IAM
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
module "service-directory" {
|
||
|
|
source = "./modules/service-directory"
|
||
|
|
project_id = "my-project
|
||
|
|
location = "europe-west1"
|
||
|
|
name = "sd-1"
|
||
|
|
iam_members = {
|
||
|
|
"roles/servicedirectory.editor" = [
|
||
|
|
"serviceAccount:namespace-editor@example.com"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
iam_roles = [
|
||
|
|
"roles/servicedirectory.editor"
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Services with IAM and endpoints
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
module "service-directory" {
|
||
|
|
source = "./modules/service-directory"
|
||
|
|
project_id = "my-project
|
||
|
|
location = "europe-west1"
|
||
|
|
name = "sd-1"
|
||
|
|
services = {
|
||
|
|
one = {
|
||
|
|
endpoints = ["first", "second"]
|
||
|
|
metadata = null
|
||
|
|
}
|
||
|
|
}
|
||
|
|
service_iam_members = {
|
||
|
|
one = {
|
||
|
|
"roles/servicedirectory.editor" = [
|
||
|
|
"serviceAccount:service-editor.example.com"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
service_iam_roles = {
|
||
|
|
one = ["roles/servicedirectory.editor"]
|
||
|
|
}
|
||
|
|
endpoint_config = {
|
||
|
|
"one/first" = { address = "127.0.0.1", port = 80, metadata = {} }
|
||
|
|
"one/second" = { address = "127.0.0.2", port = 80, metadata = {} }
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### DNS based zone
|
||
|
|
|
||
|
|
TODO
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
module "service-directory" {
|
||
|
|
source = "./modules/service-directory"
|
||
|
|
project_id = "my-project
|
||
|
|
location = "europe-west1"
|
||
|
|
name = "sd-1"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
<!-- BEGIN TFDOC -->
|
||
|
|
## Variables
|
||
|
|
|
||
|
|
| name | description | type | required | default |
|
||
|
|
|---|---|:---: |:---:|:---:|
|
||
|
|
| location | Namespace location. | <code title="">string</code> | ✓ | |
|
||
|
|
| name | Namespace name. | <code title="">string</code> | ✓ | |
|
||
|
|
| project_id | Project used for resources. | <code title="">string</code> | ✓ | |
|
||
|
|
| *endpoint_config* | Map of endpoint attributes, keys are in service/endpoint format. | <code title="map(object({ address = string port = number metadata = map(string) }))">map(object({...}))</code> | | <code title="">{}</code> |
|
||
|
|
| *iam_members* | IAM members for each namespace role. | <code title="map(list(string))">map(list(string))</code> | | <code title="">{}</code> |
|
||
|
|
| *iam_roles* | IAM roles for the namespace. | <code title="list(string)">list(string)</code> | | <code title="">[]</code> |
|
||
|
|
| *labels* | Labels. | <code title="map(string)">map(string)</code> | | <code title="">{}</code> |
|
||
|
|
| *service_iam_members* | IAM members for each service and role. | <code title="map(map(list(string)))">map(map(list(string)))</code> | | <code title="">{}</code> |
|
||
|
|
| *service_iam_roles* | IAM roles for each service. | <code title="map(list(string))">map(list(string))</code> | | <code title="">{}</code> |
|
||
|
|
| *services* | Service configuration, using service names as keys. | <code title="map(object({ endpoints = list(string) metadata = map(string) }))">map(object({...}))</code> | | <code title="">{}</code> |
|
||
|
|
|
||
|
|
## Outputs
|
||
|
|
|
||
|
|
| name | description | sensitive |
|
||
|
|
|---|---|:---:|
|
||
|
|
| endpoints | Endpoint resources. | |
|
||
|
|
| id | Namespace id (short name). | |
|
||
|
|
| name | Namespace name (long name). | |
|
||
|
|
| namespace | Namespace resource. | |
|
||
|
|
| service_id | Service ids (short names). | |
|
||
|
|
| service_names | Service ids (long names). | |
|
||
|
|
| services | Service resources. | |
|
||
|
|
<!-- END TFDOC -->
|