You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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`)
25
22
26
23
---
27
24
@@ -59,10 +56,8 @@ Gen3Workflow requires specific IAM roles and policies.
59
56
60
57
## 5. Authorization Setup
61
58
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.
66
61
67
62
---
68
63
@@ -81,8 +76,19 @@ gen3WorkflowConfig:
81
76
jobsNamespace: <jobs-namespace>
82
77
```
83
78
84
-
**Recommendation:**
85
-
Use a naming convention such as: `workflow-pods-<release-namespace>`
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
+
86
92
87
93
Example:
88
94
@@ -93,16 +99,16 @@ gen3WorkflowConfig:
93
99
jobsNamespace: workflow-pods-qa-midrc
94
100
```
95
101
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
98
103
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.
102
105
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
+
---
104
110
105
-
## Automation notes
111
+
## 9. Automation notes
106
112
107
113
Some manual steps are currently necessary to deploy Gen3Workflow to a new Gen3 instance.
Copy file name to clipboardExpand all lines: docs/local_installation.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,8 @@ python run.py
67
67
68
68
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).
69
69
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
+
70
72
## Run Nextflow workflows with Gen3Workflow
71
73
72
74
- Hit the `/storage/info` endpoint to get your working directory
@@ -113,7 +115,7 @@ gen3 run nextflow run hello
113
115
114
116
## AWS access
115
117
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)
117
119
118
120
## Quickstart with Helm
119
121
@@ -168,5 +170,5 @@ You can also store your images in a local registry. Kind and Minikube are popula
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