feat(local-setup): add hosts entry validation before installation #751
Conversation
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
Add pre-installation check to verify that portal.dev.local and kcp.api.portal.dev.local resolve to 127.0.0.1 before starting the local setup process. Changes: - Add check_hosts_entry() and check_hosts_entries() functions to check-environment.sh - Validate DNS entries during environment checks phase - Fail early with clear, actionable error messages if entries are missing - Provide platform-specific guidance (macOS, Linux, WSL) - No sudo required - uses native OS tools (dscacheutil, getent) with fallback to /etc/hosts parsing - Update end-of-installation message to only remind about organization-specific hosts entries This prevents the installation from failing with cryptic connection errors when kubectl commands try to access kcp.api.portal.dev.local during the installation process. Signed-off-by: Bastian Echterhölter <bastian.echterhoelter@sap.com> On-behalf-of: @SAP <bastian.echterhoelter@sap.com>
nexus49
force-pushed
the
feat/add-hosts-entry-check
branch
from
3cc25ed to
333a843
Compare
akafazov
approved these changes
Dec 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds pre-installation validation to check that required DNS entries (
portal.dev.localandkcp.api.portal.dev.local) are properly configured before starting the local setup process.Problem
Currently, the local setup only suggests adding hosts entries at the end of installation. This causes the installation to fail with cryptic connection errors when:
kcp.api.portal.dev.local:8443during example-data setupSolution
Add early validation during the environment checks phase that:
127.0.0.1Changes
local-setup/scripts/check-environment.shcheck_hosts_entry()function that detects OS and uses appropriate DNS resolution methoddscacheutilgetent(with fallback to direct/etc/hostsparsing)127.0.0.1)check_hosts_entries()function that validates both required hostnames/etc/hostsrun_environment_checks()to run before installation startslocal-setup/scripts/start.sh