Skip to content

Latest commit

 

History

History
130 lines (97 loc) · 4.14 KB

README.md

File metadata and controls

130 lines (97 loc) · 4.14 KB

Consul IO CLI

Consul IO is a CLI tool used to import and export configuration files from a specified directory to/from the Consul KV store.

Installation

You can install the latest version using the go install command:

go install github.com/turknet/consul-io@latest

Check Version

consul-io version

Usage

You can run the CLI tool using the following command:

consul-io help

Available Commands

  • import [directory] : Upload config files to Consul KV store
  • export [directory] : Download config files from Consul KV store
  • vault-search [search-term] : Search for a term in Vault KV store
  • version : Print the version number of Consul IO
  • help : Display help for consul-io

Command Line Arguments

  • --consul-addr : Specifies the address of the Consul server. The default value is http://localhost:8500.
  • --ignore : Specifies one or more paths to ignore during the import process. This option is useful if you want to skip certain directories or files.
  • --token : Optional ACL token for Consul authentication. If provided, all operations will be authenticated using this token.
  • --vault-addr : Vault server address (e.g. http://vault:8200)
  • --auth-type : Authentication type for Vault (ldap)
  • --username : Username for Vault authentication
  • --password : Password for Vault authentication
  • --path : Optional specific path to search in Vault
  • [directory] : The directory containing the configuration files you want to upload or the directory to which you want to export files.

Example Usage

Import

consul-io --consul-addr=http://localhost:8500 --token=my-secret-token import test --ignore="test/team1/apps/project2"

This command finds the files with the .production extension in the test directory and uploads them to the Consul KV store.

Vault Search

# Search in all KV paths
consul-io vault-search "search-term" \
  --vault-addr="http://vault:8200" \
  --auth-type="ldap" \
  --username="your-username" \
  --password="your-password"

# Search in a specific path
consul-io vault-search "search-term" \
  --vault-addr="http://vault:8200" \
  --auth-type="ldap" \
  --username="your-username" \
  --password="your-password" \
  --path="secret/specific/path"

This command searches for the specified term in Vault KV store and displays matching values with colored output:

  • Path is shown in green
  • Keys are shown in yellow
  • Values are shown in red

Export

consul-io --consul-addr=http://localhost:8500 --token=my-secret-token export test

This command downloads the configuration files from the Consul KV store and saves them in the test directory, maintaining the same structure.

Colorful Console Output

Consul IO provides colorful console output to improve readability:

  • Errors are displayed in red.
  • Warnings are displayed in yellow.
  • Success messages are displayed in green.
  • Informational messages are displayed in cyan.

Example Directory Structure

consul-io/
├── cmd/
│   └── root.go
├── test/
│   ├── team1/apps/
│   │   ├── project1/
│   │   │   └── .env.production
│   │   ├── project2/
│   │   │   └── appsettings.json.production
│   ├── team2/apps/
│   │   ├── project1/
│   │   │   └── .env.production
│   │   │   └── appsettings.json.production
├── go.mod
├── go.sum
└── main.go

  • cmd/ : Contains the CLI command files.

  • go.mod : Contains Go module information.

  • go.sum : Contains the verification information for the Go modules.

  • main.go : The entry point of the program.

  • test/ : Example directory containing the configuration files you want to upload or the directory where you want to export files.

Dependencies