Skip to content

ok

The ok infrastructure toolbox.

Synopsis

The ok tool is a comprehensive infrastructure management toolbox designed to streamline the setup and maintenance of Terraform environments. It provides a variety of commands to bootstrap infrastructure, manage environment configurations, handle AWS operations, and more.

Key functionalities include:

  • Creating and configuring new Terraform environments.
  • Bootstrapping S3 buckets and DynamoDB tables for remote state storage.
  • Managing environment variables and configuration files.
  • Executing AWS-specific commands.
  • Scaffolding new Terraform projects with predefined Boilerplate templates.
  • Managing and updating Boilerplate templates.

Whether you're setting up a new environment or maintaining an existing one, ok simplifies and automates many of the repetitive tasks involved in infrastructure management.

Options

      --config string   config file (default is /home/runner/.config/ok/config.yml)
  -h, --help            help for ok

See also

  • ok aws - Group of AWS related commands.
  • ok bootstrap - Bootstrap code for an S3 bucket and DynamoDB table to store Terraform state.
  • ok completion - Generate the autocompletion script for the specified shell
  • ok env - Creates a new env.yml file with placeholder values.
  • ok envars - Exports the values in env.yml as environment variables.
  • ok forward - Starts a port forwarding session to a database.
  • ok get - Get a template.
  • ok pkg - Group of package related commands for managing Boilerplate packages.
  • ok scaffold - Creates a new Terraform project with a _config.tf, _variables.tf, _versions.tf, and _config.auto.tfvars.json file based on values configured in env.yml.
  • ok version - Prints the version of the ok tool and the current latest version available.