-
Notifications
You must be signed in to change notification settings - Fork 488
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
595 additions
and
159 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE module PUBLIC | ||
| "-//Puppy Crawl//DTD Check Configuration 1.3//EN" | ||
| "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd"> | ||
|
|
||
| <module name="Checker"> | ||
| <!-- | ||
| If you set the basedir property below, then all reported file | ||
| names will be relative to the specified directory. See | ||
| http://checkstyle.sourceforge.net/5.x/config.html#Checker | ||
| <property name="basedir" value="${basedir}"/> | ||
| --> | ||
|
|
||
| <!-- <property name="fileExtensions" value="java, properties"/> --> | ||
| <property name="fileExtensions" value="java"/> | ||
|
|
||
| <!-- Checks that a package-info.java file exists for each package. --> | ||
| <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> | ||
| <!-- <module name="JavadocPackage"/> --> | ||
|
|
||
| <!-- Checks whether files end with a new line. --> | ||
| <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> | ||
| <!--<module name="NewlineAtEndOfFile"/>--> | ||
|
|
||
| <!-- Checks that property files contain the same keys. --> | ||
| <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> | ||
| <!-- | ||
| <module name="Translation"/> | ||
| --> | ||
|
|
||
| <!-- Checks for Size Violations. --> | ||
| <!-- See http://checkstyle.sf.net/config_sizes.html --> | ||
| <!-- <module name="FileLength"/> --> | ||
|
|
||
| <!-- Checks for whitespace --> | ||
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> | ||
| <!-- Checks that there are no tab characters ('\t') in the source code. http://checkstyle.sourceforge.net/config_whitespace.html#FileTabCharacter--> | ||
| <module name="FileTabCharacter"/> | ||
|
|
||
| <!-- Miscellaneous other checks. --> | ||
| <!-- See http://checkstyle.sf.net/config_misc.html --> | ||
| <!-- | ||
| <module name="RegexpSingleline"> | ||
| <property name="format" value="[^\s]\s+$"/> | ||
| <property name="minimum" value="0"/> | ||
| <property name="maximum" value="0"/> | ||
| <property name="message" value="Line has trailing spaces."/> | ||
| </module> | ||
| --> | ||
|
|
||
| <!-- Checks for Headers --> | ||
| <!-- See http://checkstyle.sf.net/config_header.html --> | ||
| <!-- | ||
| <module name="RegexpHeader"> | ||
| <property name="headerFile" value="${checkstyle.header.file}"/> | ||
| <property name="fileExtensions" value="java"/> | ||
| </module> | ||
| --> | ||
|
|
||
| <module name="TreeWalker"> | ||
|
|
||
| <!-- Checks for Javadoc comments. --> | ||
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> | ||
| <!-- | ||
| <module name="JavadocMethod"> | ||
| <property name="severity" value="info"/> | ||
| <property name="allowMissingParamTags" value="true"/> | ||
| </module> | ||
| <module name="JavadocType"/> | ||
| <module name="JavadocVariable"> | ||
| <property name="ignoreNamePattern" value="^[A-Z_\-]+$" /> | ||
| </module> | ||
| <module name="JavadocStyle"> | ||
| <property name="checkFirstSentence" value="false" /> | ||
| </module> | ||
| --> | ||
|
|
||
| <!-- Checks for Naming Conventions. --> | ||
| <!-- See http://checkstyle.sf.net/config_naming.html --> | ||
| <!-- | ||
| <module name="ConstantName"/> | ||
| <module name="LocalFinalVariableName"/> | ||
| <module name="LocalVariableName"/> | ||
| <module name="MemberName"/> | ||
| <module name="MethodName"/> | ||
| <module name="PackageName"/> | ||
| <module name="ParameterName"/> | ||
| <module name="StaticVariableName"/> | ||
| <module name="TypeName"/> | ||
| --> | ||
|
|
||
| <!-- Checks for imports --> | ||
| <!-- See http://checkstyle.sf.net/config_import.html --> | ||
| <!-- | ||
| <module name="AvoidStarImport"> | ||
| <property name="excludes" value="lombok,java.util,org.springframework.web.bind.annotation"/> | ||
| </module> | ||
| --> | ||
| <!-- <module name="IllegalImport"/> --> <!-- defaults to sun.* packages --> | ||
| <!-- <module name="RedundantImport"/> --> | ||
| <!-- <module name="UnusedImports"> | ||
| <property name="processJavadoc" value="false"/> | ||
| </module> --> | ||
| <!-- <module name="CustomImportOrder" /> --> | ||
|
|
||
| <!-- Checks for Size Violations. --> | ||
| <!-- See http://checkstyle.sf.net/config_sizes.html --> | ||
| <!-- | ||
| <module name="LineLength"> | ||
| <property name="max" value="120"/> | ||
| <!- ignore lines with javadoc inside -> | ||
| <property name="ignorePattern" value="^ *\* *[^ ]+$"/> | ||
| </module> | ||
| <module name="MethodLength"/> | ||
| <module name="ParameterNumber"/> | ||
| --> | ||
|
|
||
| <!-- Checks for whitespace --> | ||
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> | ||
| <!-- | ||
| <module name="EmptyForIteratorPad"/> | ||
| <module name="GenericWhitespace"/> | ||
| <module name="MethodParamPad"/> | ||
| <module name="NoWhitespaceAfter"/> | ||
| <module name="NoWhitespaceBefore"/> | ||
| <module name="OperatorWrap"/> | ||
| <module name="ParenPad"/> | ||
| <module name="TypecastParenPad"/> | ||
| <module name="WhitespaceAfter"/> | ||
| <module name="WhitespaceAround"/> | ||
| --> | ||
|
|
||
| <!-- Modifier Checks --> | ||
| <!-- See http://checkstyle.sf.net/config_modifiers.html --> | ||
| <!-- | ||
| <module name="ModifierOrder"/> | ||
| <module name="RedundantModifier"/> | ||
| --> | ||
|
|
||
| <!-- Checks for blocks. You know, those {}'s --> | ||
| <!-- See http://checkstyle.sf.net/config_blocks.html --> | ||
|
|
||
| <!--<module name="AvoidNestedBlocks"/>--> | ||
| <!--<module name="EmptyBlock"/>--> | ||
| <!-- Put the left curly at the end of the line above, not on the next line. http://checkstyle.sourceforge.net/config_blocks.html#LeftCurly--> | ||
| <module name="LeftCurly"/> | ||
| <!--<module name="NeedBraces"/>--> | ||
| <!--<module name="RightCurly"/>--> | ||
|
|
||
|
|
||
| <!-- Checks for common coding problems --> | ||
| <!-- See http://checkstyle.sf.net/config_coding.html --> | ||
| <!-- | ||
| <module name="AvoidInlineConditionals"/> | ||
| <module name="EmptyStatement"/> | ||
| <module name="EqualsHashCode"/> | ||
| <module name="HiddenField"> | ||
| <property name="ignoreConstructorParameter" value="true"/> | ||
| <property name="ignoreSetter" value="true"/> | ||
| </module> | ||
| <module name="IllegalInstantiation"/> | ||
| <module name="InnerAssignment"/> | ||
| <module name="MagicNumber"/> | ||
| <module name="MissingSwitchDefault"/> | ||
| <module name="SimplifyBooleanExpression"/> | ||
| <module name="SimplifyBooleanReturn"/> | ||
| --> | ||
|
|
||
| <!-- Checks for class design --> | ||
| <!-- See http://checkstyle.sf.net/config_design.html --> | ||
| <!-- <module name="DesignForExtension"/> --> | ||
| <!-- <module name="FinalClass"/> --> | ||
| <!-- <module name="HideUtilityClassConstructor"/> --> | ||
| <!-- <module name="InterfaceIsType"/> --> | ||
| <!-- <module name="VisibilityModifier"/> --> | ||
|
|
||
| <!-- Miscellaneous other checks. --> | ||
| <!-- See http://checkstyle.sf.net/config_misc.html --> | ||
| <!-- <module name="ArrayTypeStyle"/> --> | ||
| <!-- <module name="FinalParameters"/> --> | ||
| <!-- | ||
| <module name="TodoComment"> | ||
| <property name="severity" value="info"/> | ||
| </module> | ||
| --> | ||
| <!-- <module name="UpperEll"/> --> | ||
|
|
||
| </module> | ||
|
|
||
| </module> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| ========== | ||
| Deployment | ||
| ========== | ||
|
|
||
| Developers often only deploy Dataverse to their :doc:`dev-environment` but it can be useful to deploy Dataverse to cloud services such as Amazon Web Services (AWS). | ||
|
|
||
| .. contents:: |toctitle| | ||
| :local: | ||
|
|
||
| Deploying Dataverse to Amazon Web Services (AWS) | ||
| ------------------------------------------------ | ||
|
|
||
| We have written scripts to deploy Dataverse to Amazon Web Services (AWS) but they require some setup. | ||
|
|
||
| Install AWS CLI | ||
| ~~~~~~~~~~~~~~~ | ||
|
|
||
| First, you need to have AWS Command Line Interface (AWS CLI) installed, which is called ``aws`` in your terminal. Launching your terminal and running the following command to print out the version of AWS CLI will tell you if it is installed or not: | ||
|
|
||
| ``aws --version`` | ||
|
|
||
| If you have not yet installed AWS CLI you should install it by following the instructions at https://docs.aws.amazon.com/cli/latest/userguide/installing.html | ||
|
|
||
| Afterwards, you should re-run the "version" command above to verify that AWS CLI has been properly installed. If "version" still doesn't work, read on for troubleshooting advice. If "version" works, you can skip down to the "Configure AWS CLI" step. | ||
|
|
||
| Troubleshooting "aws: command not found" | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Please note that as of this writing the AWS docs are not especially clear about how to fix errors such as ``aws: command not found``. If the AWS CLI cannot be found after you followed the AWS installation docs, it is very likely that the ``aws`` program is not in your ``$PATH``. ``$PATH`` is an "environment variable" that tells your shell (usually Bash) where to look for programs. | ||
|
|
||
| To see what ``$PATH`` is set to, run the following command: | ||
|
|
||
| ``echo $PATH`` | ||
|
|
||
| On Mac, to update your ``$PATH`` to include the location where the current AWS docs install AWS CLI on the version of Python included with your Mac, run the following command: | ||
|
|
||
| ``export PATH=$PATH:$HOME/Library/Python/2.7/bin`` | ||
|
|
||
| After all this, you can try the "version" command again. | ||
|
|
||
| Note that it's possible to add an ``export`` line like the one above to your ``~/.bash_profile`` file so you don't have to run it yourself when you open a new terminal. | ||
|
|
||
| Configure AWS CLI | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Next you need to configure AWS CLI. | ||
|
|
||
| Create a ``.aws`` directory in your home directory (which is called ``~``) like this: | ||
|
|
||
| ``mkdir ~/.aws`` | ||
|
|
||
| We will be creating two plain text files in the ``.aws`` directory and it is important that these files do not end in ".txt" or any other extension. After creating the files, you can verify their names with the following command: | ||
|
|
||
| ``ls ~/.aws`` | ||
|
|
||
| Create a plain text file at ``~/.aws/config`` with the following content:: | ||
|
|
||
| [default] | ||
| region = us-east-1 | ||
|
|
||
| Please note that at this time the region must be set to "us-east-1" but in the future we could improve our scripts to support other regions. | ||
|
|
||
| Create a plain text file at ``~/.aws/credentials`` with the following content:: | ||
|
|
||
| [default] | ||
| aws_access_key_id = XXXXXXXXXXXXXXXXXXXX | ||
| aws_secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | ||
|
|
||
| Then update the file and replace the values for "aws_access_key_id" and "aws_secret_access_key" with your actual credentials by following the instructions at https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ | ||
|
|
||
| If you are having trouble configuring the files manually as described above, see https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html which documents the ``aws configure`` command. | ||
|
|
||
| Download and Run the "Create Instance" Script | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Once you have done the configuration above, you are ready to try running the "create instance" script to spin up Dataverse in AWS. | ||
|
|
||
| Download :download:`ec2-create-instance.sh <../../../../scripts/installer/ec2-create-instance.sh>` and put it somewhere reasonable. For the purpose of these instructions we'll assume it's in the "Downloads" directory in your home directory. | ||
|
|
||
| You need to decide which branch you'd like to deploy to AWS. Select a branch from https://github.com/IQSS/dataverse/branches/all such as "develop" and pass it to the script with ``-b`` as in the following example. (Branches such as "master" and "develop" are described in the :doc:`version-control` section.) | ||
|
|
||
| ``bash ~/Downloads/ec2-create-instance.sh -b develop`` | ||
|
|
||
| You must specify the branch with ``-b`` but you can also specify a non-IQSS git repo URL with ``-r`` as in the following example. | ||
|
|
||
| ``bash ~/Downloads/ec2-create-instance.sh -b develop -r https://github.com/scholarsportal/dataverse.git`` | ||
|
|
||
| Now you will need to wait around 15 minutes until the deployment is finished. Eventually, the output should tell you how to access the installation of Dataverse 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 can also delete your instance from https://console.aws.amazon.com/console/home?region=us-east-1 . | ||
|
|
||
| Caveats | ||
| ~~~~~~~ | ||
|
|
||
| Please note that while the script should work fine on newish branches, older branches that have different dependencies such as an older version of Solr are now expected to yield a working Dataverse installation. Your mileage may vary. | ||
|
|
||
| ---- | ||
|
|
||
| Previous: :doc:`coding-style` | Next: :doc:`containers` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,7 @@ Developer Guide | |
| documentation | ||
| debugging | ||
| coding-style | ||
| deployment | ||
| containers | ||
| making-releases | ||
| tools | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.