https://github.com/darwindarak/rallyup Skip to content Navigation Menu Toggle navigation Sign in * Product + GitHub Copilot Write better code with AI + Security Find and fix vulnerabilities + Actions Automate any workflow + Codespaces Instant dev environments + Issues Plan and track work + Code Review Manage code changes + Discussions Collaborate outside of code + Code Search Find more, search less Explore + All features + Documentation + GitHub Skills + Blog * Solutions By company size + Enterprises + Small and medium teams + Startups By use case + DevSecOps + DevOps + CI/CD + View all use cases By industry + Healthcare + Financial services + Manufacturing + Government + View all industries View all solutions * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} darwindarak / rallyup Public * Notifications You must be signed in to change notification settings * Fork 4 * Star 177 rallyup is a lightweight Wake-On-LAN (WOL) scheduler and dependency manager designed for small businesses and homelabs. License Apache-2.0, MIT licenses found Licenses found Apache-2.0 LICENSE-APACHE MIT LICENSE-MIT 177 stars 4 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 0 * Pull requests 0 * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security * Insights darwindarak/rallyup master BranchesTags [ ] Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 34 Commits .github/workflows .github/ workflows src src .gitignore .gitignore Cargo.lock Cargo.lock Cargo.toml Cargo.toml LICENSE-APACHE LICENSE-APACHE LICENSE-MIT LICENSE-MIT README.md README.md View all files Repository files navigation * README * Apache-2.0 license * MIT license rallyup rallyup is a lightweight Wake-On-LAN (WOL) scheduler and dependency manager designed for small businesses and homelabs. It ensures that infrastructure services like firewalls, storage, and hypervisors are brought online in the correct order, particularly after events like power outages. A typical setup involves configuring most of the infrastructure for WOL but not for Wake-On-Power, and setting rallyup to run on startup on a low-power device like a Raspberry Pi. When you need to bring the entire environment online, simply power on the device running rallyup, and the rest of the infrastructure will automatically follow in the correct order. Tests Crates.io Features * [*] VLAN Support: Send WOL packets to devices across different VLANs. * [*] YAML Configuration: Easily define server boot sequences, dependencies, and status checks. * [ ] Service Status Checks: Verify that a service is up using built-in status checks (HTTP health checks, NFS, SMB, custom shell commands). + [*] HTTP + [*] Open port + [*] Shell + [ ] NFS (might just use open port check) + [ ] SMB (might just use open port check) * [ ] Plugin-Friendly: Users can write their own custom status check plugins. Usage rallyup servers.yaml Configuration The dependencies between servers, along with the methods for validating that they are online, are defined in a YAML configuration file. Servers Configuration Fields: * name: The name of the server, used for identification when defining dependencies between servers * mac: The MAC address of the server we want to wake up * interface: The network interface to use when sending the WOL packet * vlan: The VLAN ID (optional) that the server is on * depends: A list of other server names that this server depends on * check: A list of health checks that must pass before this server is considered fully online Example: - name: "firewall" mac: "00:11:22:33:44:55" interface: "eth0" vlan: 100 depends: - "storage" check: [... see below] * Health Check Configurations Each server can have multiple health checks to ensure the server is fully online before the next device starts up. Common Fields * retry: The interval, defined in human readable string (e.g. 1s, 1 minute, etc.) to wait between retrying this health check * timeout: The timeout interval after which the check, and subsequently the entire boot sequence, will fail Built-in Health Checks HTTP Health Checks The HTTP health check verifies whether a specified endpoint responds as expected. Fields * type: should be http for an HTTP health check. * url: The URL to perform the HTTP health check against * status: Expected HTTP status code * regex: Regex to match in the response body Note: You must provide either status or regex, or both. Example - type: http url: "http://192.168.1.1/health" status: 200 retry: 5s timeout: 30s Port Health Check The port health check verifies whether a specified TCP port on a server is open and accessible. This is really a stand-in for verifying NFS and SMB ports until I can figure out how to check if those services are online. Fields * type: should be port for a port health check * ip: the IP address to check * port: the port number to check Example - type: port ip: "192.168.1.1" port: 22 retry: "10s" timeout: "1m" Shell Health Checks The shell health check executes a shell command checks the result. This is to provide the option of user-defined health checks. Fields * type: should be shell for a shell health check. * command: he shell command to execute * status: Expected exit code * regex: Regex to match in the standard output Note: You must provide either status or regex, or both. Example - type: shell command: ping -c 1 192.168.1.1 status: 0 retry: 5s timeout: 20s Full Example TODO: + [ ] Need to test in the lab and post the actual sample - name: "Firewall" mac: "00:1A:2B:3C:4D:5E" interface: eth0 vlan: 10 depends: [] check: - type: http url: "http://192.168.1.1/health" status: 200 regex: 'ok' - name: "Storage Server 1" mac: "00:1A:2B:3C:4D:5F" interface: eth0 vlan: 100 depends: - "Firewall" check: - type: port ip: 192.168.100.101 port: 2049 timeout: 5 minutes - name: "Storage Server 2" mac: "00:1A:2B:3C:4D:5G" vlan: 100 depends: - "Firewall" check: - type: port ip: 192.168.100.102 port: 445 retry: 5s - name: "VM Host" mac: "00:1A:2B:3C:4D:60" vlan: 200 depends: - "Storage Server 1" - "Storage Server 2" check: - type: command command: "ping -c 192.168.200.10" status: 0 License This project is licensed under either of the following licenses, at your option: * MIT License * Apache License 2.0 You may choose to use this project under the terms of either license. About rallyup is a lightweight Wake-On-LAN (WOL) scheduler and dependency manager designed for small businesses and homelabs. Topics automation command-line command-line-tool wake-on-lan Resources Readme License Apache-2.0, MIT licenses found Licenses found Apache-2.0 LICENSE-APACHE MIT LICENSE-MIT Activity Stars 177 stars Watchers 1 watching Forks 4 forks Report repository Releases 1 v0.1.0 Latest Nov 5, 2024 Contributors 2 * @darwindarak darwindarak Darwin Darakananda * @kevinastone kevinastone Kevin Stone Languages * Rust 100.0% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.