diff --git a/blueprints/cloud-operations/network-dashboard/deploy-cloud-function/README.md b/blueprints/cloud-operations/network-dashboard/deploy-cloud-function/README.md index acee13ee8d..1e917f8834 100644 --- a/blueprints/cloud-operations/network-dashboard/deploy-cloud-function/README.md +++ b/blueprints/cloud-operations/network-dashboard/deploy-cloud-function/README.md @@ -59,32 +59,29 @@ A monitoring dashboard can be optionally be deployed int he same project by sett dashboard_json_path = "../dashboards/quotas-utilization.json" ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [discovery_config](variables.tf#L48) | Discovery configuration. Discovery root is the organization or a folder. If monitored folders and projects are empty, every project under the discovery root node will be monitored. | object({…}) | ✓ | | -| [project_id](variables.tf#L100) | Project id where the Cloud Function will be deployed. | string | ✓ | | +| [discovery_config](variables.tf#L49) | Discovery configuration. Discovery root is the organization or a folder. If monitored folders and projects are empty, every project under the discovery root node will be monitored. | object({…}) | ✓ | | +| [project_id](variables.tf#L101) | Project id where the Cloud Function will be deployed. | string | ✓ | | | [bundle_path](variables.tf#L17) | Path used to write the intermediate Cloud Function code bundle. | string | | "./bundle.zip" | -| [cloud_function_config](variables.tf#L23) | Optional Cloud Function configuration. | object({…}) | | {} | -| [dashboard_json_path](variables.tf#L42) | Optional monitoring dashboard to deploy. | string | | null | -| [grant_discovery_iam_roles](variables.tf#L66) | Optionally grant required IAM roles to Cloud Function service account. | bool | | false | -| [labels](variables.tf#L73) | Billing labels used for the Cloud Function, and the project if project_create is true. | map(string) | | {} | -| [monitoring_project](variables.tf#L79) | Project where generated metrics will be written. Default is to use the same project where the Cloud Function is deployed. | string | | null | -| [name](variables.tf#L85) | Name used to create Cloud Function related resources. | string | | "net-dash" | -| [project_create_config](variables.tf#L91) | Optional configuration if project creation is required. | object({…}) | | null | -| [region](variables.tf#L105) | Compute region where the Cloud Function will be deployed. | string | | "europe-west1" | -| [schedule_config](variables.tf#L111) | Schedule timer configuration in crontab format. | string | | "*/30 * * * *" | +| [cloud_function_config](variables.tf#L23) | Optional Cloud Function configuration. | object({…}) | | {} | +| [dashboard_json_path](variables.tf#L43) | Optional monitoring dashboard to deploy. | string | | null | +| [grant_discovery_iam_roles](variables.tf#L67) | Optionally grant required IAM roles to Cloud Function service account. | bool | | false | +| [labels](variables.tf#L74) | Billing labels used for the Cloud Function, and the project if project_create is true. | map(string) | | {} | +| [monitoring_project](variables.tf#L80) | Project where generated metrics will be written. Default is to use the same project where the Cloud Function is deployed. | string | | null | +| [name](variables.tf#L86) | Name used to create Cloud Function related resources. | string | | "net-dash" | +| [project_create_config](variables.tf#L92) | Optional configuration if project creation is required. | object({…}) | | null | +| [region](variables.tf#L106) | Compute region where the Cloud Function will be deployed. | string | | "europe-west1" | +| [schedule_config](variables.tf#L112) | Schedule timer configuration in crontab format. | string | | "*/30 * * * *" | ## Outputs | name | description | sensitive | |---|---|:---:| | [bucket](outputs.tf#L17) | Cloud Function deployment bucket resource. | | -| [cloud-function](outputs.tf#L22) | Cloud Function resource. | | -| [project_id](outputs.tf#L27) | Project id. | | -| [service_account](outputs.tf#L32) | Cloud Function service account. | | -| [troubleshooting_payload](outputs.tf#L40) | Cloud Function payload used for manual triggering. | ✓ | - +| [project_id](outputs.tf#L22) | Project id. | | +| [service_account](outputs.tf#L27) | Cloud Function service account. | | +| [troubleshooting_payload](outputs.tf#L35) | Cloud Function payload used for manual triggering. | ✓ |