Helper tool for interacting with a saltstack repository that follows the roles and profiles structure.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Thaller 4636b61896 Merge branch 'release/0.14.0' 6 months ago
generate_docs Fixed writeln entries not passing up result. 6 months ago
saltstack_lints Bumped versions. 6 months ago
saltstack_repository Bumped versions. 6 months ago
src Added trimming of input string from editor so we dont get weird newlines in the results. 6 months ago
.gitignore Merge pull request #3 in SALT/serinus from feature/HIM-154-lint-explanation-pages to master 11 months ago
.rustfmt.toml Merge pull request #3 in SALT/saltstack_helper-rs from feature/HIM-74-create-lint-to-warn-about-undocumented-realms to master 1 year ago
Cargo.lock Bumped versions. 6 months ago
Cargo.toml Disabled lto. 6 months ago
LICENSE-MIT Added license. 1 year ago
README.md Updated structure. 11 months ago
TODO.md Updated todo. 10 months ago
build.rs Implemented proper versioning based on the git tag. 11 months ago

README.md

serinus

Helper tool for interacting with a saltstack repository that follows the roles and profiles structure outlined in https://salt.thaller.ws/Docs/Structure.html.

Named after the yellow bird serinus: https://en.wikipedia.org/wiki/Serinus.

Binaries can be found here: https://tools-salt.thaller.ws/serinus/.

Installation

You can find binaries in the releases tab.

Alternatively you can install serinus by building with rust (tested with rustc 1.27.2):

cargo install --path .

After that you should have a binary in $HOME/.cargo/bin.

Serinus is currently only tested on Linux and FreeBSD.

Usage

You can run serinus -h to get and overview of the options and subcommands serinus uses:

Alexander Thaller <alexander.thaller@trivago.com>
Helper tool for interacting with a saltstack repository that follows the v2
structure.

USAGE:
    serinus [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help
            Prints help information

    -V, --version
            Prints version information


OPTIONS:
    -L, --log_level <level>
            Loglevel to run under [env: SERINUS_LOG_LEVEL=]  [default: info]  [possible values: trace,
            debug, info, warn, error]
    -R, --repo_path <path>
            Path to the saltstack repository [env: SERINUS_REPO_PATH=]


SUBCOMMANDS:
    dependencies
            List dependencies between states or pillars in v2.

    docs
            Documentation generation releated commands

    help
            Prints this message or the help of the given subcommand(s)

    lints
            Run lints on the repository

    list
            List v2 stuff in the repository like roles, realms, etc.

    pillars
            Interact with the pillars

    template
            Use different templates to create new states.

To get started you probably want to configure the path to your saltstack repository. You can either run serinus with the -R (--repo_path) flag or you can set the environment variable SERINUS_REPO_PATH.

The path should point to the root directory of your repository under which the folders pillars and states are.