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

Next Steps for VersaTiles Docker Image Improvements #14

Open
9 tasks
MichaelKreil opened this issue Oct 31, 2024 · 0 comments
Open
9 tasks

Next Steps for VersaTiles Docker Image Improvements #14

MichaelKreil opened this issue Oct 31, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@MichaelKreil
Copy link
Member

Summary

Improving the VersaTiles docker images can make them more user and developer friendly. We should include more documentation, simplify the docker file structures, and create different image variants to cover different use cases.

Suggested Improvements

  • Add documentation

    • Detailed instructions on how to set up and use the Docker images, with sample commands and configuration options.
    • Should be published to hub.docker.com during the release workflow
    • Outlined use cases for common operations such as data conversion, extraction and map data provisioning.
  • Set a default ENTRYPOINT or CMD in the Docker file to establish a common startup action, making the images easier to use by providing default behaviour.

  • Instead of maintaining three separate docker files for each variant (*-debian, *-alpine, *-scratch), consolidate them into a single docker file for multi-stage builds. Each stage (FROM ... as versatiles-debian/alpine/scratch) can then be individually targeted at build time using the --target flag.

  • We should release two basic VersaTiles images to support different use cases:

    • VersaTiles minimal:

      • A lightweight image containing only the VersaTiles binary, designed for data conversion, extraction or similar utility tasks.
      • Focuses on CLI interactions to make it as small and efficient as possible.
    • VersaTiles Server:

      • A more comprehensive image configured to serve map data over HTTPS, suitable for full-featured server environments.
      • Features may include
        • VersaTiles as a server for map data and static files.
        • Nginx as an outfacing reverse proxy.
        • Let's Encrypt for automated TLS certificate management.
        • Helper scripts for downloading and updating map data.
        • Configurable environment variables to simplify setup.
        • An ENTRYPOINT that performs tasks such as fetching map data, managing TLS certificates and starting the server.
@MichaelKreil MichaelKreil added enhancement New feature or request help wanted Extra attention is needed labels Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

1 participant