From a3e8aa6c319e38606e7d10562c793e3027c57ff4 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Sat, 24 Feb 2024 10:14:05 -0300 Subject: Feat: migrate docs to MkDocs --- docs/assets/banner.png | Bin 0 -> 21206 bytes docs/assets/banner.svg | 458 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/assets/logo.png | Bin 0 -> 10323 bytes docs/index.md | 10 ++ docs/install.md | 30 ++++ docs/management.md | 34 ++++ 6 files changed, 532 insertions(+) create mode 100644 docs/assets/banner.png create mode 100644 docs/assets/banner.svg create mode 100644 docs/assets/logo.png create mode 100644 docs/index.md create mode 100644 docs/install.md create mode 100644 docs/management.md (limited to 'docs') diff --git a/docs/assets/banner.png b/docs/assets/banner.png new file mode 100644 index 0000000..8224d95 Binary files /dev/null and b/docs/assets/banner.png differ diff --git a/docs/assets/banner.svg b/docs/assets/banner.svg new file mode 100644 index 0000000..853ae7b --- /dev/null +++ b/docs/assets/banner.svg @@ -0,0 +1,458 @@ + + + + + + + + image/svg+xml + + + + + + + + + + diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..ee1e538 Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e833e89 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,10 @@ +# Hydra Suite - Command and Control + +Hydra is a suite for orchestration and management of machines composed of +the following basic commands: + +* `hydractl`: act in the current host. +* `hydra`: act on at set of hosts. +* `hydras`: act on a superset of hosts. + +Check also the [slides](slides) (portuguese only). diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000..4bf9fc0 --- /dev/null +++ b/docs/install.md @@ -0,0 +1,30 @@ +# Installation + +## Clone + +First, clone the code: + + git clone https://git.fluxo.info/hydra + +You can use the following to check the integrity of the latest release: + + /usr/bin/git -C hydra verify-commit HEAD + +Note that `/usr/bin/git` is called to avoid any other `git` wrappers or aliases +you might have available on your shell. + +There are some ways you can install the suite in your system: + +* Adding the whole `hydra` folder into your `PATH`. +* By symlinking `hydra`, `hydractl` and optionally `hydras` into your `~/bin` folder. +* By doing a system-wide install at `/usr/local` simply running + + ./hydractl install + +## Dependencies + +Major direct upstreams: + +* `Debian `_ +* `Puppet `_ +* `Git `_ diff --git a/docs/management.md b/docs/management.md new file mode 100644 index 0000000..350111e --- /dev/null +++ b/docs/management.md @@ -0,0 +1,34 @@ +# Management + +## Sets and supersets + +The Hydra Suite is flexible enough so you can use it to: + +* Manage a single machine using `hydractl` command. +* Manage a set or a subset of machines -- a *network* -- from the same + organization using `hydra` command. +* Manage a superset of machines -- *a constelation* -- comprised of one or more + organizations using `hydras` command. + +## Creating a new network + +Use the following commands to create the needed repositories when starting a +new network: + + hydra example init ~/file/example + hydra example config domain example.org + +This makes `~/files/example` the base folder for all configuration of the +network of machines called `example`. + +## Managing an existing network + +If you have enough credentials (ssh pubkey set in the server), you can fetch +all the needed repositories and configurations to a local folder +`~/file/example` using simply the following command: + + hydra example init ~/file/example git@admin.example.org: + +This will try to fetch a superproject from git@admin.example.org:example.git +-- if exists, plus submodules -- or each git repository used by a network +previously created by the `init` action (`config.git`, `puppet.git`, etc). -- cgit v1.2.3