PIFSC PRI Oracle Developer Environment

Overview

The PIFSC Resource Inventory (PRI) Oracle Developer Environment (PCODE) project was developed to provide a custom containerized Oracle development environment (CODE) for the DSC. This repository can be forked to extend the existing functionality to any data systems that depend on the DSC for both development and testing purposes.

Resources

• PCODE Version Control Information

  • URL: https://github.com/noaa-pifsc/PIFSC-PRI-Containerized-Oracle-Development-Environment
  • Version: 1.0 (git tag: PRI_CODE_v1.0)
  • Upstream repository:
    • DCODE Version Control Information:
      • URL: https://github.com/noaa-pifsc/PIFSC-DSC-Containerized-Oracle-Development-Environment
      • Version: 1.3 (git tag: DCODE_v1.3)

Dependencies

* Note: all dependencies are implemented as git submodules in the modules folder

• PRI Version Control Information

  • folder path: modules/PRI
  • Version Control Information:
    • URL: https://picgitlab.nmfs.local/centralized-data-tools/pifsc-resource-inventory.git
    • Application: 1.8 (Git tag: PRI_docker_app_v1.8)

• DSC Version Control Information

  • folder path: modules/DSC
  • Version Control Information:
    • URL: <[email protected]:centralized-data-tools/pifsc-dsc.git>
    • Database: 1.1 (Git tag: dsc_db_v1.1)

• Container Deployment Scripts (CDS) Version Control Information

  • folder path: modules/CDS
  • Version Control Information:
    • URL: <[email protected]:noaa-pifsc/PIFSC-Container-Deployment-Scripts.git>
    • Scripts: 1.1 (Git tag: pifsc_container_deployment_scripts_v1.1)

Prerequisites

• See the CODE Prerequisites for details

Repository Fork Diagram

• See the CODE Repository Fork Diagram for details

Runtime Scenarios

• See the CODE Runtime Scenarios for details

Automated Deployment Process

• Prepare the project

  • Recursively clone (use --recurse-submodules option) the PCODE repository to a working directory
  • (optional) Update the .env custom environment variables accordingly for the PRI app
  • Create the git_key.txt in the secrets folder with a git API key to authenticate requests to the git API.
    • git_key.template.txt is a template available that can be renamed to define the secret

• Build and Run the Containers

  • See the CODE Build and Run the Containers for details

  • DSC Database Deployment

    • create_docker_schemas.sql is executed by the SYS schema to create the DSC schema and grant the necessary privileges
    • deploy_dev_container.sql is executed with the DSC schema to deploy the objects to the DSC schema

  • PRI Database Deployment

    • create_docker_schemas.sql is executed by the SYS schema to create the PRI schema and grant the necessary privileges
    • deploy_dev.sql is executed with the PRI schema to deploy the objects to the PRI schema
    • deploy_RIA_dev.sql is executed with the PRI_RIA_APP schema to deploy the objects to the PRI_RIA_APP schema
    • deploy_GIM_dev.sql is executed with the PRI_GIM_APP schema to deploy the objects to the PRI_GIM_APP schema

Customization Process

• Implementation

  • *Note: this process will fork the PCODE parent repository and repurpose it as a project-specific CODE
  • Fork this repository
  • See the CODE Implementation for details

• Upstream Updates

  • See the CODE Upstream Updates for details

Container Architecture

• See the CODE container architecture documentation for details

• PCODE Customizations:

  • docker/.env was updated to define an appropriate APP_SCHEMA_NAME value
  • custom_deployment_functions.sh was updated to add the PRI docker-compose.yml file and the secrets/.env file. It was also updated to remove the CODE-ords.yml configuration file
  • custom-docker-compose.yml was updated to implement file-based secrets, PRI and CODE-specific mounted volume overrides
  • custom_db_app_deploy.sh was updated to deploy the PRI database and application schemas
  • custom_container_config.sh was updated to define DB credentials and mounted volume file paths for the PRI SQL scripts
  • Multiple files were added in the secrets folder to specify secret values (e.g. ria_pass.txt to specify the RIA database password)
    • secrets/.env was updated to specify PRI-specific and CODE-specific environment variables

Connection Information

• See the CODE connection information documentation for details

• DSC Database Connection Information

  • Connection information can be found in create_docker_schemas.sql

• PRI Database Connection Information

  • Connection information can be found in create_docker_schemas.sql

License

See the LICENSE.md for details

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.