Skip to content

README.md

Latest commit

 

History

History
52 lines (29 loc) · 2.55 KB

README.md

File metadata and controls

52 lines (29 loc) · 2.55 KB

flux-cli-formula

A SaltStack formula designed to install and configure the Flux CLI utility on installation-targets.

It is primarily expected that this formula will be run via P3's "watchmaker" framework.

This formula is able to install the Flux CLI on both Linux1 and Windows Server2 operating environments. Intallation for internet-connected systems may come from the Flux CLI project's "releases" page. If installing this way, the formula will install the latest-available version of the content. Alternately:

  • Sites whose installation-targets won't be able to reach the Flux CLI project's GitHub repository will need to self-host copies of the desired content.
  • Sites that wish to use a specific version of the Flux CLI will need to target that content

Targeting specific versions of the FluX CLI or local copies of the install-archives can be directed to do so by adding appropriate content to the formula's associated Pillar-data (see thish projct's pillar.example file for guidance).

Available states

flux-cli

Executes the package and config states to install and configure the Flux CLI

flux-cli.clean

Executes the package and config states' clean actions to fully uninstall the Flux CLI and remove previously-installed browser policy-configs (and, on Windows, associated registry entries)

flux-cli.package

Executes just the package state to install the Flux CLI package.

flux-cli.package.clean

Executes just the package.clean state to uninstall the Flux CLI package.

flux-cli.config

Executes just the config state to install/configure the Flux CLI client-configuration (etc.) files

flux-cli.config.clean

Executes just the config state to uninstall the Flux CLI client-configuration (etc.) files and, on Windows, remove any registry-keys set by prior install-runs of the formula.

Footnotes

  1. As of this README's writing, only Enterprise Linux and related distros (Red Hat and Oracle Enterprise, CentOS Stream, Rocky and Alma Linux). It has only been specifically tested with EL 9 variants. ↩

  2. As of this README's writing, this functionality has only been tested on Windows Server 2022 ↩