From 2b9e95df16d0f862e3684d303920efdc08abd953 Mon Sep 17 00:00:00 2001 From: Daniel Strebel Date: Tue, 9 Jan 2024 07:22:34 +0100 Subject: [PATCH] fix: Correct docs check and update samples to include new type argument --- .github/actions/update-docs/entrypoint.sh | 9 ++++++++- modules/apigee-x-core/README.md | 2 +- samples/x-basic/README.md | 2 +- samples/x-controlled-internet-egress/README.md | 2 +- samples/x-ilb-mtls/README.md | 2 +- samples/x-l4xlb-mtls/README.md | 2 +- samples/x-l7xlb/README.md | 2 +- samples/x-multi-region/README.md | 2 +- samples/x-nb-psc-l7ilb/README.md | 2 +- samples/x-nb-psc-xlb/README.md | 2 +- samples/x-sb-psc/README.md | 2 +- samples/x-shared-vpc/README.md | 2 +- samples/x-transitive-peering/README.md | 2 +- 13 files changed, 20 insertions(+), 13 deletions(-) diff --git a/.github/actions/update-docs/entrypoint.sh b/.github/actions/update-docs/entrypoint.sh index bbfefb6..47727e6 100755 --- a/.github/actions/update-docs/entrypoint.sh +++ b/.github/actions/update-docs/entrypoint.sh @@ -19,6 +19,13 @@ set -e template_string="$(cat .github/actions/update-docs/sample-instructions.template.md)" export template_string + +# create a copy to compare docs updates +workdir=$PWD +original_content_clone=$PWD/../docs-clone +(cd .. && cp -r "$workdir" "$original_content_clone") + +# run terraform docs for TYPE in samples modules; do for D in "$TYPE"/*; do # set the generic sample instructions if required @@ -30,7 +37,7 @@ for TYPE in samples modules; do done done -changes=$(git diff --name-only | grep 'README.md$' || true ) +changes=$(git diff --name-only --no-index -- "$original_content_clone" "$workdir" | grep 'README.md$' || true ) if [ -z "$changes" ];then echo "Docs Are up to date 🎉" diff --git a/modules/apigee-x-core/README.md b/modules/apigee-x-core/README.md index 5c50d96..15c1e43 100644 --- a/modules/apigee-x-core/README.md +++ b/modules/apigee-x-core/README.md @@ -26,7 +26,7 @@ | 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)
    type = optional(string)
  }))
