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

Store all Compose files and configs in one place #1

Closed
alyssadai opened this issue Sep 6, 2023 · 3 comments · Fixed by #2
Closed

Store all Compose files and configs in one place #1

alyssadai opened this issue Sep 6, 2023 · 3 comments · Fixed by #2
Assignees
Labels
released This issue/pull request has been released.

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Sep 6, 2023

We have a couple of deployment "flavours" now:

  • n-API+graph docker-compose.yml + .env file
  • f-API+query tool docker-compose.yml + .env file + .json (for node definition)
  • n-API+graph+query tool

And we provide the template environment and docker compose files in a number of places, but mainly in the API repo. Instead we want to have a single place where we store all of the config and docker recipe files so we can

  • Point a new user to this repo so that they can just clone all of the config files and none of the code
  • Have a place where we can go to (automatically) test that all of our tools work well together
  • Reduce the complexity of the config files and our docs about them, by splitting config into appropriate file names and file formats

We should store configuration-related files in a dedicated repo, maybe called recipes.
This repo should include configurations for each "flavour", ideally in separate subdirectories.

Existing files that would probably be affected as part of this issue:

We could also move our environment variable table into this repo, under a docs/ subdirectory.
https://github.com/neurobagel/api/blob/main/docs/api_environment_variables.tsv

Originally posted by @surchs in neurobagel/api#154 (comment)

Potentially of interest:

@github-actions
Copy link

github-actions bot commented Oct 9, 2023

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 30 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@alyssadai
Copy link
Contributor Author

See also neurobagel/documentation#133

@alyssadai alyssadai transferred this issue from neurobagel/api Nov 23, 2023
@rmanaem rmanaem changed the title Investigate having multiple Compose files Multiple Compose files Nov 24, 2023
@alyssadai alyssadai self-assigned this Dec 4, 2023
@alyssadai alyssadai transferred this issue from neurobagel/planning Dec 5, 2023
@alyssadai alyssadai moved this from Implement - Active to Implement - Done in Neurobagel Dec 5, 2023
@alyssadai alyssadai changed the title Multiple Compose files Store all Compose files and configs in one place Dec 5, 2023
@surchs surchs moved this from Implement - Done to Review - Active in Neurobagel Dec 5, 2023
@github-project-automation github-project-automation bot moved this from Review - Active to Review - Done in Neurobagel Dec 6, 2023
Copy link
Contributor

neurobagel-bot bot commented Aug 7, 2024

🚀 Issue was released in v0.0.1 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This issue/pull request has been released.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant