Skip to content

Latest commit

 

History

History
120 lines (94 loc) · 3.98 KB

README.md

File metadata and controls

120 lines (94 loc) · 3.98 KB
Raw

asdf-opentofu

An infrastructure as code tool that lets you define both cloud and on-prem resources in human-readable configuration files that you can version, reuse, and share.

github-main version version

tofu · asdf

This is an asdf-vm plugin generated from template.

Before start

If you still see this section, mean this plugin is not ready yet

There are several things template cannot generate for you, below are a list of thing we should do:

  1. make sure that your GitHub repository already exist at kc-workspace/asdf-opentofu
  2. please read plugins create section for more information
  3. remove before start section once you completed

Install

Plugin:

asdf plugin add "tofu" "https://github.com/kc-workspace/asdf-opentofu.git"

App:

# Show all installable versions
asdf list all tofu

# Install latest version
asdf install tofu latest

# Set a version globally
asdf global tofu latest
# Set a version locally
asdf local tofu latest

# Now tofu commands are available
tofu

Check the asdf readme for instructions on how to install & manage versions.

Features

Plugins generated from asdf-plugin-template repository will contains several extra features for every user including all below.

  • $DEBUG=<any-string> to enabled debug mode (debug logs will guarantee to show regardless of other settings)
  • $ASDF_FORCE_DOWNLOAD=<any-string> to always download even cache exist
  • $ASDF_INSECURE=<any-string> to disable security features (e.g. checksum)
  • $ASDF_NO_CHECK=<any-string> to disable pre-check features (e.g. check-cmd)
  • $ASDF_OVERRIDE_REF_REPO=<repository> to override git repository URL when install with ref mode
  • $ASDF_OVERRIDE_OS=<os> to override os name
  • $ASDF_OVERRIDE_ARCH=<arch> to override arch name
  • $ASDF_OVERRIDE_EXT=<ext> to override download extension
  • $GITHUB_TOKEN=<token> to pass GitHub token on http request
  • $ASDF_LOG_FORMAT=<format> to custom log format, there are several variables
    • {datetime} - for current datetime
    • {date} - for current date
    • {time} - for current time
    • {level} - for log level (always be 3 characters uppercase)
    • {namespace} - for formatted namespace (always have same length)
    • {ns} - for raw namespace (no formatting applied)
    • {message} - for log message
  • $ASDF_LOG_QUIET=<any-string> - to disable only info logs
  • $ASDF_LOG_SILENT=<any-string> - to disable all logs (including warning and error)

Addition Features

The plugins might contains additional features in addition to default features above. You can take a look at README.plugin.md

Contributors

Read CONTRIBUTING.md file for more detail.