Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add a run script for building an ontologies_api server #3

Closed
wants to merge 5 commits into from

Conversation

syphax-bouazzouni
Copy link

@syphax-bouazzouni syphax-bouazzouni commented Nov 13, 2023

Context

This repository at first started as a way to easily do an ontoportal development environment using Docker for the API. Since then in each of our projects we developed, Dockerfiles, docker-compose, and dip files, making it possible to run an environment development for each directly in the working repository.

So maintaining a separate repository for docker development makes no more sense. This PR is the first push to transform this repository from OntoPortal docker development environment to OntoPortal docker appliance

Requirements

  • Have a script to run an Ontoportal API server, using as source Bioportal or Agroportal images or any other if existent.
  • Have a script to run an Ontoportal UI server, using as a source Bioportal, Agroportal images, or any other if existent.
  • Have a script to run an Ontoportal appliance server, using as a source Bioportal, Agroportal images, or any other if existent

How it works

See Help using run --help

➜  ontoportal_docker git:(main) run --help
Usage: run -k API_KEY -u API_URL -s STARTER_ONTOLOGY
    -k, --api-key API_KEY            Your Ontoportal API key
    -u, --api-url API_URL            Ontoportal API URL (default: https://data.bioontology.org)
    -r DOCKER_HUB_REPOSITORY,        Ontoportal API image repository (default: bioportal)
        --docker-hub-repository
    -t, --image-tag DOCKER_IMAGE_TAG Ontoportal API image version (default: latest)
    -s [STARTER_ONTOLOGY],           Starter ontology code (default: STY)
        --starter-ontology
    -h, --help                       Show this message

Run an API using Bioportal code

run -k <api_key> -r bioportal

Run an API using Agroportal code

run -k <api_key> -r agroportal -t stage

Changes

  • Extend to env file to add images sources option (8a99e0d)
  • Add a run script to execute the necessary commands to run a API server (8a99e0d)

@syphax-bouazzouni syphax-bouazzouni marked this pull request as draft November 13, 2023 09:00
@syphax-bouazzouni syphax-bouazzouni linked an issue Nov 13, 2023 that may be closed by this pull request
@syphax-bouazzouni syphax-bouazzouni force-pushed the main branch 5 times, most recently from 2de8736 to 31dd1a1 Compare November 15, 2023 21:57
@syphax-bouazzouni
Copy link
Author

Moved to #6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make the docker compose configurable
1 participant