Packages

host_kit

0.1.0-beta.5
0.1.0-beta.7 0.1.0-beta.6 0.1.0-beta.5 0.1.0-beta.4 0.1.0-beta.3 0.1.0-beta.2 0.1.0-beta.1 0.1.0-beta.0

Elixir-native host management with inspectable plans, package locks, systemd isolation, and remote bootstrap.

HexDocs

Current section

Files

Jump to
Readme
8 Versions
12 Dependencies
Dependants
Files
Activity
host_kit lib host_kit runtime.ex
Raw

lib/host_kit/runtime.ex 

defmodule HostKit.Runtime do

  @moduledoc "Runtime controls for systemd-backed units and transient jobs."



  @type unit_ref :: Unitctl.Instance.t() | String.t()



  @doc "Starts a transient systemd service through Unitctl."

  @spec start(Unitctl.Spec.t() | keyword() | map()) ::

          {:ok, Unitctl.Instance.t()} | {:error, term()}

  defdelegate start(spec_or_attrs), to: Unitctl



  @doc "Stops a systemd unit or Unitctl instance."

  @spec stop(unit_ref(), keyword()) :: :ok | {:ok, Systemd.Job.t()} | {:error, term()}

  defdelegate stop(instance_or_unit, opts \\ []), to: Unitctl



  @doc "Restarts a systemd unit or Unitctl instance."

  @spec restart(unit_ref(), keyword()) :: :ok | {:ok, Systemd.Job.t()} | {:error, term()}

  defdelegate restart(instance_or_unit, opts \\ []), to: Unitctl



  @doc "Reads common systemd state for a unit or Unitctl instance."

  @spec status(unit_ref(), keyword()) :: {:ok, Systemd.UnitState.t()} | {:error, term()}

  def status(instance_or_unit, opts \\ []), do: Unitctl.inspect(instance_or_unit, opts)



  @doc "Alias for `status/2` kept for Unitctl API compatibility."

  @spec inspect(unit_ref(), keyword()) :: {:ok, Systemd.UnitState.t()} | {:error, term()}

  def inspect(instance_or_unit, opts \\ []), do: status(instance_or_unit, opts)



  @doc "Reads runtime stats for a unit or Unitctl instance."

  @spec stats(unit_ref(), keyword()) :: {:ok, Unitctl.Stats.t()} | {:error, term()}

  defdelegate stats(instance_or_unit, opts \\ []), to: Unitctl

end