From f90fcd8e0f573352fe3bdb930372bf5a7ac881d3 Mon Sep 17 00:00:00 2001 From: marshmallow Date: Mon, 27 Oct 2025 18:29:06 +1100 Subject: [PATCH] be more consistent about stylization --- CHANGELOG.md | 22 +++++++++++----------- doc/guides/apply.md | 6 +++--- doc/guides/keys.md | 12 ++++++------ doc/guides/parallelism.md | 6 +++--- doc/guides/targeting.md | 2 +- doc/reference/meta.md | 4 ++-- doc/tutorial/overview.md | 18 +++++++++--------- doc/tutorial/part-one/basic-hive.md | 4 ++-- doc/tutorial/part-one/nix-setup.md | 4 ++-- doc/tutorial/part-one/repo-setup.md | 2 +- doc/tutorial/part-two/basic-keys.md | 2 +- doc/tutorial/part-two/encryption.md | 2 +- wire/lib/src/hive/steps/keys.rs | 2 +- 13 files changed, 43 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index adff736..277fa88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `--path` now supports flakerefs (`github:foo/bar`, `git+file:///...`, `https://.../main.tar.gz`, etc). - `--flake` is now an alias for `--path`. -- Wire will now attempt to use SSH `ControlMaster` by default. +- wire will now attempt to use SSH `ControlMaster` by default. - A terminal bell will be output if a sudo / ssh prompt is ever printed. ### Fixed @@ -44,18 +44,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Documented - Added a real tutorial, and separated many how-to guides. - The tutorial leads the user through creating and deploying a Wire Hive. + The tutorial leads the user through creating and deploying a wire Hive. ## [0.5.0] - 2025-09-18 ### Added -- Added `--reboot`. Wire will wait for the node to reconnect after rebooting. - Wire will refuse to reboot localhost. Keys post-activation will be applied +- Added `--reboot`. wire will wait for the node to reconnect after rebooting. + wire will refuse to reboot localhost. Keys post-activation will be applied after rebooting! - Most errors now have error codes and documentation links. - Added the global flag `--non-interactive`. -- Wire now creates its own PTY to interface with openssh's PTY to allow for +- wire now creates its own PTY to interface with openssh's PTY to allow for interactive sudo authentication on both remote and local targets. Using a wheel user as `deployment.target.user` is no longer necessary @@ -68,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - `wire inspect/show --json` will no longer use a pretty print. -- Wire will now wait for the node to reconnect if activation failed (excluding +- wire will now wait for the node to reconnect if activation failed (excluding dry-activate). - Nix logs with the `Talkative` and `Chatty` level have been moved to `tracing_level::TRACE`. @@ -84,13 +84,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Nodes may now fail without stopping the entire hive from continuing. A summary of errors will be presented at the end of the apply process. -- Wire will now ping the node before it proceeds executing. -- Wire will now properly respect `deployment.target.hosts`. -- Wire will now attempt each target host in order until a valid one is found. +- wire will now ping the node before it proceeds executing. +- wire will now properly respect `deployment.target.hosts`. +- wire will now attempt each target host in order until a valid one is found. ### Changed -- Wire now directly evaluates your hive instead of shipping extra nix code along with its binary. +- wire now directly evaluates your hive instead of shipping extra nix code along with its binary. You must now use `outputs.makeHive { ... }` instead of a raw attribute. This can be obtained with npins or a flake input. - The expected flake output name has changed from `outputs.colmena` to `outputs.wire`. @@ -104,7 +104,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Dependency Updates. -- Wire now compiles and includes key agents for multiple architectures, currently only linux. +- wire now compiles and includes key agents for multiple architectures, currently only linux. - There is a new package output, `wire-small`, for testing purposes. It only compiles the key agent for the host that builds `wire-small`. - `--no-progress` now defaults to true if stdin does not refer to a tty (unix pipelines, in CI). diff --git a/doc/guides/apply.md b/doc/guides/apply.md index 1688471..522c079 100644 --- a/doc/guides/apply.md +++ b/doc/guides/apply.md @@ -70,7 +70,7 @@ like `keys` and `push`. ### `wire apply keys` -Wire will push all deployment keys to nodes, and do nothing else. While running +wire will push all deployment keys to nodes, and do nothing else. While running this goal, option [`deployment.keys..uploadAt`](/reference/module#deployment-keys-name-uploadat) has no effect and all keys will be pushed. Read [the secret management guide](./keys) @@ -78,7 +78,7 @@ to learn more about wire deployment keys. ### `wire apply push` -Wire will "push" (equivalent to [`nix +wire will "push" (equivalent to [`nix copy`](https://nix.dev/manual/nix/2.18/command-ref/new-cli/nix3-copy)) the `.drv` file that can produce the node's NixOS system when built. @@ -102,7 +102,7 @@ machine. Goals like `push` and `build`, wont actually "push" anything as the paths already exists on the local machine. When applying to your local machine, wire can interactively run `sudo`! -Wire will prompt for your password, meaning wire can be ran as any user in +wire will prompt for your password, meaning wire can be ran as any user in the `wheel` group. ## Applying specific nodes diff --git a/doc/guides/keys.md b/doc/guides/keys.md index e80d7e3..78bd8ce 100644 --- a/doc/guides/keys.md +++ b/doc/guides/keys.md @@ -1,7 +1,7 @@ --- comment: true title: Manage Secrets -description: Manage keys, secrets, files, and other out-of-store paths with Wire Tool. +description: Manage keys, secrets, files, and other out-of-store paths with wire Tool. --- # {{ $frontmatter.title }} @@ -10,7 +10,7 @@ description: Manage keys, secrets, files, and other out-of-store paths with Wire ## Introduction -Wire Tool is very unopinionated as to how you encrypt your secrets, Wire only +wire Tool is very unopinionated as to how you encrypt your secrets, wire only handles pushing and setting up permissions of your key files. The `source` of your key can be a literal string (unencrypted), a path @@ -122,21 +122,21 @@ in wire.makeHive { ## Persistence -Wire defaults `destDir` to `/run/keys`. `/run/` is held in memory and will not +wire defaults `destDir` to `/run/keys`. `/run/` is held in memory and will not persist past reboot. Change [`deployment.key..destDir`](/reference/module#deployment-keys-name-destdir) to something like `/etc/keys` if you need secrets every time the machine boots. ## Upload Order -By default Wire will upload keys before the system is activated. You can -force Wire to upload the key after the system is activated by setting +By default wire will upload keys before the system is activated. You can +force wire to upload the key after the system is activated by setting [`deployment.keys..uploadAt`](/reference/module#deployment-keys-name-uploadat) to `post-activation`. ## Permissions and Ownership -Wire secrets are owned by user & group `root` (`0600`). You can change these +wire secrets are owned by user & group `root` (`0600`). You can change these with the `user` and `group` option. ```nix:line-numbers [hive.nix] diff --git a/doc/guides/parallelism.md b/doc/guides/parallelism.md index e50ec91..30b5f1d 100644 --- a/doc/guides/parallelism.md +++ b/doc/guides/parallelism.md @@ -1,7 +1,7 @@ --- comment: true title: Use Parallelism -description: A deeper dive into parallelism with Wire Tool. +description: A deeper dive into parallelism with wire Tool. --- # {{ $frontmatter.title }} @@ -10,8 +10,8 @@ description: A deeper dive into parallelism with Wire Tool. ## Controlling CPU Usage -Wire evaluates, builds, pushes, and deploys each node completely independently -from each other. Internally Wire calls this process a "node execution". +wire evaluates, builds, pushes, and deploys each node completely independently +from each other. Internally wire calls this process a "node execution". The default number of parallel _node executions_ is `10`, which can be controlled with the `-p` / `--parallel` argument. diff --git a/doc/guides/targeting.md b/doc/guides/targeting.md index 452e633..46b76fe 100644 --- a/doc/guides/targeting.md +++ b/doc/guides/targeting.md @@ -1,7 +1,7 @@ --- comment: true title: Target Nodes -description: Tags, nodes, and how to target them with Wire Tool. +description: Tags, nodes, and how to target them with wire Tool. --- # {{ $frontmatter.title }} diff --git a/doc/reference/meta.md b/doc/reference/meta.md index 32b5b03..2622eea 100644 --- a/doc/reference/meta.md +++ b/doc/reference/meta.md @@ -1,7 +1,7 @@ --- comment: true title: Meta Options -description: Wire hive meta options. +description: wire hive meta options. --- # {{ $frontmatter.title }} @@ -40,7 +40,7 @@ Extra `specialArgs` to pass to each node & `default`. ::: tip -Wire always passes `name` (name of the node) +wire always passes `name` (name of the node) and `nodes` (attribute set of all nodes) as args, even if `meta.specialArgs = { }`. diff --git a/doc/tutorial/overview.md b/doc/tutorial/overview.md index 15208a2..1d9a6ec 100644 --- a/doc/tutorial/overview.md +++ b/doc/tutorial/overview.md @@ -1,22 +1,22 @@ --- comment: false -title: Wire Tutorial Overview -description: In this tutorial we will create and deploy a Wire Hive. +title: wire Tutorial Overview +description: In this tutorial we will create and deploy a wire Hive. --- # {{ $frontmatter.title }} -Wire is a tool to deploy NixOS systems. Its usage is inspired by [colmena](https://colmena.cli.rs/). In many places it's configuration attempts to remain a superset[^1] of colmena, however it is **not** a fork. +wire is a tool to deploy NixOS systems. Its usage is inspired by [colmena](https://colmena.cli.rs/). In many places it's configuration attempts to remain a superset[^1] of colmena, however it is **not** a fork. [^1]: A lot of your colmena module options will continue to work with wire, but wire has additional ergonomic changes you can take advantage of. ::: warning -Wire is alpha software, please use at your own risk. Many features listed in this documentation overall may not be complete / implemented, however features covered in this this tutorial are considered complete. +wire is alpha software, please use at your own risk. Many features listed in this documentation overall may not be complete / implemented, however features covered in this this tutorial are considered complete. ::: --- -In this tutorial we will create and deploy a Wire Hive. Along the way we will +In this tutorial we will create and deploy a wire Hive. Along the way we will encounter [npins](https://github.com/andir/npins), simple NixOS configurations, virutal machines, and deployment keys. @@ -26,11 +26,11 @@ Ready? Skip to [Nix Setup](./part-one/nix-setup). -## Why Wire? +## Why wire? ### Features -| Features | Wire | Colmena | +| Features | wire | Colmena | | ---------------------------------- | ------------------ | ------------------ | | Node Tagging | :white_check_mark: | :white_check_mark: | | Secret Management | :white_check_mark: | :white_check_mark: | @@ -53,11 +53,11 @@ Ready? Skip to [Nix Setup](./part-one/nix-setup). `wheel` or not. You may need to enter your password multiple times for the various elevated steps wire needs to perform. -[^5]: Wire lacks an equivalent to `colmena exec`. +[^5]: wire lacks an equivalent to `colmena exec`. ### Speed -Wire is about >2x faster than colmena deploying [identical large +wire is about >2x faster than colmena deploying [identical large hives](https://github.com/mrshmllow/wire/blob/main/bench/run.nix). | Command | Mean [s] | Min [s] | Max [s] | Relative | diff --git a/doc/tutorial/part-one/basic-hive.md b/doc/tutorial/part-one/basic-hive.md index 6d978ee..5e38273 100644 --- a/doc/tutorial/part-one/basic-hive.md +++ b/doc/tutorial/part-one/basic-hive.md @@ -11,7 +11,7 @@ description: Creating a basic hive and deploying changes to the virtual machine. ## Editing `hive.nix` Open a text editor and edit `hive.nix`. You should copy this example, which imports -the npins sources we added. It also calls `makeHive`, and gives Wire `nixpkgs` +the npins sources we added. It also calls `makeHive`, and gives wire `nixpkgs` from npins as well. ```nix:line-numbers [hive.nix] @@ -22,7 +22,7 @@ let wire = import sources.wire; in wire.makeHive { - # give Wire nixpkgs from npins + # give wire nixpkgs from npins meta.nixpkgs = import sources.nixpkgs { }; # we'll edit this part diff --git a/doc/tutorial/part-one/nix-setup.md b/doc/tutorial/part-one/nix-setup.md index 78ea3a2..27c5224 100644 --- a/doc/tutorial/part-one/nix-setup.md +++ b/doc/tutorial/part-one/nix-setup.md @@ -10,7 +10,7 @@ description: Installing npins, nix, and enabling the binary cache. ::: warning This page is for the purposes for the **Tutorial**. -You should read [How-to Guides - Install wire](/guides/installation.html) for installing Wire for +You should read [How-to Guides - Install wire](/guides/installation.html) for installing wire for regular use. ::: @@ -28,7 +28,7 @@ nix (Nix) 2.11.0 ## Using `cache.althaea.zone` -Because Wire can be heavy to compile, it is distributed with a [binary +Because wire can be heavy to compile, it is distributed with a [binary cache](https://wiki.nixos.org/wiki/Binary_Cache). It's URL is `https://cache.althaea.zone` and it's public key is `cache.althaea.zone:BelRpa863X9q3Y+AOnl5SM7QFzre3qb+5I7g2s/mqHI=`. diff --git a/doc/tutorial/part-one/repo-setup.md b/doc/tutorial/part-one/repo-setup.md index c9e1824..e980bac 100644 --- a/doc/tutorial/part-one/repo-setup.md +++ b/doc/tutorial/part-one/repo-setup.md @@ -43,7 +43,7 @@ fixes virutal machine bootloader disk sizes. ::: -This has created a pinned version of `nixpkgs` for us to use in our Wire hive. +This has created a pinned version of `nixpkgs` for us to use in our wire hive. ## Adding wire as a dependency diff --git a/doc/tutorial/part-two/basic-keys.md b/doc/tutorial/part-two/basic-keys.md index 9965a35..e8a1f1d 100644 --- a/doc/tutorial/part-two/basic-keys.md +++ b/doc/tutorial/part-two/basic-keys.md @@ -1,7 +1,7 @@ --- comment: true title: Deployment Keys Basics -description: Deploy some basic secrets with Wire tool. +description: Deploy some basic secrets with wire tool. --- # {{ $frontmatter.title }} diff --git a/doc/tutorial/part-two/encryption.md b/doc/tutorial/part-two/encryption.md index 446be16..baefcb8 100644 --- a/doc/tutorial/part-two/encryption.md +++ b/doc/tutorial/part-two/encryption.md @@ -1,7 +1,7 @@ --- comment: true title: Deployment Keys Basics -description: Deploy a age-encrypted secret with Wire tool. +description: Deploy a age-encrypted secret with wire tool. --- # {{ $frontmatter.title }} diff --git a/wire/lib/src/hive/steps/keys.rs b/wire/lib/src/hive/steps/keys.rs index ff78210..9748db0 100644 --- a/wire/lib/src/hive/steps/keys.rs +++ b/wire/lib/src/hive/steps/keys.rs @@ -312,7 +312,7 @@ impl ExecuteStep for PushKeyAgent { Some(agent) => agent.into_string().unwrap(), None => panic!( "{arg_name} environment variable not set! \n - Wire was not built with the ability to deploy keys to this platform. \n + wire was not built with the ability to deploy keys to this platform. \n Please create an issue: https://github.com/mrshmllow/wire/issues/new?template=bug_report.md" ), }; -- 2.51.2