diff --git a/README.md b/README.md index 71d2828..ed38f27 100644 --- a/README.md +++ b/README.md @@ -29,23 +29,6 @@ Bundles are the basic building blocks of infrastructure, applications, and archi ## Bundle - - - -Security and compliance scanning of our bundles is performed using [Bridgecrew](https://www.bridgecrew.cloud/). Massdriver also offers security and compliance scanning of operational infrastructure configured and deployed using the platform. - -| Benchmark | Description | -|--------|---------------| -| [![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=INFRASTRUCTURE+SECURITY) | Infrastructure Security Compliance | -| [![CIS GCP](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=CIS+GCP+V1.1) | Center for Internet Security, GCP Compliance | -| [![PCI-DSS](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=PCI-DSS+V3.2) | Payment Card Industry Data Security Standards Compliance | -| [![NIST-800-53](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=NIST-800-53) | National Institute of Standards and Technology Compliance | -| [![ISO27001](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=ISO27001) | Information Security Management System, ISO/IEC 27001 Compliance | -| [![SOC2](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=SOC2)| Service Organization Control 2 Compliance | -| [![HIPAA](https://www.bridgecrew.cloud/badges/github/massdriver-cloud/gcp-cloud-function-https/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=massdriver-cloud%2Fgcp-cloud-function-https&benchmark=HIPAA) | Health Insurance Portability and Accountability Compliance | - - - ### Params Form input parameters for configuring a bundle for deployment. @@ -158,18 +141,37 @@ Connections from other bundles that this bundle depends on. - **`specs`** *(object)* - **`gcp`** *(object)*: . - **`project`** *(string)* - - **`region`** *(string)*: GCP region. Must be one of: `['us-east1', 'us-east4', 'us-west1', 'us-west2', 'us-west3', 'us-west4', 'us-central1']`. + - **`region`** *(string)*: The GCP region to provision resources in. Examples: + ```json + "us-east1" + ``` + + ```json + "us-east4" + ``` + + ```json + "us-west1" + ``` + ```json "us-west2" ``` - - **`resource`** *(string)* - - **`service`** *(string)* - - **`zone`** *(string)*: GCP Zone. + ```json + "us-west3" + ``` + + ```json + "us-west4" + ``` + + ```json + "us-central1" + ``` - Examples: - **`subnetwork`** *(object)*: A region-bound network for deploying GCP resources. Cannot contain additional properties. - **`data`** *(object)* - **`infrastructure`** *(object)* @@ -238,21 +240,67 @@ Connections from other bundles that this bundle depends on. "projects/my-project/locations/us-west2/clusters/my-gke-cluster" ``` + - **`vpc_access_connector`** *(string)*: GCP Resource Name (GRN). + + Examples: + ```json + "projects/my-project/global/networks/my-global-network" + ``` + + ```json + "projects/my-project/regions/us-west2/subnetworks/my-subnetwork" + ``` + + ```json + "projects/my-project/topics/my-pubsub-topic" + ``` + + ```json + "projects/my-project/subscriptions/my-pubsub-subscription" + ``` + + ```json + "projects/my-project/locations/us-west2/instances/my-redis-instance" + ``` + + ```json + "projects/my-project/locations/us-west2/clusters/my-gke-cluster" + ``` + - **`specs`** *(object)* - **`gcp`** *(object)*: . - **`project`** *(string)* - - **`region`** *(string)*: GCP region. Must be one of: `['us-east1', 'us-east4', 'us-west1', 'us-west2', 'us-west3', 'us-west4', 'us-central1']`. + - **`region`** *(string)*: The GCP region to provision resources in. Examples: + ```json + "us-east1" + ``` + + ```json + "us-east4" + ``` + + ```json + "us-west1" + ``` + ```json "us-west2" ``` - - **`resource`** *(string)* - - **`service`** *(string)* - - **`zone`** *(string)*: GCP Zone. + ```json + "us-west3" + ``` + + ```json + "us-west4" + ``` + + ```json + "us-central1" + ``` - Examples: @@ -294,7 +342,7 @@ Resources created by this bundle that can be connected to other bundles. - **`security`** *(object)*: GCP Security Configuration. Cannot contain additional properties. - **`iam`** *(object)*: IAM Roles And Conditions. Cannot contain additional properties. - - **`^[a-z-/]+$`** *(object)* + - **`^[a-z]+[a-z_]*[a-z]$`** *(object)* - **`condition`** *(string)*: GCP IAM Condition. - **`role`**: GCP Role. @@ -318,18 +366,37 @@ Resources created by this bundle that can be connected to other bundles. - **`specs`** *(object)* - **`gcp`** *(object)*: . - **`project`** *(string)* - - **`region`** *(string)*: GCP region. Must be one of: `['us-east1', 'us-east4', 'us-west1', 'us-west2', 'us-west3', 'us-west4', 'us-central1']`. + - **`region`** *(string)*: The GCP region to provision resources in. Examples: + ```json + "us-east1" + ``` + + ```json + "us-east4" + ``` + + ```json + "us-west1" + ``` + ```json "us-west2" ``` - - **`resource`** *(string)* - - **`service`** *(string)* - - **`zone`** *(string)*: GCP Zone. + ```json + "us-west3" + ``` + + ```json + "us-west4" + ``` + + ```json + "us-central1" + ``` - Examples: