How jauderho/nts-servers works
Project type and purpose
This is an open-source tooling project whose sole purpose is to maintain and generate a vetted list of NTP servers with NTS (Network Time Security) support. It ingests a YAML source file, runs small conversion/verification scripts, and outputs both a markdown README and a chrony configuration. It lives in a GitHub repo and relies on CI to enforce quality and connectivity.
Main components
a. Data source (nts-sources.yml) – a YAML file listing servers and metadata
b. Conversion & verification scripts
• ntpServerConverter.py: reads nts-sources.yml → rewrites README.md and chrony.conf
• ntsCheck.sh / verifyNTSServers.py: ping or test NTS connectivity against listed servers
• useCommitHash.sh: embeds commit hashes (for reproducibility)
c. Outputs
• README.md: generated list presented for users
• chrony.conf: config snippet for clients
d. CI/CD pipeline (GitHub Actions)
• Linting, security scans, connectivity checks, dependency reviews, spell checks
e. External dependencies
• Python runtime, shell
• GitHub (source control + Actions runner)
• Target NTS servers (for connectivity validation)
Relationships & data flow
• Developer edits nts-sources.yml → commit → GitHub Actions triggers
• ntpServerConverter.py reads nts-sources.yml → outputs updated README.md & chrony.conf
• Verification scripts hit each NTS server to confirm reachability/valid config
• CI jobs run linting & tests → on success, PR can be merged
• End users clone/download the repo or use chrony.conf directly
Architectural patterns & design principles
• Single responsibility: each script does one task (convert, check, tag)
• Data-driven generation: YAML is the single source of truth
• GitOps style: all changes flow through Git PRs and automated CI checks
• Minimal dependencies: relies only on Python stdlib, basic shell tools