From 54c82cc13f0389efcb6b30321d20656d61d7213f Mon Sep 17 00:00:00 2001 From: Daniel Panzella Date: Tue, 19 Nov 2024 14:49:08 -0800 Subject: [PATCH] chore: more README.md --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a2e09d9..6e62588d 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Filestream requires both BigTable and PubSub to be enabled. Runs V2 requires PubSub to be enabled. Recommended to enable all four variables: -```shell +```terraform enable_filestream = true enable_flat_run_fields_updater = true create_pubsub = true @@ -80,13 +80,43 @@ create_bigtable = true ``` The BigTable Instance currently defaults to scale to 3 nodes, adjust this with: -```shell +```terraform bigtable_max_nodes = 3 bigtable_min_nodes = 1 ``` Upgrading an existing cluster to enable Filestream and Runs V2 is not yet tested. +Filestream and the flat run fields updater do not have autoscaling enabled, so their replica counts may need to be +adjusted manually via the user-spec +```yaml +values: + filestream: + replicaCount: 1 + flatRunFieldsUpdater: + replicaCount: 1 +``` +or enable autoscaling +```yaml +values: + filestream: + autoscaling: + enabled: true + minReplicas: 1 + maxReplicas: 10 + targetCPUUtilization: 70 + flatRunFieldsUpdater: + autoscaling: + enabled: true + minReplicas: 1 + maxReplicas: 10 + targetCPUUtilization: 70 +``` + +Application resources may not currently be ideal for autoscaling and updating them may be desirable in that case. They can +also be specified in the user-spec. + + ## Examples We have included documentation and reference examples for common