Update gen3-deployment documentation to include the updated helm based changes#99
Conversation
|
The style in this PR agrees with This formatting comment was generated automatically by a script in uc-cdis/wool. |
Pull Request Test Coverage Report for Build 22193529696Details
💛 - Coveralls |
|
Failed to Prepare CI environment Please find the Github Action logs here |
|
Failed to Prepare CI environment Please find the Github Action logs here |
|
Failed to Prepare CI environment Please find the Github Action logs here |
…add_helm_deployment_doc
…add_helm_deployment_doc
…n3-workflow into chore/add_helm_deployment_doc
docs/gen3-deployment.md
Outdated
| ``` | ||
| * If **Crossplane is not enabled**, you can create them manually using [this Helm template](https://github.com/uc-cdis/gen3-helm/blob/master/helm/gen3-workflow/templates/crossplane.yaml) as reference. | ||
|
|
||
| > In CTDS environments, the recommendation is to use Crossplane for Dev and QA environments and Terraform/Terragrunt for Production environments. Check out [this internal link](https://github.com/uc-cdis/gen3-terragrunt/pull/251/changes) for an example of creating this role with Terragrunt. |
There was a problem hiding this comment.
In CTDS environments, the recommendation is to use Crossplane for Dev/QA and Terraform/Terragrunt for Production environments. Check out this internal link for an example of creating this role with Terragrunt.
There was a problem hiding this comment.
...Dev and QA environments and Terraform/Terragrunt... this part seemed a little confusing to me.
|
|
||
| - S3 mountpoint | ||
|
|
||
| We need to make sure the S3 mountpoint is configured correctly, and ideally we should have per-pod identity so that the workflows can use per-user buckets. See [this](https://github.com/awslabs/mountpoint-s3-csi-driver/issues/334#issuecomment-2613552946). More context [here](https://cdis.slack.com/archives/CLZJVC38B/p1738882570732499?thread_ts=1738880648.216489&cid=CLZJVC38B). |
There was a problem hiding this comment.
Why are we removing them from docs? There could be newer clusters where we might want to deploy Gen3Workflow, and these docs would be helpful, right?
There was a problem hiding this comment.
We didn't need to do any of these manual steps when we deployed it to a new cluster this time, so this may have been resolved by deploying through helm charts. We can revert if later it turns out we need it
| # Update each whitelisted image to a regex with updated {username} value with an actual username | ||
| # and `*` with `.*` to match any sequence of characters, storing the resulting patterns in a set | ||
| whitelisted_images_regex = { | ||
| def _image_to_regex(image: str) -> str: |
There was a problem hiding this comment.
This is nice, I wanted to work on this once I get a chance. You beat me to it :D But this is great.
3 participants
Link to JIRA ticket if there is one:
New Features
Breaking Changes
Bug Fixes
Improvements
Dependency updates
Deployment changes