-
Notifications
You must be signed in to change notification settings - Fork 0
README Updates #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Reviewer's GuideREADME.md is expanded from a brief Terraform-focused note into a full user-facing guide describing PA-Cloud’s architecture, prerequisites, Terraform-based deployment steps, access patterns, and licensing/contact details. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Update issue templates
uniqueg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks a lot! Just a few easy suggestions
README.md
Outdated
|
|
||
| PA-Cloud consists of a set of AWS resources that allow individual DataSHIELD servers running on University networks to communicate securely. | ||
|
|
||
| This leverages AWS' site-to-site VPN connections, with an internal network in AWS serving as a confluence, from which an instance of Jupyterhub can be used to spawn Jupyter notebook servers, within which analysis can take place. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it really spawn Jupyter notebook servers? Not Rock R servers? I'm not sure, but that was my understanding, so maybe double check (unless you're sure)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It spawns both - intially Rock servers (alongside DataSHIELD's other supporting containers), then Jupyter notebooks via JupyterHub inside AWS. I've adjusted the README accordingly to better reflect this
| > This repository is currently configured as per Pacific Analytics' deployment of PA-Cloud. You will need to adjust various values in Terraform if deploying to a different location. | ||
| > [!NOTE] | ||
| > The above is provisional, with exact requirements for a novel environment not fully known. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe invite people to contribute back their experiences.
README.md
Outdated
| 1. Initialise terraform | ||
| # Architectural Overview | ||
|
|
||
| PA-Cloud consists of a set of AWS resources that allow individual DataSHIELD servers running on University networks to communicate securely. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can be more generic here, maybe "federated networks" instead of "University networks", or even make it clearer by explicitly stating that these can be cross-institutional
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a mention of this in this section
Adds additional information to
README.mdSummary by Sourcery
Update the README to provide a high-level product overview and step-by-step deployment and usage guidance for PA-Cloud.
Documentation: