simp-cli

A cli interface to configure SIMP and simplify administrative tasks.

• Description
  • This is a SIMP project
• Usage
  • Commands
    • Configuration
      • bootstrap
      • config
    • Administration
      • doc
      • passgen
      • puppetfile
        • puppetfile generate
    • Recently removed
      • cleancerts — use puppet cert clean CERTNAME instead
      • runpuppet — use mcollective instead
      • puppeteval — use puppet agent --evaltrace instead
• Development
  • Contributing
  • Testing
• License

Description

A cli interface to configure SIMP and simplify administrative tasks.

This is a SIMP project

This project contains tests for the System Integrity Management Platform.

If you find any issues, submit them to our bug tracker.

Usage

simp COMMAND [OPTIONS]

NOTE: The simp cli command is intended to be run from a SIMP-managed OS.

Commands

Configuration

bootstrap

Bootstraps a SIMP system (requires configuration data generated by simp config).

NOTE: If you have an existing 'production' environment, it will be backed up and mapped to a 'simp' environment when bootstrap is run.

config

Creates SIMP configuration files with an interactive questionnaire.

Administration

doc

Displays SIMP documentation in elinks.

passgen

Controls user passwords.

puppetfile

Helper utility to maintain local SIMP Puppetfiles

puppetfile generate

Print a Puppetfile that deploys from local SIMP git repos

simp puppetfile generate > Puppetfile.simp

simp puppetfile generate --skeleton > Puppetfile

Recently removed

cleancerts — use puppet cert clean CERTNAME instead

Revokes and removes Puppet certificates from a list of hosts.

runpuppet — use mcollective instead

Runs puppet on a list of hosts.

puppeteval — use puppet agent --evaltrace instead

Gathers metrics information on Puppet runs.

Development

Contributing

Please read our Contribution Guide.

Testing

It is recommended to run our run spec tests by using Ruby 2.4.4 and bundler. To download dependencies, run:

bundle        # when starting from scratch
bundle update # if there are conflicts or out-of-date dependencies

To run the spec tests, run:

bundle exec rake spec

By default, the Gemfile prefers PUPPET_VERSION="~> 5.5". To specify another version of Puppet, run bundler with the preferred PUPPET_VERSION:

PUPPET_VERSION="~> 4.10" bundle

If spec tests are failing with mysterious tmpdir-related errors, like:

Directory not empty @ dir_s_rmdir - /home/user/tmp/logging_spec.rb20190314-23352-epe3

Re-run the tests with the TMPDIR variable set to another location:

TMPDIR=/tmp  bundle exec rake spec

See the .travis.yml file for examples of these environment variables at work.

License

See LICENSE