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

DOC: Architecture - Required env vars and split into containers #193

Open
ghsa-retrieval opened this issue Nov 8, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@ghsa-retrieval
Copy link

ghsa-retrieval commented Nov 8, 2024

What type of documentation would you like?
Documentation about the architecture of DejaCode and how its components interact with each other and other systems (postgres, redis, scancode, ldap, ...) for authentication

Documentation topic
I'm currently attempting to build a helm chart for DejaCode based on the provided Docker Compose solution, but the current architecture left some questions not answered by current documentation. I have asked about this on gitter and Philippe Ombredanne instructed me to file a ticket.

  1. Recently the scheduler has been introduced for updating vulnerability information. In Docker Compose it is run as a separate container. Is there any reason it is not simply a background task in the worker?
  2. Currently all containers started by compose share environment variables. Most likely web, worker and scheduler do not all need access to the DB and redis password as well as other env vars. Which ones are actually needed for which container? Relevant env vars are:
    • DATABASE_PASSWORD
    • REDIS_URL
    • DEJACODE_REDIS_PASSWORD
    • SECRET_KEY
    • SECRET_KEY_FALLBACKS
    • EMAIL_HOST_PASSWORD
    • AUTH_LDAP_BIND_PASSWORD
    • SCANCODEIO_API_KEY
    • PURLDB_API_KEY
    • VULNERABLECODE_API_KEY
@ghsa-retrieval ghsa-retrieval added the documentation Improvements or additions to documentation label Nov 8, 2024
@ghsa-retrieval ghsa-retrieval changed the title DOC: Require env vars and split into containers DOC: Architecture - Required env vars and split into containers Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant