issue #3062: document Hop Server deployment patterns - #7920
Merged
Conversation
Add a deployment manual for getting a git-hosted project onto Hop Server (image, export resources, git checkout), document the short-lived container alternative, and add the missing OpenSearch execution information location page.
jefersonminatozaki
pushed a commit
to jefersonminatozaki/hop
that referenced
this pull request
Aug 14, 2026
Add a deployment manual for getting a git-hosted project onto Hop Server (image, export resources, git checkout), document the short-lived container alternative, and add the missing OpenSearch execution information location page. Co-authored-by: Hans Van Akelyen <hans.van.akelyen@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this is
Documentation for issue #3062: after you develop a Hop project, how do you actually get it onto a running Hop Server (or decide you do not need one)?
Docs only. No engine or CLI changes.
Deployment manual
New section under Hop Server → Deploying Hop Server:
deploying.adoc) — project vs environment, comparison table, and when a Hop Server is not needed at all.FROM apache/hopat/your-project. Same image can be:hop-conf,hop-server.sh -e prod,git pull, and what needs a restart.Sample Dockerfile, Compose file, GitHub Actions workflow and systemd unit live under
docs/.../assets/files/hop-server/.-eis enough to start hop-run / hop-server; the project name comes from the environment.HOP_PROJECT_NAMEis still required in Docker because the entrypoint creates the project before the environment.OpenSearch execution information location
The OpenSearch location type was undocumented. Adds
opensearch-location-type.adoc(options, create-index mapping) and a comparison with Elastic: basic auth vs API key, ignore-SSL,/_plugins/_sqlvs_search, nested vs dotted mappings. Wired intoexecution-information-location.adoc, the metadata index, nav, and the Elastic page.Cross-links
Pointers from Hop Server, hop-run, remote run configs, Docker tech manual, Helm README, Airflow how-to, web-services how-to, projects, best practices, and Getting Started.