HOWTO – Install and verify HybridOps.Core on a bootstrap workstation¶
This HOWTO is the operator walkthrough for installing HybridOps.Core from a release artefact and proving the runtime is ready to execute modules. It is written for repeatability and auditability.
Difficulty: Intro
Prerequisites: A HybridOps.Core release artefact (.tar.gz), shell access to the workstation, and any provider credentials required by the modules you intend to run.
Demo¶
A short walkthrough video is recommended for this HOWTO.
- Demo: (pending)
- Source: (not required; HybridOps.Core is delivered as a release artefact)
Context¶
HybridOps.Core is delivered as a versioned release artefact. The installation path is intentionally minimal:
install.shinstallshyopsto a predictable location.hyops initcreates the local runtime directory and baseline state.hyops preflightvalidates required tooling and environment access for the module set you plan to run.hyops validateconfirms runtime wiring before executing modules.
For the operational checklist version of this flow, see the linked runbook in References.
Steps¶
1) Extract the release artefact¶
mkdir -p ~/downloads/hybridops
cd ~/downloads/hybridops
tar -xzf hybridops-core-<version>.tar.gz
cd hybridops-core
Expected result: the extracted directory contains install.sh and bin/hyops.
2) Install hyops¶
Default install target: ~/.local/bin/hyops
./install.sh
Optional: install to a custom directory:
HYOPS_BIN_DIR=/opt/hybridops/bin ./install.sh
Expected result: hyops is installed and executable.
3) Ensure hyops is on PATH¶
If using the default install location, ensure ~/.local/bin is on PATH:
command -v hyops >/dev/null && echo "hyops on PATH" || echo "hyops not on PATH"
If required, update your shell profile (example for bash):
grep -q 'export PATH="$HOME/.local/bin:$PATH"' ~/.bashrc || echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
. ~/.bashrc
Expected result: command -v hyops returns a path.
4) Initialise HybridOps.Core runtime state¶
hyops init
Expected result: ~/.hybridops/ exists and baseline runtime state is created.
5) Run preflight checks¶
hyops preflight
If you are preparing for a specific environment context:
HYOPS_ENV=dev hyops preflight
Expected result: required tools and versions are validated; missing prerequisites are reported with actionable remediation.
6) Validate runtime wiring¶
hyops validate
Expected result: core runtime checks pass and the workstation is ready to execute modules.
Validation¶
Installation and verification are complete when:
hyopsis installed and on PATH (command -v hyopssucceeds).hyops initcompletes successfully and~/.hybridops/exists.hyops preflightreports the workstation is ready (or only reports known, acceptable gaps for modules you are not using).hyops validatecompletes successfully.
Troubleshooting¶
hyops not found after install¶
- Confirm installation location:
ls -la ~/.local/bin/hyops - Confirm PATH includes the install directory:
echo "$PATH" | tr ':' '\n' | sed -n '1,120p'
Preflight reports missing tools¶
Install the missing tools indicated by hyops preflight, then re-run:
hyops preflight
hyops validate
If your installation model requires pinned versions, align your workstation tooling to the versions declared by your release (where applicable).
Uninstall / rollback¶
Use this only when removing a workstation installation.
1) Remove the installed binary:
rm -f "$(command -v hyops)"
2) Remove local runtime state (destructive):
rm -rf ~/.hybridops
3) Remove any PATH modifications you added.
References¶
- Runbook – Install and initialise HybridOps.Core
- Quickstart: Install and run HybridOps.Core
- ADR-0622 – Core architecture: Modules, Drivers, Probes
Maintainer: HybridOps.Studio
License: MIT-0 for code, CC-BY-4.0 for documentation