| `null` | 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)))
    type      = optional(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 | diff --git a/samples/x-basic/README.md b/samples/x-basic/README.md index fb7ae89..42c36b9 100644 --- a/samples/x-basic/README.md +++ b/samples/x-basic/README.md @@ -67,7 +67,7 @@ No resources. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-controlled-internet-egress/README.md b/samples/x-controlled-internet-egress/README.md index 825cad2..eaffc75 100644 --- a/samples/x-controlled-internet-egress/README.md +++ b/samples/x-controlled-internet-egress/README.md @@ -86,7 +86,7 @@ terraform apply --var-file=./my-config.tfvars -var "project_id=$PROJECT_ID" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-ilb-mtls/README.md b/samples/x-ilb-mtls/README.md index c5c592e..6ee9109 100644 --- a/samples/x-ilb-mtls/README.md +++ b/samples/x-ilb-mtls/README.md @@ -103,7 +103,7 @@ terraform apply --var-file=./my-config.tfvars -var "project_id=$PROJECT_ID" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-l4xlb-mtls/README.md b/samples/x-l4xlb-mtls/README.md index 62dc326..02b37a9 100644 --- a/samples/x-l4xlb-mtls/README.md +++ b/samples/x-l4xlb-mtls/README.md @@ -124,7 +124,7 @@ curl https://my-domain.com/my-proxy --cert ./certs/example-client.crt --key ./ce | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-l7xlb/README.md b/samples/x-l7xlb/README.md index 5c7789d..fab30a2 100644 --- a/samples/x-l7xlb/README.md +++ b/samples/x-l7xlb/README.md @@ -71,7 +71,7 @@ No resources. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-multi-region/README.md b/samples/x-multi-region/README.md index 55510ce..314636b 100644 --- a/samples/x-multi-region/README.md +++ b/samples/x-multi-region/README.md @@ -75,7 +75,7 @@ No resources. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-nb-psc-l7ilb/README.md b/samples/x-nb-psc-l7ilb/README.md index 68f9bf5..af18b8e 100644 --- a/samples/x-nb-psc-l7ilb/README.md +++ b/samples/x-nb-psc-l7ilb/README.md @@ -73,7 +73,7 @@ terraform apply --var-file=./my-config.tfvars -var "project_id=$PROJECT_ID" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances\_metadata](#input\_apigee\_instances\_metadata) | Metadata for Apigee Instances (only one instance for EVAL orgs) along with L7 ILB configuration. | 
map(object({
    apigee_instances = object({
      region       = string
      ip_range     = string
      environments = list(string)
    })
    l7_ilb_proxy_subnet_name       = string
    l7_ilb_proxy_subnet_cidr_range = string
    l7_ilb_name_prefix             = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-nb-psc-xlb/README.md b/samples/x-nb-psc-xlb/README.md index 4afe77b..60d00de 100644 --- a/samples/x-nb-psc-xlb/README.md +++ b/samples/x-nb-psc-xlb/README.md @@ -74,7 +74,7 @@ terraform apply --var-file=./my-config.tfvars -var "project_id=$PROJECT_ID" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-sb-psc/README.md b/samples/x-sb-psc/README.md index 8b7193a..66b7508 100644 --- a/samples/x-sb-psc/README.md +++ b/samples/x-sb-psc/README.md @@ -88,7 +88,7 @@ psc_endpoint_attachment_connection_state = "ACCEPTED" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = list(string)
  }))
| `null` | no | | [ax\_region](#input\_ax\_region) | GCP region for storing Apigee analytics data (sxee https://cloud.google.com/apigee/docs/api-platform/get-started/install-cli). | `string` | n/a | yes | | [backend\_name](#input\_backend\_name) | Name for the Demo Backend | `string` | `"demo-backend"` | no | diff --git a/samples/x-shared-vpc/README.md b/samples/x-shared-vpc/README.md index dd13498..8b77dbf 100644 --- a/samples/x-shared-vpc/README.md +++ b/samples/x-shared-vpc/README.md @@ -71,7 +71,7 @@ No resources. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = 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\_account](#input\_billing\_account) | Billing account id. | `string` | `null` | no | diff --git a/samples/x-transitive-peering/README.md b/samples/x-transitive-peering/README.md index 19cc43f..e958841 100644 --- a/samples/x-transitive-peering/README.md +++ b/samples/x-transitive-peering/README.md @@ -93,7 +93,7 @@ terraform apply --var-file=./my-config.tfvars -var "project_id=$PROJECT_ID" | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apigee\_envgroups](#input\_apigee\_envgroups) | Apigee Environment Groups. | 
map(object({
    hostnames = list(string)
  }))
| `null` | no | -| [apigee\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    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\_environments](#input\_apigee\_environments) | Apigee Environments. | 
map(object({
    display_name = optional(string)
    description  = optional(string)
    node_config = optional(object({
      min_node_count = optional(number)
      max_node_count = optional(number)
    }))
    iam       = optional(map(list(string)))
    envgroups = list(string)
    type      = optional(string)
  }))
| `null` | no | | [apigee\_instances](#input\_apigee\_instances) | Apigee Instances (only one instance for EVAL orgs). | 
map(object({
    region       = string
    ip_range     = string
    environments = list(string)
  }))
| `null` | no | | [apigee\_network](#input\_apigee\_network) | Apigee VPC name. | `string` | n/a | yes | | [appliance\_forwarded\_ranges](#input\_appliance\_forwarded\_ranges) | CDIR ranges that should route via the network appliance | 
map(object({
    range    = string
    priority = number
  }))
| `{}` | no |