odysseus-cli 0.3.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286c6f613a97b1f0fe05e0fbe7c32134743f548a54963a3f118d8291ccebc792
-  data.tar.gz: 3d31e2e4a8d0a6bd64eb20d549d96b49a00885474a7c9fbd4467e9394bd254a0
+  metadata.gz: d6f094534fea6a7dcc58621417fbc7ec17a7b257c1159a4488df042c9dc1a4bf
+  data.tar.gz: ca7c48f159f842e1150722cd9bc053f29c961e476fe47de4940f2d3600bcd56e
 SHA512:
-  metadata.gz: 1a9f282b7f6c4380c28011bba65ed280ae791bbd27317aaf063e237a41d3a69ccd8de64dd24969f1664636b841897965070d2230a1949ce906b0b42cc98eed81
-  data.tar.gz: 33dfa6160b2db4ff12b1a31c6da6abaf22a8852d59b002cd82c029a231a00306e9df1cbeeb4727c615519dc97fa9ec3d62b3bab6a6732c52f9d71e9c405e1607
+  metadata.gz: fffb23ba2fdf6b183fb97e624e23cb34ea8f77b779bc373cff879b35ec082fb9687260cb228dddf038763e3fedbe749dc0efed6411924ade560da3f996bfda43
+  data.tar.gz: 2d1d6281e4fb164204a15b64013a025a14cce60f181042651545e8b15c70a929ce990dca3a50bba27fe6a5f41583b875bcbbc5c86d4aefa50f167fff163e739e

data/CHANGELOG.md

