Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning

INTERNAL DRAFT

...

Info

Release candidate for Roadrunner.

Changes since Beta 1:

  • Using the same ODS/API code as recently released for version 3.3 (thus the ODS/API at "production quality")
  • Supports Data Standard 3.2
  • Improvements to the deployment scripts
  • Admin App
  • No longer testing on PostgreSQL 10, now that all three cloud providers support PostgreSQL 11.
(warning) Note: full release of PostgreSQL support will drop the "Roadrunner" code name. Tentatively, it will be released as "ODS/API Standard v3.4" (binaries only with restricted feature set), differentiated from "ODS/API Enterprise v3.4" (source code with all features)
  • .

Table of Contents

Project Scope

...

  1. Database server name
    1. In either case, is the database engine running on a non-default port? (1433 for SQL Server, 5432 for PostgreSQL)

  2. Database user credentials

    Note

    These credentials will be inserted into the web application connection strings. If using integrated security with SQL Server, then be sure to setup the IIS Appol Pool Identity user or the IIS service user, as appropriate, with db_datareader  and db_datawriter access in all three databases.


    1. If SQL Server, either the deployment account must have admin rights in the database (integrated security), or you need to provide SQL credentials that have admin rights. You can set the password via environment variable $env:SQLSERVERPASSWORD or pass it as a parameter.

    2. If PostgreSQL, then you need to provide database credentials. While the username is passed in as a parameter, the password must be passed through environment variable $env:PGPASSWORD  or, if the client tools are installed, through the pgpass config file.

  3. If installing on PostgreSQL
    1. Do you want the standard install or the template-based install? If using templates, you can choose from "empty", "minimal" (includes descriptors), and "populated" (includes a small set of sample data).
    2. If your instance requires SSL/TLS encryption, then set environment variable $env:PGSSLMODE="require" .

  4. Additional database options
    1. If the destination databases already exist, do you want to drop them? ((warning) for PostgreSQL, requires that you have the client utilities installed on the deployment server).
    2. Do you want to change the database names away from the defaults of EdFi_Admin , EdFi_ODS, and EdFi_Security?

  5. Destination folder paths for the four applications:
    1. Web API
    2. Swagger UI
    3. Admin App
    4. API Bulk Loader

This script has a long list of parameters. It can be useful to create a PowerShell object (dictionary) with the values, instead of trying to string all of the values together in a single command. Doing so makes it easier to review your parameters before running the script.

...