From be6c6f7a9e85ce75bb257d8138671d5053ef8374 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 23 May 2024 14:24:12 -0400 Subject: [PATCH 1/2] Update deployment.rst Correct info about what happens when -b is not used in command to create a Dataverse instance on AWS --- doc/sphinx-guides/source/developers/deployment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/developers/deployment.rst b/doc/sphinx-guides/source/developers/deployment.rst index 678e29f4079..6bd42a7ab95 100755 --- a/doc/sphinx-guides/source/developers/deployment.rst +++ b/doc/sphinx-guides/source/developers/deployment.rst @@ -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) * -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) From 42172f72a172bdd0e853c2c8927a18007e3c5f64 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Fri, 24 May 2024 16:43:23 -0400 Subject: [PATCH 2/2] Update deployment.rst Removing list of options and encouraging users to user -h to see the options. --- doc/sphinx-guides/source/developers/deployment.rst | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/doc/sphinx-guides/source/developers/deployment.rst b/doc/sphinx-guides/source/developers/deployment.rst index 6bd42a7ab95..89ae9ac4c2e 100755 --- a/doc/sphinx-guides/source/developers/deployment.rst +++ b/doc/sphinx-guides/source/developers/deployment.rst @@ -91,17 +91,11 @@ Download `ec2-create-instance.sh`_ and put it somewhere reasonable. For the purp .. _ec2-create-instance.sh: https://raw.githubusercontent.com/GlobalDataverseCommunityConsortium/dataverse-ansible/master/ec2/ec2-create-instance.sh -To run it with default values you just need the script, but you may also want a current copy of the ansible `group vars `_ file. +To run the script, you can make it executable (``chmod 755 ec2-create-instance.sh``) or run it with bash, like this with ``-h`` as an argument to print the help: -ec2-create-instance accepts a number of command-line switches, including: +``bash ~/Downloads/ec2-create-instance.sh -h`` -* -r: GitHub Repository URL (defaults to https://github.com/IQSS/dataverse.git) -* -b: branch to build (defaults to the latest release of Dataverse) -* -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) - -``bash ~/Downloads/ec2-create-instance.sh -b develop -r https://github.com/scholarsportal/dataverse.git -g main.yml`` +If you run the script without any arguments, it should spin up the latest version of Dataverse. You will need to wait for 15 minutes or so until the deployment is finished, longer if you've enabled sample data and/or the API test suite. Eventually, the output should tell you how to access the Dataverse installation in a web browser or via SSH. It will also provide instructions on how to delete the instance when you are finished with it. Please be aware that AWS charges per minute for a running instance. You may also delete your instance from https://console.aws.amazon.com/console/home?region=us-east-1 .