go-yoss

README

go-yoss

A command-line tool for yossing configuration into a remote configuration management store.
README · CHANGELOG . CONTRIBUTING
Report Bug · Request Feature

Table of contents

• About the project
  • Built with
• Getting started
  • Install
    • go install
    • Pre-compiled binaries
  • Verify your installation
  • Uninstall
• Usage
• Troubleshooting
• Roadmap
• Contributing
• License
• Contact

About the project

Managing configuration as code has significant benefits.

yoss offers a way to do just that:

• store configuration data as structured YAML documents
• perform convention-based merges and synchronize the diff with a remote configuration store

Built with

• Golang 1.16
• go-releaser

Getting started

Install

go install

With a working golang installation at version >= 1.16 you can install or update with:

go install github.com/davidalpert/go-yoss/cmd/yoss@latest

Pre-compiled binaries

Visit the Releases page to find binary packages pre-compiled for a variety of GOOS and GOARCH combinations:

1. Download an appropriate package for your GOOS and GOARCH;
2. Unzip it and put the binary in your path;

Verify your installation

1. Check the version installed:

   yoss version
   

Uninstall

• go-yoss ships with an uninstall sub-command which cleans up and removes itself:

  yoss uninstall
  

Usage

• TODO; coming as the project nears v1.0

Troubleshooting

If you run into trouble you can ask yoss to write some diagnostics to a log file by setting the following environment variables:

Variable	Default	Description
YOSS_LOG_LEVEL	"fatal"	"fatal", "error", "warning", "warn", "info", "debug"
YOSS_LOG_FORMAT	"text"	"text" or "json"
YOSS_LOG_FILE	""	path to a log file; when empty logs go to STDOUT

Roadmap

See open issues project board for a list of known issues and up-for-grabs tasks.

Contributing

See the CONTRIBUTING guide for local development setup and contribution guidelines.

License

Distributed under the GPU v3 License. See LICENSE for more information.

Contact

David Alpert - @davidalpert

Project Link: https://github.com/davidalpert/go-yoss