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

Increase deployability #26

Closed
2 tasks
thorbjoernl opened this issue Mar 10, 2023 · 2 comments
Closed
2 tasks

Increase deployability #26

thorbjoernl opened this issue Mar 10, 2023 · 2 comments
Labels
documentation infra infrastructure and project-wide issues triage For issues which have yet to be prioritized and assigned to a sprint.
Milestone

Comments

@thorbjoernl
Copy link
Collaborator

Increase ease of deployment

Summary

Relates to #16. The Middleware should be deployable easily, by non-developers. Documentation should be at a level where someone outside the dev-team can use the middleware. Deploying the middleware and getting a test service up should be relatively quick, not requiring too many commands.

Perhaps some shell scripts for deploying each service (which does poetry set up etc.)

Tasks

What tasks should be solved, for this issue to be complete?

  • Implement whatever

Tests

What test cases should be implemented for this issue to be completed?

  • Test whatever

Notes

Anything else?

@thorbjoernl thorbjoernl added infra infrastructure and project-wide issues documentation triage For issues which have yet to be prioritized and assigned to a sprint. labels Mar 10, 2023
@thorbjoernl
Copy link
Collaborator Author

thorbjoernl commented Mar 15, 2023

As no external dependencies are required to run the middleware, anyone who deploys the project does not need to set up a virtual environment to run it. Poetry is not required.

Python will struggle to run it properly and will complain about not finding imports if running a script

E.g.:

python services/chat_service/chat_service.py
Traceback (most recent call last):
File ".../middleware/services/chat_service/chat_service.py", line 1, in
from middleware.middlewareAPI import *
ModuleNotFoundError: No module named 'middleware'

If instead running with -m as described here, it works however:

python -m services.chat_service.chat_service

This should be included in any documentation we produce, for deploying the product.

@thorbjoernl thorbjoernl added this to the Sprint 10 milestone Mar 17, 2023
@thorbjoernl
Copy link
Collaborator Author

Closing this issue as the current level of documetation and examples should be sufficient to deploy the project reasonably easily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation infra infrastructure and project-wide issues triage For issues which have yet to be prioritized and assigned to a sprint.
Projects
None yet
Development

No branches or pull requests

1 participant