Versions Compared

Old Version 5

changes.mady.by.user Vinaya Mayya

Saved on

compared with

New Version Current

changes.mady.by.user Vinaya Mayya

Saved on

Key

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

Table of Contents
maxLevel2

...

Image NameApplicationPurpose
ods-api-web-gatewayNGiNX​ 1.25.1

Reverse proxy web server that provides:

  1. Single point of entry for HTTPS traffic into the Docker network, serving routes for:
    1. Web API
    2. Admin Api
  2. SSL termination
  3. (Potential) load balancing for multiple Web API instances
  4. (Potential) traffic logging

"Potential" means that the container can be reconfigured to support these features.

ods-api-web-gateway-sandboxNGiNX 1.25.1

Similar to ods-api-web-gateway, except serving routes for:

  • Web API
  • Sandbox Admin Web
  • Swagger UI
ods-api-web-apiEd-Fi Web APIHosts the core Ed-Fi Web API web service. Sections below describe various configuration options. Configured for use with PostgreSQL databases.
ods-api-web-api:<TAG>-mssqlEd-Fi Web APIHosts the core Ed-Fi Web API web service. Sections below describe various configuration options. Configured for use with Microsoft SQL Server databases.
ods-api-web-swaggeruiEd-Fi SwaggerUIHosts a web-based user interface for documenting the API and allowing users with client credentials to interact with the API.
ods-api-web-sandbox-adminEd-Fi Sandbox AdminHosts the Ed-Fi Sandbox web application, used for configuring new sandboxes used for client testing. Configured for use with PostgreSQL databases.
ods-api-web-sandbox-admin:<TAG>-mssqlEd-Fi Sandbox AdminHosts the Ed-Fi Sandbox web application, used for configuring new sandboxes used for client testing. Configured for use with Microsoft SQL Server databases.
ods-api-db-odsPostgreSQL 13.12Pre-configured PostgreSQL database containing the ODS database, with both the Ed-Fi core data model and the Teacher Preparation Data Model (TPDM). Loaded with the "minimal template" that provides a default set of Descriptors and no other data.
ods-api-db-sandboxPostgreSQL 13.12Like the ods-api-db-ods, but using the "populated template" that contains a small set of sample data representing the fictional Grand Bend school district.
ods-api-db-adminPostgreSQL 13.12Pre-configured PostgreSQL server with two database: EdFi_Admin and EdFi_Security.
ods-admin-apiEd-Fi ODS Admin ApiHosts the Ed-Fi ODS Admin Api web application, configured for use with PostgreSQL databases, and configurable for Single Tenant and Single Tenant with ODS Contexts.
ods-admin-api-dbPostgreSQL 13.12Pre-configured PostgreSQL server with two database: EdFi_Admin with Admin Api specific tables and EdFi_Security.
PgBouncer

PgBouncer latest (1.20.0)

Lightweight PostgreSQL connection pooler that improves application scalability through connection pooling.

...

SingleTenant Configuration 

This configuration shows a basic example of a single tenant configuration were where a single ODS database that serves all data going through the API. While this example has one ODS for demonstration purpose, single tenant deployments can support separate ODS per school years and districts. See API Client and ODS Instance Configuration for more information.

...