Skip to content

Commit c05f784

Browse files
Merge branch 'chore/add_helm_deployment_doc' of github.com:uc-cdis/gen3-workflow into chore/add_helm_deployment_doc
2 parents d19c9b9 + b821220 commit c05f784

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/gen3-deployment.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ global:
1717
pushSecret: true
1818
postgres:
1919
externalSecret: "<name of master Postgres secret in AWS Secrets Manager>"
20+
clusterName: "<name of the eks cluster where the gen3 instance is deployed>"
2021

2122
gen3-workflow: # <-- configure the Gen3Workflow chart
2223
enabled: true
@@ -53,6 +54,11 @@ funnel: # <-- configure the Gen3 Funnel chart
5354
>
5455
> Deploying Gen3Workflow also automatically creates a `funnel-oidc-job`, which creates a Fence client for the Funnel plugin and stores the client ID and secret in a `funnel-oidc-client` Kubernetes secret.
5556
> Note: The value `funnel.externalSecrets.funnelOidcClient` can be overridden to use a different secret name when external secrets are enabled. It is typically configured using the pattern: `<namespace>-funnel-oidc-client`.
57+
>
58+
> - *Cluster Configuration Requirement*
59+
>
60+
> Gen3Workflow requires the Gen3 Helm chart’s `.Values.global.clusterName` to be set to the name of the Amazon EKS cluster where Gen3 is deployed. While Gen3 strives to remain cloud-agnostic, Gen3Workflow currently requires Amazon EKS for supported operation. This value must be configured correctly to ensure proper deployment and integration.
61+
5662

5763
---
5864

0 commit comments

Comments
 (0)