Skip to content

Commit 743afbb

Browse files
committed
Update local_installation documentation and mark jobsNamespace override as REQUIRED
1 parent e4d7cf2 commit 743afbb

File tree

3 files changed

+31
-23
lines changed

3 files changed

+31
-23
lines changed

.secrets.baseline

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
"filename": "docs/local_installation.md",
152152
"hashed_secret": "08d2e98e6754af941484848930ccbaddfefe13d6",
153153
"is_verified": false,
154-
"line_number": 88
154+
"line_number": 90
155155
}
156156
],
157157
"docs/s3.md": [
@@ -209,5 +209,5 @@
209209
}
210210
]
211211
},
212-
"generated_at": "2026-01-09T21:30:34Z"
212+
"generated_at": "2026-02-03T17:56:09Z"
213213
}

docs/gen3-deployment.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,8 @@ gen3-workflow:
1717
1818
## 2. Configure Gen3Workflow
1919
20-
You can customize Gen3Workflow by overriding values under `gen3WorkflowConfig` in your `values.yaml`.
21-
22-
The default configuration is available here:
23-
[gen3-workflow/values.yaml#L308](https://github.com/uc-cdis/gen3-helm/blob/master/helm/gen3-workflow/values.yaml#L308)
24-
(See `.Values.gen3WorkflowConfig`)
20+
* You can customize Gen3Workflow by overriding values under `gen3WorkflowConfig` in your `values.yaml`.
21+
* The default configuration is available here: [gen3-workflow/values.yaml#L308](https://github.com/uc-cdis/gen3-helm/blob/master/helm/gen3-workflow/values.yaml#L308) (See `.Values.gen3WorkflowConfig`)
2522

2623
---
2724

@@ -59,10 +56,8 @@ Gen3Workflow requires specific IAM roles and policies.
5956
6057
## 5. Authorization Setup
6158
62-
Update your `user.yaml` as described in the authorization guide:
63-
* [Authorization Documentation](authorization.md)
64-
65-
After updating, run the `usersync` job to apply the changes.
59+
* Update your `user.yaml` as described in the authorization guide: **[Authorization Documentation](authorization.md)**
60+
* After updating, run the `usersync` job to apply the changes.
6661
6762
---
6863
@@ -81,8 +76,19 @@ gen3WorkflowConfig:
8176
jobsNamespace: <jobs-namespace>
8277
```
8378

84-
**Recommendation:**
85-
Use a naming convention such as: `workflow-pods-<release-namespace>`
79+
### **Requirement: JobsNamespace Naming Convention**
80+
81+
Funnel supports any Kubernetes-compatible value for `JobsNamespace`. However, when using Funnel together with **Gen3 Workflow**, a specific naming convention is required.
82+
83+
> **Required:**
84+
> Users **must** set `JobsNamespace` to:
85+
>
86+
> ```
87+
> workflow-pods-<release-namespace>
88+
> ```
89+
90+
This naming convention is required to ensure correct integration and expected behavior between Gen3 Workflow and Funnel. Using a different value may result in deployment issues or unexpected runtime behavior.
91+
8692
8793
Example:
8894
@@ -93,16 +99,16 @@ gen3WorkflowConfig:
9399
jobsNamespace: workflow-pods-qa-midrc
94100
```
95101
96-
### 7. Helm Chart architecture
97-
* More information regarding how the helm chart is designed can be found in this document -- [WIP-Placeholder link](#placeholder_link)
102+
## 7. Helm Chart Architecture
98103

99-
---
100-
101-
## Documentation WIP
104+
* For more details on how the Helm chart is designed, refer to the [Helm Chart Architecture](architecture.md#helm-chart-architecture) document.
102105

103-
9. Follow [these steps](local_installation.md#run-nextflow-workflows-with-gen3workflow) to test the deployment.
106+
## 8. Nextflow tests
107+
* Follow the steps in [Run Nextflow workflows with Gen3Workflow](local_installation.md#run-nextflow-workflows-with-gen3workflow) to test the deployment using Nextflow workflows.
108+
* When deploying Gen3 Workflow to a Gen3 instance, ensure **Gen3Workflow URL** is set to your commons' endpoint URL.
109+
---
104110

105-
## Automation notes
111+
## 9. Automation notes
106112

107113
Some manual steps are currently necessary to deploy Gen3Workflow to a new Gen3 instance.
108114

docs/local_installation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ python run.py
6767

6868
Try out the API at <http://localhost:8080/_status> or <http://localhost:8080/docs> (you might have to set `DOCS_URL_PREFIX` to `""` in your configuration file for the docs endpoint to work).
6969

70+
>Note: Although the gen3-workflow service can run as a standalone component, a complete end-to-end experience with Funnel and the Funnel plugin requires interaction with the Fence service. While support for this workflow is planned for future releases, it is not currently supported out of the box.
71+
7072
## Run Nextflow workflows with Gen3Workflow
7173

7274
- Hit the `/storage/info` endpoint to get your working directory
@@ -113,7 +115,7 @@ gen3 run nextflow run hello
113115

114116
## AWS access
115117

116-
For full functionality, the Gen3Workflow service requires access to perform a number of operations in AWS. The full policy can be found [here](https://github.com/uc-cdis/cloud-automation/blob/master/gen3/bin/kube-setup-gen3-workflow.sh).
118+
For full functionality, the Gen3Workflow service requires access to perform a number of operations in AWS. The full policy can be found here -- [gen3-workflow/templates/crossplane.yaml](https://github.com/uc-cdis/gen3-helm/blob/master/helm/gen3-workflow/templates/crossplane.yaml)
117119

118120
## Quickstart with Helm
119121

@@ -168,5 +170,5 @@ You can also store your images in a local registry. Kind and Minikube are popula
168170
- https://minikube.sigs.k8s.io/docs/handbook/registry/#enabling-insecure-registries
169171

170172
Dependencies:
171-
Gen3Workflow relies on Arborist to run. Please view the [Arborist Quick Start Guide](https://github.com/uc-cdis/arborist) for more information.
172-
Gen3Workflow also relies on [Funnel](https://ohsu-comp-bio.github.io/funnel) with [Funnel-gen3-plugin](https://github.com/uc-cdis/funnel-gen3-plugin) and [Fence]((https://github.com/uc-cdis/fence))
173+
* Gen3Workflow relies on Arborist to run. Please view the [Arborist Quick Start Guide](https://github.com/uc-cdis/arborist) for more information.
174+
* Gen3Workflow also relies on [Funnel](https://ohsu-comp-bio.github.io/funnel) with [Funnel-gen3-plugin](https://github.com/uc-cdis/funnel-gen3-plugin) and [Fence]((https://github.com/uc-cdis/fence))

0 commit comments

Comments
 (0)