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

Add documentation on each Dioptra service #679

Open
2 tasks
keithmanville opened this issue Nov 19, 2024 · 0 comments
Open
2 tasks

Add documentation on each Dioptra service #679

keithmanville opened this issue Nov 19, 2024 · 0 comments
Labels
documentation Additions or changes related to documentation

Comments

@keithmanville
Copy link
Collaborator

keithmanville commented Nov 19, 2024

Describe how each Dioptra service runs (what are the necessary dependencies) and how it interacts with other services.

e.g. environment variables needed by flask service (or any other service), flask requiring a database (either postgres or sqlite which doesn't need a formal service), flask depending on redis and a worker to run jobs.

services:

  • Dioptra REST API
  • Dioptra Worker
  • MLflow Tracking Server
  • Database (sqlite, postgres) - Can be externally managed
  • Object storage (Minio, AWS S3) - Can be externally managed
  • In-memory key-value store (Redis) - Can be externally managed

A description of each service allows use to define different deployment environments.

example environments:

  1. Development (containerless)
  2. Local deployment
  3. Cloud / Distributed

The documentation should be a combination of description and diagrams showing the interactions between services.

One option for creating diagrams is Mermaid. There is a sphinx plugin: https://github.com/mgaitan/sphinxcontrib-mermaid

Definition of Done

  • All services listed above are documented in rst and built into the sphinx docs
  • New documentation is merged into dev
@keithmanville keithmanville added the documentation Additions or changes related to documentation label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Additions or changes related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant