Individual docker scripts
PR Description
This PR serves to introduce two scripts that will create the individual container scripts needed to run the application in production.
Tasks
- [ ] - A description of the PR has been provided, and a diagram included if it is a new feature.
- [ ] - Formatter has been run
- [ ] - CHANGELOG comment has been added
- [ ] - Labels have been assigned to the pr
- [ ] - A reviewer has been added
- [ ] - A user has been assigned to work on the pr
- [ ] - If new feature a unit test has been added
Summary by Sourcery
This pull request introduces scripts to generate individual Docker container scripts for metadata and repository services, and enhances the generate_datafed.sh script to support specifying the database port.
New Features:
- Introduces two new scripts,
generate_metadata_container_scripts.shandgenerate_repo_container_scripts.sh, to generate individual container scripts for running the application in production. -
generate_metadata_container_scripts.shcreates scripts for managing ArangoDB, DataFed Core, DataFed Web, and Nginx containers, including creation, stopping, and removal. -
generate_repo_container_scripts.shcreates scripts for managing DataFed Repo and GCS containers, including creation, stopping, and removal.
Enhancements:
- The
generate_datafed.shscript now includes an option to specify the database port via theDATAFED_DATABASE_PORTenvironment variable.
Reviewer's Guide by Sourcery
This PR introduces two new scripts, generate_metadata_container_scripts.sh and generate_repo_container_scripts.sh, to create individual container scripts for running the application in production. It also adds DATAFED_DATABASE_PORT to the datafed.sh config file.
No diagrams generated as the changes look simple and do not need a visual representation.
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Added a script to generate container scripts for the metadata server. |
|
scripts/generate_metadata_container_scripts.sh |
| Added a script to generate container scripts for the repository server. |
|
scripts/generate_repo_container_scripts.sh |
| Added DATAFED_DATABASE_PORT to the datafed.sh config file. |
|
scripts/generate_datafed.sh |
Tips and commands
Interacting with Sourcery
-
Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
-
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. -
Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. -
Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. -
Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. -
Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. -
Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review! -
Generate a plan of action for an issue: Comment
@sourcery-ai planon an issue to generate a plan of action for it.
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
https://github.com/ORNL/DataFed/pull/974
Dependant on https://github.com/ORNL/DataFed/pull/1336