From e2ea0b61bba3f7f80a3ce3c3c01dd9b81b3422a2 Mon Sep 17 00:00:00 2001 From: mkdior Date: Sun, 7 Jan 2024 15:16:37 +0100 Subject: [PATCH] ~ adjust default values --- packages/gcp-cloud-run/README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/gcp-cloud-run/README.md b/packages/gcp-cloud-run/README.md index 7bb3f56a..84efd43a 100644 --- a/packages/gcp-cloud-run/README.md +++ b/packages/gcp-cloud-run/README.md @@ -29,18 +29,18 @@ npm install -D @nx-extend/gcp-cloud-run | **`--maxInstances`** | `number` | 10 | Maximum number of container instances to run. | **`--minInstances`** | `number` | 0 | Minimum number of container instances to run. | **`--allowUnauthenticated`** | `boolean` | `true` | Whether to allow unauthenticated requests to cloud run service. -| **`--envVars`** | `{string: string}` | 0 | Environment variables to load into cloud run instance's environment. -| **`--secrets`** | `string[]` | 0 | Secrets to load into cloud run instance's environment. +| **`--envVars`** | `{[k: string]: string}` | - | Environment variables to load into cloud run instance's environment. +| **`--secrets`** | `string[]` | - | Secrets to load into cloud run instance's environment. | **`--memory`** | `string` | `128Mi` | Amount of memory to reserve for cloud run instance. -| **`--cloudSqlInstance`** | `string` | 0 | Name of the cloud SQL instance to connect to run instance. -| **`--http2`** | `boolean` | 0 | Whether or not to enforce run instance to use HTTP/2 for all end-to-end connections. -| **`--serviceAccount`** | `string` | 0 | Service account email of another identity if not using compute engine's default service account. +| **`--cloudSqlInstance`** | `string` | - | Name of the cloud SQL instance to connect to run instance. +| **`--http2`** | `boolean` | `false` | Whether or not to enforce run instance to use HTTP/2 for all end-to-end connections. +| **`--serviceAccount`** | `string` | - | Service account email of another identity if not using compute engine's default service account. | **`--buildWith`** | `string` | `artifact-registry` | Only accepts value `artifact-registry`. ***If provided***, deploy is ran with the `--source` options set to current app's directory. ***If not provided***, submits a build to Cloud Build, sourcing app's dist directory. Deploy is then ran using `--image`, which is given the location of the previous Cloud Build's built image. -| **`--logsDir`** | `string` | 0 | ***Note***: only relevant if not specifying `--buildWith`. Directory in GCS where to hold Cloud Build's build logs. -| **`--tagWithVersion`** | `string` | 0 | Whether or not to tag run service with a version. (**note**: sources version from package.json) -| **`--noTraffic`** | `boolean` | 0 | Set to true to ensure cloud run avoids sending traffic to the revision being deployed. -| **`--revisionSuffix`** | `string` | 0 | Set to append to deployed revision's name. -| **`--timeout`** | `number` | 0 | set the maximum request execution time. -| **`--cpu`** | `number` | 0 | set a CPU limit in Kubernetes cpu units. -| **`--cpuBoost`** | `boolean` | 0 | Whether to allocate extra CPU to containers on startup to reduce the perceived latency of a cold start request. -| **`--ingress`** | `string` | 0 | Set the ingress traffic sources allowed to call the service. +| **`--logsDir`** | `string` | - | ***Note***: only relevant if not specifying `--buildWith`. Directory in GCS where to hold Cloud Build's build logs. +| **`--tagWithVersion`** | `string` | - | Whether or not to tag run service with a version. (**note**: sources version from package.json) +| **`--noTraffic`** | `boolean` | `false` | Set to true to ensure cloud run avoids sending traffic to the revision being deployed. +| **`--revisionSuffix`** | `boolean` | `false` | Set to append to deployed revision's name. +| **`--timeout`** | `number` | - | set the maximum request execution time. +| **`--cpu`** | `number` | - | set a CPU limit in Kubernetes cpu units. +| **`--cpuBoost`** | `boolean` | - | Whether to allocate extra CPU to containers on startup to reduce the perceived latency of a cold start request. +| **`--ingress`** | `string` | - | Set the ingress traffic sources allowed to call the service.