Page History
...
The AWS solution for the ODS/API software suite will provide the options to give you a highly available ODS/API server layer, so that if one ODS/API server fails, another is always available. In addition, any failed ODS/API server will automatically be replaced and setup according to your configuration. The database backend can be enabled to provide a synchronous replica that will automatically be used in the event the primary database fails in any way; in the event of a failure a new replica will automatically be synced to the new master database as well. In addition, you can also configure the ODS/API servers to use auto-scaling to add capacity to the ODS/API servers for any unexpected load increases. Servers are added and removed based on the CPU Utilization of the ODS/API servers as a group.
Info | ||
---|---|---|
| ||
If you are installing ODS/API v5.0.1, you MUST perform STEP 8 on this page in order for your solution to work. ODS/API v5.0.1 is administered through a newer version of the Admin Application (Suite 3 v2.0.1). If you fail to to step 8, you will receive a 500 error in your browser until you perform Step 8. |
Installation Instructions
...
- Provide a Name for the Stack. Replace the text ‘PlaceYourStackNameHere’ in this field with your unique stack name. Record this name value, as it will allow you to review the status of the creation process.
- For the 'ODS/API Software Suite Version' parameter, leave this value as select the value of '3.4.1'. or '5.0.1' depending on your preference.
- For the 'Type of environment parameter', select the value of 'prod' in the drop-down list.
- Choose a sizing option for your deployment. You cannot change this value after launching, so please ensure that your sizing option is appropriate. For further details on the sizing options, please see the Cost and Licenses section of the Overview of the Solution
- Select your preferred Database engine. The default is 'PostgreSQL' and will be the lower cost option. However, you can select 'SQL Server' if you wish.
- For the parameter 'Label Your Environment', provide what will be a unique label identifier for your environment. Please note that only one value can exist per solution launched.
- Next, select (2) AWS Availability Zones from the drop down list provided in the parameter. Click outside anywhere of the drop down box to return to your Parameter page.
- For the parameter labeled 'The ARN of the SSL Certificate ID', you will copy in your own value for your certificate that exists in the AWS ACM service. Ensure that no white space is before or after the value.
- Next, for the parameter labeled 'S3 location to store your own secure files', copy in the S3 bucket name you provided from the Prerequisites.
- For the parameter of 'Initial ODS API Database Data Set', select 'populated' or 'minimal' depending on your desired database state after setup.
- For the parameter of 'Install the SwaggerUI into the environment', select either 'yes' or 'no' from the drop-down list. For production environments, it is recommended that this be set to 'no'.
- The next three parameters that you enter will be the administrator passwords for your database, and RDP account to access the servers. Password requirements are provided in the parameter description.
- The next parameter that you will need to enter is a Public Network IP Address Space that allows access to the Remote Desktop Gateway Server to allow you to access the servers if needed. You may need to obtain your trusted network address space from your network administrator. If you wish to simply use your local machine's IP address, you can type into Google the phrase 'what is my ip' and this will give you your current IP address. Take this address and append a '/32' to its value to complete this parameter. For example, if your IP address is '3.4.5.6', the value you would enter is '3.4.5.6/32' in the field. However, for a non-production environment, you can place the value of '0.0.0.0/0' to allow connections from anywhere to get started, but it is recommended to limit access to this server if possible.
- Next, you will enter in parameters for your Production environment. The section of parameters will look like below
...
- Select the CloudFormation stack that you have been monitoring. On the ‘Stacks’ list, scroll down to the master template stack name that you have been monitoring in the previous step. Select the radio button next to the stack name in the box. The details of the stack will show in the right pane of the window. Your window would look similar to below:
- Click the Outputs tab to view the environment URLs. In this tab will be three URLs to view view and record their values(do not click any yet). They are labeled in the outputs tab as follows:
- AdminAppProdURL
- OdsApiProdURL
- SwaggerUIProdURL (if applicable)
...
Warning | ||
---|---|---|
| ||
Prior to continuing, due to the Admin Application inserting required security data into the Admin database during its setup process, the ODS/API needs to be restarted. This is accomplished by restarting the IIS server on an ODS/API server in the solution. For details on connecting to the servers in this solution, please see the section titled Accessing the Servers. Steps for restarting the ODS / API:
For production environments, the ODS/API software is located on separate servers than the Admin Application. the Admin Application. They can be identified in the EC2 Console by looking for a Name value that contains your stack name and Application Server. PLEASE NOTE THAT IF YOU ARE INSTALLING ODS/API v5.0.1 YOU MUST PERFORM THIS RESTART OF IIS! |
Step 10. Test ODS/API Software Solution
...
- ODS/API: Ed-Fi ODS / API v3.4 Home or Ed-Fi ODS / API for Suite 3 v5.0.1
- Admin Application: Admin Application Guide v1.8.x (for use with ODS/API v3.4.1)or Admin Application Guide for Suite 3 v2.0.1 (for use with ODS/API v5.0.1).
Next Steps
Once your environment is up and running on AWS, information on using the software can be found in following the links in Step 8 above.
...