Install the Grey Matter CLI
This guide will help you install and set up the Grey Matter CLI.
PreviousQuickstart Installation on AWS EKSNextAccess Sidecar Admin Interface in Grey Matter on Kubernetes
Last updated
Was this helpful?
1.2
This guide will help you install and set up the Grey Matter CLI.
Last updated
Was this helpful?
The Grey Matter Command Line Interface (CLI) is a configuration tool for Grey Matter. Leveraging the , the CLI mainly performs dynamic configuration of the Fabric mesh.
Q: How do the CLI and the Grey Matter Control API interact?
A: The CLI manipulates configuration objects registered with the control plane to control the behavior of the sidecars making up the mesh. Learn more about these if you haven't already.
To complete this tutorial, you’ll need an understanding of, and local access to the following environments and tools:
Unix Shell (or equivalent)
greymatter CLIThe greymatter CLI is a binary written in Go. There are two ways to install it:
download the binary manually from our release pages
We recommend using gmenv because it allows for easier versioning against different Grey Matter environments.
gmenvRun gmenv install 1.4.2 to install the latest version of the CLI. You should see:
Run gmenv use 1.4.2 to set this as your version.
greymatter binary manuallyAlternatively, any artifact in nexus can also be downloaded with a terminal. The below command demonstrates how to do this with curl. Before executing, replace -u user.name@organization.com with your username, and make sure the desired artifact is specified.
greymatter is distributed as a precompiled binary. Once you have downloaded the desired release, install it with the following steps:
Unpack the tarball
You will see the binaries:
Move the greymatter binary for your operator onto your system's PATH with name greymatter:
On a Mac?
On a Mac there is SIP mode which won't let you move the binary into your $PATH. Follow these instructions to disable rootless mode:
Reboot into recovery mode (reboot and hold down Cmd-R)
Open a terminal
Use this command: csrutil disable
Reboot and run the command that worked prior to El Capitan
When you're done, it is highly recommended that you re-enable SIP by following the same steps, but using csrutil enable in step 3.
Make sure to rename your binary for your operating system to just greymatter when moving the artifact into your $PATH
Run a quick test of the binary with the following command to verify a successful installation.
If you don't see this response, verify that the greymatter binary is on your PATH.
If you have an existing deployment running, configure the CLI by setting the following environment variables in your terminal. Note that as each deployment is different, the specific endpoint and security context will be different, so make sure to verify your settings against the deployed environment.
It is recommended to use an absolute path for your GREYMATTER_API_SSLCERT and GREYMATTER_API_SSLKEY variables.
Configuration options can also be set by CLI flags with each use. These flags will take precedence over the set environment variables.
This section requires a running instance of the Grey Matter Control API server. Your GREYMATTER_API_HOSTand many other configuration options will change based upon where the Control API service is deployed.
Use greymatter list zone with the following keys and certs to connect to the Grey Matter Control API.
The returned Zone indicates that the connection was successful, and you've been able to inspect the Fabric Mesh. You can now interact with your Grey Matter installation using the CLI!
If you see a connection refused error, your configuration is likely wrong. Check the values you have configured by running greymatter with no command, the options configured from the environment will be listed at the bottom of the output.
Need help with your installation?
A
use , a manager for installing and setting different greymatter versions
using homebrew or manually following the README
(the email and password used to access ). For ease of use, it is recommended to .
Retrieve the or visit Grey Matter's to browse all released versions of the CLI. When prompted, enter the username and password associated with your Grey Matter account.
Once the CLI has been downloaded and installed, it will need to be configured for your Grey Matter installation to communicate with the Grey Matter Control API. If you don't yet have an existing Grey Matter installation, get started with the , and you will be able to configure the Grey Matter CLI and complete once it is up.
NOTE: If you've used our - see the section for the specific configurations.
The full configuration and usage of the CLI can be found in the pages or by running greymatter --help, but some quick examples are shown here.
Create an account at to reach our team.
