Skip to content

Update info in Dataverse Developers Guide about what happens when not specifying a branch when running script that deploys Dataverse on AWS #10589

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.

Sign up for GitHub

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

Merged
pdurbin merged 2 commits into from
Jun 3, 2024
Merged

Update info in Dataverse Developers Guide about what happens when not specifying a branch when running script that deploys Dataverse on AWS #10589

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be6c6f7
Update deployment.rst
jggautier May 23, 2024
42172f7
Update deployment.rst
jggautier May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/developers/deployment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ To run it with default values you just need the script, but you may also want a
ec2-create-instance accepts a number of command-line switches, including:

* -r: GitHub Repository URL (defaults to https://github.com/IQSS/dataverse.git)
* -b: branch to build (defaults to develop)
* -b: branch to build (defaults to the latest release of Dataverse)
Copy link
Copy Markdown
Member

@pdurbin pdurbin May 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* -b: branch to build (defaults to the latest release of Dataverse)
* -b: branch to build and deploy (e.g. "develop") rather than deploying the latest release of Dataverse

I think, I hope, the above is a little more clear, and it gives an example of which branch can be passed.

What's a bit confusing is that the script itself spits out "develop" three times, even when called with no arguments. It probably should say "deploying latest release of Dataverse". Here's what it says now:

$ ./ec2-create-instance.sh 
using default repo: https://github.com/IQSS/dataverse.git
using default branch develop
using ami-0408f4c4a072e3fb9
using t3a.large
using dataverse-sg security group
Creating EC2 instance
Instance ID: aaa
When you are done, please terminate your instance with:
aws  ec2 terminate-instances --instance-ids aaa
giving instance 90 seconds to wake up...
End creating EC2 instance
New instance created with ID "aaa". To ssh into it:
ssh -i  rocky@foo.bar
Please wait at least 15 minutes while the branch "develop" from https://github.com/IQSS/dataverse.git is being deployed.
Branch develop from https://github.com/IQSS/dataverse.git has been deployed to http://foo.bar
To ssh into the new instance:
ssh -i  rocky@foo.bar
When you are done, please terminate your instance with:
aws  ec2 terminate-instances --instance-ids aaa

This script is in the ansible repo so we'd need to fix it there.

* -p: pemfile directory (defaults to $HOME)
* -g: Ansible GroupVars file (if you wish to override role defaults)
* -h: help (displays usage for each available option)
Expand Down
⚡