yle_tf-landscape

A plugin for YleTf adding a `planb` command that runs `terraform plan` with piping the output through Terraform Landscape for reformatting the output to be easier to read and understand


Keywords
yle-tf
License
MIT
Install
gem install yle_tf-landscape -v 1.1.0

Documentation

YleTf Plugin for Terraform Landscape

Gem Version Build Status

A plugin for YleTf adding a planb command that runs terraform plan with piping the output through Terraform Landscape for reformatting the output to be easier to read and understand.

Installation

If you are running tf standalone, install the plugin with:

gem install yle_tf-landscape

and configure it for YleTf by listing it in the TF_PLUGINS environment variable. For example in Posix shells:

export TF_PLUGINS='yle_tf-landscape'

If you install and use YleTf from your own software or wrappers, add this line to your application's Gemfile for automatic plugin loading:

group :tf_plugins do
  gem 'yle_tf-landscape'
end

You can also add it without group definition, and load it in the code:

require 'yle_tf-landscape'

Configuration

There is no configuration for the plugin.

When calling tf <env> planb with --no-color, also the Landscape output will be without colors.

Issues

Note that new Terraform versions might change the plan output format, breaking Terraform Landscape parsing. This can sometimes lead to errors, or broken or even totally missing output. In such cases you can try updating the Landscape gem to the latest version (bundle update or gem install terraform_landscape). You can also consult the open issues of both Terraform Landscape and this plugin.

Development

After checking out the repo, run bundle update to install and update the dependencies. Then, run bundle exec rake spec to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Yleisradio/yle_tf-landscape. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.