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

Offer an all-in-one container image for easier testing and demonstration #1210

Open
2 tasks done
nscuro opened this issue Apr 18, 2024 · 0 comments
Open
2 tasks done
Labels
dx Issues related to developer experience (DX) enhancement New feature or request p3 Nice-to-have features size/M Medium effort

Comments

@nscuro
Copy link
Member

nscuro commented Apr 18, 2024

Current Behavior

Hyades consists of multiple services, each of which are currently distributed as individual container images:

  • PostgreSQL
  • Kafka
  • API server
  • Frontend
  • Mirror Service
  • Notification Publisher
  • Repository Meta Analyzer
  • Vulnerability Analyzer

While this provides deployment flexibility, it makes it harder to quickly get something up-and-running.

Users wishing to build and test integrations with the system would benefit from having a single container instead, which they then can integrate with testcontainers.

For demonstration purposes, spinning up a single container is much more straightforward than having to setup a Docker Compose or Minikube environment.

Proposed Behavior

Provide a container image that contains all necessary services.

The services should be configured with a minimal resource footprint, such that the container can be run in CI environments, and normal laptops. For this reason, we will probably want to package native executables instead of JARs where possible.

Starting the image without additional configuration should "just work".

The image must not contain any software that is licensed under non-OSI compliant licenses, such as Redpanda, which is BUSL-licensed.

It needs to be made clear that the image is not intended for production use.

Checklist

@nscuro nscuro added enhancement New feature or request p3 Nice-to-have features size/M Medium effort dx Issues related to developer experience (DX) labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Issues related to developer experience (DX) enhancement New feature or request p3 Nice-to-have features size/M Medium effort
Projects
None yet
Development

No branches or pull requests

1 participant