First time installation
This procedure can be used to create an evaluation/development or a production eagle-i node. As a first step, decide which type of installation you will need:
- An evaluation or development node requires less configuration, but it should not be used for collecting actual data; this type of node can be created and destroyed at will.
- A production node will likely need some (limited) involvement of your IT department, but will result in a node that is ready for real world data collection.
Note that an evaluation or development node cannot be converted to a production node.
If you would like to set up an evaluation or development node, you may use the amazon-generated public hostname and the self-signed certificate we provide.
A production eagle-i node needs:
- A public host name which will need to have a DNS record once you obtain an IP address from EC2
- Decide on a good host name. It will determine the namespace of your Linked Open Data, and it shouldn't be changed once data exists in production.
- Examples of existing host names: harvard.eagle-i.net, eagle-i.ea.vanderbilt.edu
- An SSL certificate for this public hostname (X509 certificate in PEM format)
You may need to involve your IT department to obtain these two prerequisites.
To run the procedure that creates the eagle-i node (for both evaluation/development and production), you will need:
- A browser (in our experience Firefox works best; in Chrome, the scrollbars in AWS dialogues are finicky)
- An Amazon Web Services (AWS) account with the Amazon Elastic Compute Cloud (EC2) service enabled:
Sign up for AWS, then sign up for the EC2 service; this will require that you provide credit card information.
To finalize installation of a production instance and to administer your eagle-i node you will need, in addition:
- An SSH client for remotely logging in to the EC2 instance
- If you're using Linux, you know what this is about already
- In MacOSX you can simply use the Terminal application that is installed by default (look in your Applications folder, under Utilities)
- In Windows we recommend downloading and installing PuTTY (a remote login client that can handle SSH keys) or cygwin (a full Unix toolset)
Throughout this procedure, you will be using the AWS Management Console, and in particular the EC2 Dashboard and the Cloud Formation Dashboard. You may want to familiarize yourself with the console and bookmark it: https://console.aws.amazon.com
1. Allocate EC2 Resources
Amazon allocates EC2 resources (IP addresses, virtual hardware) in specific facilities that are meant to cover different geographic regions (also called availability zones). We support three zones: US East (N. Virginia), US West (Oregon) and US West (N. California). Make sure one of these is selected by going to your EC2 Dashboard and using the pull down list at the top right hand corner of the dashboard (next to your user name); choose that which is most appropriate to your institution's location.
Please note that all the EC2 resources described below need to be allocated in the same availability zone
1.1. Allocate an elastic IP address and associate it to your public host name
Go to your EC2 Dashboard. In the left navigation bar, open the Network and Security section and select Elastic IPs. Click on the Allocate New Address button. Accept the default in the dialogue box (create in EC2) and allocate.
Take note of the new IP address, you will need it in step 2.
If you are installing a production instance: ask the administrator of your domain to create a DNS record that maps the public hostname you previously selected to this IP address. Your domain administrator is usually somebody in your IT department. Creation of the eagle-i node (step 2) will fail if your public hostname does not resolve to this IP address.
1.2. Create an EC2 key pair and download your private key
Go to your EC2 Dashboard. In the left navigation bar, open the Network and Security section and select Key Pairs. Click on the Create Key Pair button. Enter a name for your key pair (e.g. eagle-i-key) and select create. Your private key will be downloaded to your computer, as a file with the name you specified and the
.pem extension (you may be prompted by your browser to select a location). Store it in a dedicated directory to which you will come back later, e.g.
2. Create the eagle-i node
The procedure for creating an eagle-i node utilizes Amazon's Cloud Formation mechanism. Cloud Formation allows you to instantiate a stack, i.e. an EC2 instance that will be associated to additional EC2 resources (such as an elastic IP address) and a predefined machine image (AMI).
Before proceeding: if you are creating a production instance, make sure that your public hostname resolves to the elastic IP address created in 1.1. You can use an online service to check, for example: http://www.whatsmydns.net/
2.1. Enter information into the Cloud Formation dialogue
Open the Cloud Formation Dialogue Window (by clicking here). It should look like this:
Click continue to accept the defaults. The next window will provide entry fields for a few parameters necessary to configure the EC2 instance and the eagle-i software. They are described below, in alphabetical order. NB Unfortunately, we cannot control the order in which these parameters are presented in the Cloud Formation window, so the list below will not necessarily match the order you see.
An existing EC2 elastic IP address to be associated with the new instance.
Enter the IP address you created in 1.1
The e-mail address from which mail will be sent for this eagle-i node. An eagle-i node sends e-mail when users submit feedback or request to contact a resource owner.
A Google Analytics ID to monitor the eagle-i node (optional). Must be a valid Google Analytics ID of the form UA-XXXXX-YY.
Note: it is possible to modify the configuration later on to add this parameter, see the Maintenance Tasks section. However, this requires some Unix skills.
Amazon EC2 instance type, choose either m1.medium or m1.large.
Note: pricing differs; a medium instance should be enough as a starting point, see http://aws.amazon.com/ec2/instance-types/
The display name of the institution
Example: Miskatonic University
The URL to a PNG image file containing the logo of the institution
Name of your EC2 key pair. This will enable SSH access to the new instance.
Enter the name of the key pair you created in 1.2
The public hostname of the institution's eagle-i node. This name must resolve to the specified elastic IP address.
Note: If you use the default value, the instance will be configured with the default EC2 public hostname (recommended for evaluation and development instances only).
The name of the eagle-i repository administrative user. It must contain only alphanumeric characters and be between 6 and 12 characters long.
The password for the eagle-i repository administrative user. Must contain only alphanumeric characters and be between 6 and 12 characters long
Restrict SSH access to the host.
Default: 0.0.0.0 = the instance can be accessed from anywhere (this is usually fine)
The default e-mail address to which mail will be sent for this eagle-i node. This address will receive feedback submitted by users via the eaglei UI, or requests for resources that have no contact information.
Restrict HTTP/HTTPS access to the host.
Default: 0.0.0.0 = the instance can be accessed from anywhere (this is usually fine)
Once you have entered values for all these parameters, click continue and skip the following dialogue window (Add Tags) by clicking continue again. If any of the parameter values is invalid, a red error message will appear, at the bottom of the dialogue window. If this is the case, return to the parameter screen and enter a valid value. Once all your parameters validate, you will be presented with a summary of the information you provided. If the information is correct, click continue. A screen indicating the stack creation is in progress will appear:
You may close the Cloud Formation dialogue window.
2.2. Monitor stack creation
Monitor the progress of your stack creation in the Cloud Formation dashboard -- detailed progress will be shown in the Events tab (hit refresh to get updated views). Once the stack is created, its status will be CREATE_COMPLETE.
At this point you have an EC2 instance that is in the process of booting.
If you are installing an evaluation or development instance, take note of the public hostname that was dynamically assigned. You will find this in the Outputs tab of the Cloud Formation Dashboard, in the PublicDnsName row. The name will be in the amazonws.com domain, for example:
ec2-54-225-140-48.compute-1.amazonaws.com. Note how ugly this name is, which is why we do not recommend it for a production system - it would need to be typed by your users and it would appear in your Linked Open Data.
You will be able to manage your EC2 instance from the EC2 Dashboard. In the left navigation bar, open the Instances section and select Instances. You will see one row with your instance information. Check the box on the left and click on the Actions button to obtain a menu of possible actions.
2.3. Monitor eagle-i installation
As soon as the EC2 instance boots, the eagle-i installation process automatically starts. It takes care of downloading, installing and configuring eagle-i prerequisites (Java, Tomcat, Postfix) and eagle-i software. When this process completes, which will take a little while, you will have an eagle-i node up and running.
If you would like to monitor the progress of this step, start an SSH session with your newly created instance (see Appendix 1). Otherwise, get a coffee and skip the rest of this section.
From your SSH terminal, issue the following command:
You will see the current progress of the installation procedure. You will see the message
bootstrap.sh: finished when the procedure completes.
3. Verify that your eagle-i node is up and running
- The landing page for your new eagle-i node should now be accessible from a browser, e.g.:
- You should be able to log in to the eagle-i repository admin console, using the repository credentials specified at stack creation time, e.g.:
You may want to create users with different roles and in general poke around the different configuration options.
- You should have access to the SWEET, e.g.:
- You should have access to the institutional search, e.g.:
Log in with one of the users you created and verify you can access the SWEET workbench, create a test organization and publish it, verify it appears in search after being published, etc. You may want to compare your screens with our training node: https://training.eagle-i.net/sweet and https://training.eagle-i.net/institution
If your EC2 instance is successfully created, but your eagle-i node does not come up, SSH into your instance and look for error messages in the log (follow instructions in section 2.3. Monitor eagle-i installation). Some common errors are listed below. If you hit an error that is not listed yet, please let us know.
4.1. Hostname does not resolve to elastic IP address
If you are installing a production environment and your hostname, at the time of installation, did not resolve to your elastic IP address, you will see a message like the following:
To get past this error:
Double check with your DNS administrator that the correct information was used. DNS changes may take time to propagate, so make sure your hostname resolves within the EC2 environment by SSHing into your instance and issuing the
hostcommand. The answer should indicate that the host has your IP address, for example:
However, if there is not answer, the DNS mapping has not yet propagated and you will need to wait a bit longer.
- Once your hostname resolves correctly, restart your EC2 instance: go to your EC2 Dashboard, open the Instances section in the left navigation bar and select Instances. You will see one row with your instance information. Check the box on the left and click on the Actions button to obtain a menu of possible actions. Select Actions -> Reboot and wait until the state changes to Running (you may need to refresh the console).
- Follow the instructions in section 2.3. Monitor eagle-i installation to verify that your installation proceeds..
4.2. Connectivity issues
The eagle-i bootstrapping script that runs when the EC2 instance starts downloads all the files it needs from
open.med.harvard.edu. If for some reason the download server cannot be reached, you will see an error message in the logs, for example:
This lack of connectivity is likely temporary. Wait a little while and reboot the EC2 instance to restart the bootstrapping procedure (see the Maintenance Tasks section for instructions on rebooting your instance).
5. Install your SSL certificate (production instance)
The install procedure above initially configures eagle-i with a self-signed certificate; this is acceptable for an evaluation or development environment, but not for a production instance. In order to finalize the installation of a production instance, please follow the steps below.
5.1. Transfer your certificate, certificate chain and private key to the EC2 instance
Obtain, from the person who purchased the certificate, the following files:
- The RSA key used at certificate purchase time and its password, e.g.
- The actual certificate returned by the certificate authority, e.g.
- The certificate authority's (CA) certificate chain (depending on the particular CA, some of these may need to be downloaded - refer to their documentation), e.g.
You will need to copy these three files into your EC2 instance, to the directory
These files are security-sensitive. Please make sure they are transferred to you in a secure manner (e.g. a memory stick, or using the scp command) and delete them from your personal machine once they are installed. If in doubt, please ask for assistance of your IT department.
5.1.1. With a terminal
For example, assuming the files are named as above and located in the directory
/my-home/aws/cert, issue the following command in your terminal (substitute your own file names and public hostname):
5.1.2. With PuTTY/PSCP
Follow the instructions in the section Transferring files with PSCP at the end of the AWS/PuTTY guide.
5.2. SSH into your EC2 instance and install the certificate
SSH into your EC2 instance, as described in Appendix 1.
In your SSH session, run the following commands (substitute the actual names of your files):
At the prompt, enter the key's password. When the script finishes, tomcat will restart. After restart, verify that your certificate is correctly installed by entering your public hostname in an online SSL validation service, such as http://www.geocerts.com/ssl_checker
Finally, remove the security-sensitive files used for installation, e.g.:
Your EC2 instance contains scripts to upgrade the eagle-i software upon new releases and patches. You will need to manually trigger this process, as follows:
- SSH into your EC2 instance, as described in Appendix 1.
- Execute the following commands:
Your EC2 instance can be started and stopped from the EC2 Dashboard. In the left navigation bar, open the Instances section and select Instances. You will see one row with your instance information. Check the box on the left and click on the Actions button to obtain a menu of possible actions.
Most maintenance tasks require that you SSH into your EC2 instance, see Appendix 1.
1. Modify your eagle-i configuration
If you need to modify your eagle-i configuration (for example, to add a Google analytics ID) edit one or several of the following files, as appropriate. See the Repository Configuration Guide, and the Application Configuration Guide.
2. Restore a backup
Your eagle-i node is set to back up its repository data every day. The backups are located in
/opt/eaglei/repo/backup/. To restore a backup, use the
move-everything.sh script located in
/opt/eaglei/repo/etc. For more information, see the Repository Installation, Upgrade and Administration Guide.
Deleting an EC2 instance and its resources
It is very easy to delete EC2 instances that are used for evaluation or as development environments and create new ones, so experimentation is encouraged. Please note that when you no longer need an EC2 instance, you need to delete all its associated resources (which incur charges individually, even if they are not attached to an instance). The easiest way to do so is as follows:
- Open your Cloud Formation Dashboard, check the box on the left of your stack and click the button Delete stack.
- When the stack has finished deleting (refresh to see the status), open your EC2 Dashboard, open the Elastic Block Store section in the left navigation bar and select Volumes. You should see a 50 GB volume; check the box on the left, click on the Actions button and select Delete volume.
- Delete your elastic IP address and key pair in a similar fashion.
- Note that if you are deleting an instance and will be creating a new one, you may reuse the elastic IP address and key pair that you have already allocated.
1. Starting an SSH session with your EC2 instance
For both methods, use as server name your public hostname (or your elastic IP address, if the hostname is not working) and as username
1.1. With a terminal (Linux, MacOS or Windows cygwin)
1.1.1. First time only: set the correct permissions for your SSH key
The ssh command will not accept a key that has broad file system permissions. Open a terminal and change to the directory where you've stored the key, e.g.:
Issue the following command to set the correct permissions:
1.1.2. SSH into your EC2 instance
Issue the ssh command, specifying the root user, for example: (you will need to substitute the full path of your key and the public hostname of your instance)
At this point you have a remote terminal session with your EC2 instance.
See also this guide at AWS documentation central: Connecting to Linux/UNIX Instances Using SSH
1.2. With Windows PuTTY
Follow this guide at AWS documentation central: Connecting to Linux/UNIX Instances from Windows Using PuTTY. In the connection window, enter your public hostname (either the amazon-provided or that which you mapped to your elastic IP address) and when prompted for a user, use
2. Specifications of the EC2 stack created
2.1. Virtual hardware and resources
- EC2 medium or large standard instance
- 20 GB EBS volume for the root partition (with 8 GB of swap)
- 50 GB EBS volume for
- one elastic IP address
- one key pair
- CentOS 6.4
- Ansible 1.1
- JRE 1.7.0_17
- Tomcat 7.0.37
- eagle-i software 2.0-MS2.17
- Daily scheduled task (i.e. cron) to backup the eagle-i repository - runs at 1 AM
- Daily scheduled task to generate sitemap - runs at 2 AM