Project Scope

As a reminder, project Roadrunner is simplified, binary-release of the Ed-Fi ODS/API, targeting both PostgreSQL and SQL Server database engines. This installation provides the following applications:

1. ODS/API with all resources from Ed-Fi Data Standard v3.2, operating in "Shared Instance" mode.
   1. Does not include: extension support; Composites; sandboxes; change queries; profiles.
2. AdminApp
3. /wiki/spaces/ODSAPI33/pages/26443888
4. Swagger UI
5. Deployment scripts for deploying the databases and configuring the four applications above.

Operational Requirements

The Roadrunner deployment scripts allow the user to deploy the three Ed-Fi databases (Admin, ODS, Security) to either PostgreSQL or SQL Server. In addition, they download the ODS/API version 3.3 binary release of the API, Swagger UI, and Client Side Bulk Loader, and the current pre-release of Admin App v1.7. After download, the deployment scripts will reconfigure the web.config files by setting up the correct connection strings for the environment, and they will copy the files out to another directory of the user's choosing. These could be network paths for pushing the files out to another web server.

Deployment Server

For the server running the deployment scripts:

• Scripts are built on assumption of PowerShell version 5 or above.
• Requires .NET Core 2.2 SDK
• For PostgreSQL there are two deployment modes, with different requirements:
  • (RECOMMENDED) From source scripts: automatically installs correct version of a custom database deployment tool.

  • From backup files ("templates"): requires psql  executable to be in your command path

    Install via template is primarily intended for cloud environments, where re-packaging might be necessary and the custom deployment tool may be a sub-optimal solution.

    You can install the PostgreSQL client tools locally, which includes psql.exe, from Enterprise DB. While installing you can choose to install only the command line tools without the server, if desired.

• Internet access - this is not an offline deployment process.

Web Server

• Windows 10 Professional or Windows Server 2016+.

• Server role: Web Server. On our integration server we have the following IIS features installed:

   IIS Features ...

  • Common HTTP Features
    • Default Document
    • Directory Browsing
    • HTTP Errors
    • Static Content
    • HTTP Redirection
  • Health and Diagnostics
    • HTTP Logging
    • Logging Tools
    • Request Monitor
    • Tracing
  • Performance
    • Static Content Compression
  • Security
    • Request Filtering
    • Basic Authentication
    • Windows Authentication
  • Application Development
    • .NET Extensibility 3.7
    • Application Initialization
    • ASP.NET 4.7
    • ISAPI Extensions
    • ISAPI Filters
    • WebSocket Protocol
• URL Rewrite module
• .NET Framework 4.8 runtime
• Firewall access from web server to database server, if running on separate servers.
• Does not require MSMQ or .NET Framework 3.5, unlike the full ODS/API release.

Database Server

• Installing SQL Server: both versions 2016 and 2017 have been tested. No testing on 2019 yet.
• Installing on PostgreSQL: final testing performed only on version 11; Beta release was also tested on version 10. No testing on 12 yet.
• Credentials with permission to create and drop databases.

Things to note:

• Because of Admin App we can get rid of the "backdoor" script
• Changes to the deployment process, but should be transparent to end-users
• Using the final release of version 3.3 with support for Data Standard 3.2.