diff --git a/Makefile b/Makefile index c2571266..99407eae 100644 --- a/Makefile +++ b/Makefile @@ -77,9 +77,10 @@ docker_test_lint: .PHONY: docker_generate_docs docker_generate_docs: docker run --rm -it \ + -e ENABLE_BPMETADATA \ -v "$(CURDIR)":/workspace \ $(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \ - /bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs' + /bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs display' # Alias for backwards compatibility .PHONY: generate_docs diff --git a/metadata.display.yaml b/metadata.display.yaml new file mode 100644 index 00000000..5e7927c0 --- /dev/null +++ b/metadata.display.yaml @@ -0,0 +1,98 @@ +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +apiVersion: blueprints.cloud.google.com/v1alpha1 +kind: BlueprintMetadata +metadata: + name: terraform-google-memorystore-display + annotations: + config.kubernetes.io/local-config: "true" +spec: + info: + title: Google Cloud Memorystore Terraform Module + source: + repo: https://github.com/terraform-google-modules/terraform-google-memorystore.git + sourceType: git + ui: + input: + variables: + alternative_location_id: + name: alternative_location_id + title: Alternative Location Id + auth_enabled: + name: auth_enabled + title: Auth Enabled + authorized_network: + name: authorized_network + title: Authorized Network + connect_mode: + name: connect_mode + title: Connect Mode + customer_managed_key: + name: customer_managed_key + title: Customer Managed Key + display_name: + name: display_name + title: Display Name + enable_apis: + name: enable_apis + title: Enable Apis + labels: + name: labels + title: Labels + location_id: + name: location_id + title: Location Id + maintenance_policy: + name: maintenance_policy + title: Maintenance Policy + memory_size_gb: + name: memory_size_gb + title: Memory Size Gb + name: + name: name + title: Name + persistence_config: + name: persistence_config + title: Persistence Config + project: + name: project + title: Project + read_replicas_mode: + name: read_replicas_mode + title: Read Replicas Mode + redis_configs: + name: redis_configs + title: Redis Configs + redis_version: + name: redis_version + title: Redis Version + region: + name: region + title: Region + replica_count: + name: replica_count + title: Replica Count + reserved_ip_range: + name: reserved_ip_range + title: Reserved Ip Range + secondary_ip_range: + name: secondary_ip_range + title: Secondary Ip Range + tier: + name: tier + title: Tier + transit_encryption_mode: + name: transit_encryption_mode + title: Transit Encryption Mode diff --git a/modules/memcache/metadata.display.yaml b/modules/memcache/metadata.display.yaml new file mode 100644 index 00000000..10a8da53 --- /dev/null +++ b/modules/memcache/metadata.display.yaml @@ -0,0 +1,72 @@ +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +apiVersion: blueprints.cloud.google.com/v1alpha1 +kind: BlueprintMetadata +metadata: + name: terraform-google-memorystore-display + annotations: + config.kubernetes.io/local-config: "true" +spec: + info: + title: Google Cloud Memorystore Terraform Module + source: + repo: https://github.com/terraform-google-modules/terraform-google-memorystore.git + sourceType: git + dir: /modules/memcache + ui: + input: + variables: + authorized_network: + name: authorized_network + title: Authorized Network + cpu_count: + name: cpu_count + title: Cpu Count + display_name: + name: display_name + title: Display Name + enable_apis: + name: enable_apis + title: Enable Apis + labels: + name: labels + title: Labels + maintenance_policy: + name: maintenance_policy + title: Maintenance Policy + memcache_version: + name: memcache_version + title: Memcache Version + memory_size_mb: + name: memory_size_mb + title: Memory Size Mb + name: + name: name + title: Name + node_count: + name: node_count + title: Node Count + params: + name: params + title: Params + project: + name: project + title: Project + region: + name: region + title: Region + zones: + name: zones + title: Zones diff --git a/modules/redis-cluster/metadata.display.yaml b/modules/redis-cluster/metadata.display.yaml new file mode 100644 index 00000000..007be205 --- /dev/null +++ b/modules/redis-cluster/metadata.display.yaml @@ -0,0 +1,72 @@ +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +apiVersion: blueprints.cloud.google.com/v1alpha1 +kind: BlueprintMetadata +metadata: + name: terraform-google-memorystore-display + annotations: + config.kubernetes.io/local-config: "true" +spec: + info: + title: Memorystore Redis Cluster Terraform Module + source: + repo: https://github.com/terraform-google-modules/terraform-google-memorystore.git + sourceType: git + dir: /modules/redis-cluster + ui: + input: + variables: + authorization_mode: + name: authorization_mode + title: Authorization Mode + enable_apis: + name: enable_apis + title: Enable Apis + name: + name: name + title: Name + network: + name: network + title: Network + node_type: + name: node_type + title: Node Type + project: + name: project + title: Project + redis_configs: + name: redis_configs + title: Redis Configs + region: + name: region + title: Region + replica_count: + name: replica_count + title: Replica Count + service_connection_policies: + name: service_connection_policies + title: Service Connection Policies + shard_count: + name: shard_count + title: Shard Count + transit_encryption_mode: + name: transit_encryption_mode + title: Transit Encryption Mode + zone_distribution_config_mode: + name: zone_distribution_config_mode + title: Zone Distribution Config Mode + zone_distribution_config_zone: + name: zone_distribution_config_zone + title: Zone Distribution Config Zone