Add local/IP deployment guide and clarify http vs https in examples#192
Merged
Conversation
…ples Several first-run failures share one root cause: the docs and demo slides implicitly assume a real domain with TLS, so evaluators deploying on a bare IP without a certificate hit avoidable errors (e.g. https://<ip> failing, which surfaces downstream as a confusing "Kafka endpoint undefined"). Add a "Local / IP-based deployment (no domain, no TLS)" section to the README covering http vs https, host IP vs internal overlay addresses, ports, profiles without Pelican, rebuilding after updates, and the Kafka reachability caveat (KAFKA_HOST/KAFKA_PORT are returned to clients verbatim, so they must be externally reachable). Also note in the Python automation guide and the demo presentation that the https examples assume a domain+cert and a bare IP should use http. Closes #191
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
1 participant
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.
Closes #191
Why
Pratik's evaluation surfaced a series of first-run failures that all share one root cause: the docs and demo slides implicitly assume the Endpoint is reached through a real domain with a valid TLS certificate. Deploying on a bare VM/IP without a domain (a common evaluation setup) repeatedly breaks — most recently, a streaming-client call failed with a confusing "Kafka endpoint undefined" message that was actually caused by using
https://<ip>(no certificate on a bare IP).Changes
http://nothttps://, use the host's real IP (not internal overlay/pod addresses like10.244.x.x), the correct ports (docker run→ 8001, compose → 8002, container always :80), profiles without Pelican, rebuilding after updates, and the Kafka/streaming reachability caveat — the Endpoint returns the configuredKAFKA_HOST/KAFKA_PORTverbatim viaGET /status/kafka-details, so clients outside the Docker network need externally reachable values, not internal names likekafka:9093.docs/info_for_nationaldataplatform/04-automating-with-python.md— note that thehttps://…base_urlexamples assume a domain + cert and a bare IP/localhost should usehttp://.docs/demo/NDP-demo-presentation.md— same one-line clarification on theAPIClientslide.0.32.4.Testing
Documentation-only change; the only code change is the version string (tests mock the version).