@@ -0,0 +1,334 @@
+# Changelog
+
+All notable changes to odysseus-cli are documented here.
+
+Entries for 0.3.0 and earlier were reconstructed from git history and the built
+gem artifacts, so they are summaries rather than contemporaneous notes.
+
+## [Unreleased]
+
+## [0.10.0] - 2026-08-28
+
+### Changed
+
+- `cleanup`'s documentation now describes what the command does. It was
+  "Clean up old containers and optionally prune images" in both the README and
+  `--help`; it stops and force-removes every container for the service on that
+  server -- every role and every dependency, databases included, not only old
+  ones and not sparing the container serving traffic -- then removes the
+  service's Caddy routes and, if no other service is left behind the proxy,
+  removes the shared `odysseus-caddy` container too. No behaviour changed. The
+  name still undersells it; see TODO.md.
+
+## [0.9.0] - 2026-08-19
+
+### Fixed
+
+- `setup` names the `--as` flag when the bootstrap identity cannot
+  authenticate. The default identity is a guess — right on a stock Ubuntu
+  cloud image, wrong on anything else — and the failure was a bare "SSH
+  authentication failed", with nothing to suggest a flag existed that would
+  fix it. A host that is merely unreachable still gets no `--as` advice.
+- `--debug` (and `ODYSSEUS_DEBUG=1`) reaches the SSH layer, not only the UI.
+  It was read and passed to the UI, but the connection builders never passed
+  `verbose:` to `SSH.new`, so the flag whose purpose is showing what was sent
+  to the host showed nothing for `setup`, `doctor`, `status`, `containers` or
+  `logs`. `setup` accepts `-v` as well.
+
+### Added
+- `odysseus setup`, which prepares every host in the config so odysseus can
+  deploy to it as a non-root user: creates the user `ssh.user` names, adds
+  it to the `docker` group, installs your public key, installs Docker
+  itself if the host doesn't have it, and creates its state directory.
+  Connects as `--as USER`, default `ubuntu` — the user Ubuntu's LTS cloud
+  images ship with passwordless sudo already configured; `--as root` needs
+  no sudo. It reads no new configuration keys: the user, keys and hosts all
+  come from the existing `ssh.user`, `ssh.keys` and `servers.*.hosts`, with
+  `--key PATH` (repeatable) to override the key source. `setup` no longer
+  refuses a host without Docker — if `docker info` doesn't answer, it
+  installs Docker from Docker's own apt repository and checks again, and
+  only fails the step if the daemon still doesn't answer afterward — and it
+  still refuses anything other than Ubuntu 24.04 or 26.04 by name. It
+  reports what it changed separately from what was already correct, and
+  finishes by reconnecting as the new user to prove the host actually works
+  before reporting success.
+
+## [0.8.0] - 2026-08-17
+
+### Changed
+- Requires odysseus-core `~> 0.8.0`. The dependency was `~> 0.7.0`, which
+  excludes 0.8.0 outright, so this is not a tightening: without it the two gems
+  cannot resolve together. `odysseus doctor` also calls
+  `Odysseus::HostVerifier` and `Executor#host_roles`, neither available in
+  0.7.0.
+
+### Added
+- `odysseus doctor`, a read-only diagnosis of every host in the config,
+  connecting as the user `ssh.user` names rather than root. It reports
+  distro, docker reachability, docker group membership, state-directory
+  writability and deploy-log location for each host, via
+  `Odysseus::HostVerifier` (odysseus-core). An unsupported distro is a
+  warning rather than a failure; only a failing check sets a non-zero exit.
+  A host whose check raises — a dropped connection, say — is reported and
+  the survey continues to the rest. `doctor` changes nothing on the host.
+
+## [0.7.0] - 2026-08-16
+
+Read the exit-code changes below before upgrading anything that scripts these
+commands. `logs` now exits non-zero when it finds no container, where it used to
+report the problem and exit 0, and `app shell`/`console` exit with the remote
+command's status instead of always 0. A cron or CI job that treated either as
+"succeeded" will start noticing failures — which is the point, but it is a
+change in what those jobs see.
+
+### Changed
+- Requires odysseus-core `~> 0.7.0`. The dependency was `~> 0.6.0`, which
+  excludes 0.7.0 outright, so this is not a tightening: without it the two gems
+  cannot resolve together. These commands also call `Core::Environment` and
+  `Docker::Client#with_env_file`, neither of which exists in 0.6.0.
+- `bin/odysseus`'s dispatch table no longer lists `dependency`, `app` and
+  `secrets`. Their entries named methods the CLI has never had
+  (`dependency_dispatch`, `app_dispatch`, `secrets_dispatch`); the subcommand
+  guards intercept those verbs first, so nothing changes today, but the entries
+  would have turned any reordering of a guard into a `NoMethodError` backtrace.
+  The suite now runs every verb the help lists.
+
+### Fixed
+- `odysseus app exec|shell|console` now inject `env.secret` as well as
+  `env.clear`. They injected the clear values alone, so the README's own
+  example — `odysseus app exec web1 --command "rails db:migrate"` — started a
+  container with no `DATABASE_URL` while the container deployed seconds earlier
+  had one. Both orchestrators had always injected both; these three never did.
+  The environment is now built by the same `Core::Environment` the deploy paths
+  use, so a secret resolves from the encrypted file when one is configured and
+  from the host's own environment otherwise, exactly as a deploy resolves it.
+- A relative `secrets_file` is resolved against the directory holding the
+  `deploy.yml` these commands were pointed at, not the working directory, which
+  is the rule deploys already followed.
+- `odysseus app shell|console` pass the environment to docker with `--env-file`
+  instead of `-e KEY=VALUE`. The values were in the command string these
+  commands run over ssh, so `ps` on the deploy target showed them to every user
+  on the box; now only the file's path is. The file is `0600`, is held open for
+  the whole session and is removed when the session ends, however it ends —
+  including when the ssh connection it was written over has died while the
+  session sat idle, which is removed over a fresh connection. Two cases still
+  leave it on the host: the `odysseus` process being killed outright
+  (`SIGKILL`, or the machine going down), where no cleanup can run at all, and
+  a host that is unreachable when the session ends, where the removal has
+  nowhere to go. The file is `0600` in `/var/lib/odysseus/env`, which is `0700`,
+  so no other user on the box can read it, but nothing comes back for it.
+  `app exec` reaches the same place through `run_once`, which writes an env
+  file of its own — see odysseus-core's changelog.
+- `odysseus dependency exec|shell` are unchanged: they `docker exec` into an
+  already-running dependency, which carries the environment it was booted with.
+- `odysseus app exec|shell|console` now take `--role` (default `web`) and look
+  the container up by the label that role actually carries. They asked for the
+  bare service name, which only the web role wears: on a jobs host they
+  reported `No running container for myapp` while `myapp-jobs` containers were
+  running, and for a service with no web role at all they could not work on any
+  host, with no workaround. The `app` parser had no `--role` either, so naming
+  one raised an `OptionParser::InvalidOption` backtrace.
+- The not-found message from those commands now names the role, the
+  `odysseus.service` label it searched for and the `--role` option, and lists
+  the roles in the config. It does not search other roles: running your command
+  against a role you did not name would be worse than being told what to type.
+- `odysseus logs` gives that same message. A mistyped `--role` — `odysseus logs
+  w1 --role jbos` — got `No containers found for myapp-jbos on w1 (stopped ones
+  included)`, naming a label the reader never typed and no way to find the one
+  they wanted. Both commands now share the message rather than keeping two that
+  can drift. `odysseus dependency logs` gets the label it searched for too, but
+  not the `--role` advice: a dependency is chosen with `--name`.
+- `odysseus logs` and `odysseus dependency logs` read stopped containers as
+  well as running ones. They asked `docker ps` without `-a`, so the container
+  that had just exited — the one you want the logs of — was invisible, and they
+  reported `No running containers found` and exited **0** while `docker logs`
+  on that container would have worked. Deploys keep the previous two
+  containers, so this was routine rather than an edge case.
+- Those two commands now exit non-zero when there is no container at all: a
+  request for logs that produced none is a failed request, not a success. When
+  the only match is stopped they say so, and name the container, rather than
+  streaming a dead container's logs and leaving you to wonder why it ends.
+- Both of those messages go to **stderr**. `odysseus logs web1 > app.log` is
+  the command most likely to be redirected or piped into something that parses
+  what it gets, and a line about the logs does not belong inside them. The
+  notice still reaches the terminal of whoever ran the command. Every other
+  command writes where it always did.
+- `odysseus app shell|console` and `odysseus dependency shell` now exit
+  non-zero when the session fails. They discarded `system`'s return value, so a
+  refused ssh, a missing image or a failed `docker run` all reported success.
+- The same three quote what they put in the command they run. Values were
+  interpolated raw into a string that passes through two shells, so ordinary
+  `env.clear` values broke them: a value containing a space made docker read
+  the wrong token as the image name, and an apostrophe (`SMTP_FROM: "Bob's
+  App"`) unbalanced the quoting — an odd number left `sh: unexpected EOF` and
+  nothing running (reported as success, per the bug above), an even number
+  rebalanced the quotes and ran the text between them through the *local*
+  shell. An SSH key path containing a space failed the same way.
+- `odysseus app console --cmd` is split into words the way a shell would, so
+  `--cmd "rails c"` still reaches docker as two arguments, and a `--cmd` whose
+  own quoting cannot be read is reported instead of being passed on.
+- `odysseus app shell|console` print a header before handing the terminal over.
+  They printed nothing at all: `odysseus app shell dedalus-prod` answered with
+  `/app $` and no way to tell which host you had reached, which role, or which
+  build you were looking at. `app exec` has had a header from the start. The
+  new one names the server, the role, the image that is serving and the command
+  the container runs, in the same shape as `app exec`'s.
+- It also says the thing a prompt inside a container invites you to assume the
+  other way round: this is a **new container** started from the serving image,
+  not an attach to the container taking traffic. Nothing done in it reaches the
+  running app and all of it goes when the session ends. `odysseus dependency
+  shell` is deliberately not given the same line — it `docker exec`s into the
+  running dependency, where the opposite is true.
+- That header goes to **stderr**. `odysseus app console web1 --cmd "rails
+  runner 'puts Thing.count'" > count` is a reasonable way to read a value out
+  of a deployment, and a header inside that file would be a bug: stdout carries
+  what the session itself produced and nothing else. `app exec`'s header is
+  unchanged, on stdout, where the output of its `run_once` already is.
+
+## [0.6.0] - 2026-08-15
+
+### Changed
+- `odysseus validate` now loads `plugins:`/`sails:` before checking the rest
+  of the config, so it catches a plugin gem that is not installed instead of
+  only discovering the gap at deploy time. It will fail on a machine that
+  does not have the gem, where it passed before. See odysseus-core's
+  changelog for the loading mechanism itself.
+- Requires odysseus-core `~> 0.6.0`. The dependency was `~> 0.5.0`, which
+  excludes 0.6.0 outright, so the two gems could not resolve together at all.
+- The README documents dynamic ASG hosts again, now that `plugins:` makes them
+  reachable. The example it previously carried could not have parsed: it showed
+  an `aws:` role with no `hosts:` key, which every role requires.
+
+## [0.5.0] - 2026-08-13
+
+### Changed
+- Requires odysseus-core `~> 0.5.0`. The previous `~> 0.4.4` constraint
+  excludes 0.5.0 outright, so this is not a tightening but a necessary move:
+  without it the two gems cannot resolve together at all.
+- `odysseus deploy` now prunes old images on each host, keeping the newest
+  `retain_versions` (default 5). See odysseus-core's changelog for what is
+  protected from removal.
+
+## [0.4.4] - 2026-08-13
+
+### Changed
+- Requires odysseus-core `~> 0.4.4`. The dependency was `~> 0.4.3`, which
+  allowed installing a core whose `Executor` still named its six methods
+  `deploy_accessory`, `boot_accessories` and so on — all of which the dependency
+  commands call under their new names, so they would have failed with a
+  NoMethodError rather than a resolvable error.
+- `odysseus accessory` is now `odysseus dependency`, with `dep` accepted as
+  shorthand. The old verb still works and prints a notice naming the
+  replacement, because a silent alias never gets migrated away from; it will be
+  removed in a later release. The `accessories:` key in deploy.yml is likewise
+  now `dependencies:`, with the old key still accepted — see odysseus-core's
+  changelog for why nothing on a host changes when you rename it.
+- Help text, subcommand output and the `Dependency name required` error read
+  "dependency" throughout.
+
+## [0.4.3] - 2026-08-13
+
+### Added
+- `odysseus rollback [VERSION]`, returning every role on every host to a
+  previously deployed version. With no VERSION, the target is the most recent
+  version in the hosts' deploy logs that is not already serving and whose image
+  is still present everywhere. Refuses, changing nothing, when any host lacks
+  the image.
+- `odysseus rollback --list`, showing per host: every version deployed, when,
+  by whom, from which commit, whether the image is still present, and what is
+  serving. Reads only the hosts, so it works without a git repository.
+
+### Changed
+- Requires odysseus-core `~> 0.4.3`. The dependency was `~> 0.4.2`, which
+  allowed installing a core without `Executor#rollback_plan`, `#rollback_all`
+  or `#version_survey` — all of which `rollback` calls, so the command would
+  have failed with a NoMethodError rather than a resolvable error.
+
+### Fixed
+- `odysseus accessory status` now works. It has raised `NoMethodError` since
+  before the subcommand shipped in 0.2.0; see odysseus-core's changelog for the
+  root cause and fix.
+
+### Internal
+- Rollback commands moved out of the main `CLI` class into
+  `Odysseus::CLI::RollbackCommands`, to keep the class under its existing size
+  limit without changing its public API.
+
+## [0.4.2] - 2026-08-13
+
+### Changed
+- `deploy`, `build` and `pussh` no longer default `--image` to the `latest`
+  tag; the tag now defaults to the git commit being deployed, and is required
+  outside a clean git repository.
+- `status` reports the version, ref and deploy time of each container.
+- `app exec`, `app shell` and `app console` run the version that is currently
+  serving instead of `:latest`.
+- Requires odysseus-core `~> 0.4.2`. The dependency was `~> 0.4`, which allowed
+  installing a core without `Executor#deploy_version` or `Docker::Labels` — both
+  of which these commands now call, so `deploy` would have failed with a
+  NoMethodError rather than a resolvable error.
+
+## [0.4.1] - 2026-08-12
+
+Released in lockstep with odysseus-core 0.4.1, which fixes the Caddy TLS
+policy update. No changes to the CLI itself.
+
+## [0.4.0] - 2026-08-12
+
+### Added
+- `odysseus version` and `--version`, reporting the CLI, odysseus-core and ruby
+  versions. Answered before any config is loaded, so it works without a
+  deploy.yml or a reachable server.
+- `Odysseus::CLI::VERSION`, so the gem version has one source of truth instead
+  of being hardcoded in the gemspec.
+- A test suite: RSpec, `.rspec` and a `rake` default task. Argument dispatch and
+  exit codes are covered by running the real executable in a subprocess, the
+  commands are unit-tested against a doubled executor, and the redaction of
+  secrets from streamed output is pinned.
+- RuboCop, sharing odysseus-core's configuration.
+
+### Changed
+- Requires odysseus-core `~> 0.4`. The dependency was `~> 0.2`, which allowed
+  installing a core old enough to lack the deploy fixes the CLI relies on.
+- Requires Ruby >= 3.2.0, matching odysseus-core. The gemspec asked for >= 3.0,
+  which could not have worked.
+- Licensed under MIT. The gemspec previously said LGPL-3.0-only while the README
+  said MIT.
+- `CLEAN_MESSAGES` is a `private_constant`; it sat after a `private` modifier,
+  which does nothing for constants.
+- Development dependencies live in the Gemfile only, as in odysseus-core; the
+  gemspec declared rspec and pry-byebug a second time.
+
+### Fixed
+- The gem now ships its license file. `spec.files` looked for `LICENSE` while
+  the file is `LICENSE.txt`, so published gems contained no license text.
+
+### Removed
+- The `ratatui_ruby` dependency. Nothing in the CLI required or referenced it —
+  it pulled a native extension into every install for nothing.
+- Documentation for Charm mode (`--charm`, `ODYSSEUS_CHARM=1`, `gum`), removed
+  from the code in 0.3.0 but left in the README, and for AWS Auto Scaling Group
+  hosts, which moved to a sail gem nothing currently loads.
+
+## [0.3.0] - 2026-04-04
+
+### Changed
+- Rewrote terminal output as numbered steps with animated spinners resolving to
+  ✓/✗, rendered by `CLI::UI`, replacing the gum-backed Charm mode. `--debug`
+  (or `ODYSSEUS_DEBUG=1`) switches to verbose plain text.
+- Secret values are redacted from streamed output via `RedactingIO`.
+
+## [0.2.0] - 2025-12-30
+
+### Added
+- Charm TUI mode (`--charm`, `ODYSSEUS_CHARM=1`) built on gum, for styled
+  headers, spinners, tables and confirmations. Superseded in 0.3.0.
+- `secrets` subcommands: generate-key, encrypt, decrypt, edit.
+- `accessory` subcommands: boot, boot-all, remove, restart, upgrade, status,
+  logs, exec, shell.
+- `pussh` command for pushing images to hosts over SSH without a registry.
+
+## [0.1.0] - 2025-12-21
+
+- Initial release: deploy, build, status, containers, logs, cleanup, validate,
+  and the `app` subcommands.

data/LICENSE.txt

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) Imfiny SAS / Wa Systems SAS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Odysseus Pro and Odysseus Enterprise are distributed under separate
+commercial terms.