Skip to content

Comments

Docker: Add a separate videx-server image to support launching the server and executing the videx-sync scripts.#82

Merged
kr11 merged 5 commits intomainfrom
kangrong/videx_server_docker
Jan 31, 2026
Merged

Docker: Add a separate videx-server image to support launching the server and executing the videx-sync scripts.#82
kr11 merged 5 commits intomainfrom
kangrong/videx_server_docker

Conversation

@kr11
Copy link
Member

@kr11 kr11 commented Jan 19, 2026

Pull Request Summary

This PR introduces a combined videx-server Docker image that can run either the VIDEX server or the videx-sync workflow from the same image, removing the need to prepare a separate Python environment for videx_build_env/videx-sync. It also adds Docker usage documentation in doc/VIDEX_SERVER_DOCKER.md.

Related Issues

Related: MDEV-38422

Detailed Description

What problem does this PR solve?
Previously, the Dockerfile and documentation did not provide an easy “one-image” path for the full VIDEX flow. In practice, users had to run the server and then run videx-sync (videx_build_env) separately, which typically required setting up a dedicated Python environment outside the container.

This PR makes an end-to-end experience (start server + sync metadata) using several docker commands.

How does the solution work?

  • A new consolidated image kangrongme/videx-server:0.2.0 is provided (and pushed) which supports two entrypoint modes:
    • server (default): starts the VIDEX server
    • sync: runs the one-shot videx-sync / videx_build_env workflow
  • The documentation doc/VIDEX_SERVER_DOCKER.md explains:
    • how to start the server container
    • how to run sync using the same image
    • recommended networking guidance (use a routable IP rather than localhost) for a smoother workflow
  • Added a draft documentation to explain what VIDEX is and how to use VIDEX (to be submitted to MariaDB-docs): doc/videx-storage-engine.md.

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to VIDEX! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Core]: Changes to core engine functionality
  • [Opt]: Changes to VIDEX-Optimizer-Plugin
  • [Stats]: Changes to VIDEX-Statistic-Server
  • [Algo]: Implementation of new algorithms for NDV, cardinality estimation, etc.
  • [Pipe]: Enhancements to the pipeline (e.g., data collection, environment setup)
  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [Test]: Adding or updating tests
  • [Perf]: Performance improvements
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use the most specific prefix or multiple prefixes in order of importance (e.g., [Algorithm][Stats]).

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Changes have been tested on both Plugin-Mode and Standalone-Mode (if applicable)
  • Statistical accuracy has been verified (for algorithm or optimizer changes)
  • No regression in query plan accuracy compared to InnoDB (if applicable)
  • Performance benchmarks conducted (for performance-sensitive changes)

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@kr11
Copy link
Member Author

kr11 commented Jan 19, 2026

Hi @grooverdan @YoungHypo , as we discussed in #79, I submitted a separate VIDEX-server docker images PR to enable a short, end-to-end workflow (start server + sync metadata) with concise Docker commands. Could you please review? Thanks!

@kr11 kr11 force-pushed the kangrong/videx_server_docker branch from f0a43ea to 0151cc7 Compare January 26, 2026 16:38
@kr11 kr11 force-pushed the kangrong/videx_server_docker branch from a1b146b to 91687a5 Compare January 28, 2026 16:13
@kr11 kr11 mentioned this pull request Jan 28, 2026
3 tasks
@kr11
Copy link
Member Author

kr11 commented Jan 31, 2026

All comments are resolved.

@kr11 kr11 merged commit c969152 into main Jan 31, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants