terrakube cli is Terrakube on the command line. It brings organizations, workspaces and other Terrakube concepts to the terminal.
Installation
You can find installation instructions here
Getting help
When you are working with terrakube cli probably you will need some help with the supported commands and flags and you can use for that, however a better option is to use the same cli to get help using --help flag or -h shortand. The embedded help provides you more detail for each command and some examples you can use as reference
# using help flag
terrakube --help
# using shorthand
terrakube -h
# getting help for an specific command
terrakube organization -h
# getting help for an specific sub command
terrakube organization create -h
Once you create your organization you will probably want to define the teams and permissions for the organization, so you can use the team command for that.
terrakube team create --organization-id 8a6e9998-165c-49f0-953c-d3fb0924731a --name AZB_USER --manage-workspace=true --manage-module=true --manage-provider=true
Create a Workspace
After having given permissions to our teams we can create a workspace.
If you want to avoid entering the organization or the workspace in each command you can use environment variables, so the previous commands would be simplified as follows.
Now that you have a workspace with all the variables defined, you can execute a job, basically a job is a remote terraform apply, plan or destroy. So if you want to run apply we can execute the following command.
In order to simplify the commands when you are working with the cli, you can use shortands and alias and some environment variables. See the following sections for more details.
Use the --help flag to get the details about available shorthands and alias for each command
Using shorthands
# without shorthand
terrakube organization create --name MyOrganization --description "Getting started Organization"
# using shorthand
terrakube organization create -n MyOrganization -d "Getting started Organization"
Using alias
# without alias
terrakube organization create --name MyOrganization --description "Getting started Organization"
# using alias and shorthand
terrakube org create -n MyOrganization -d "Getting started Organization"
Run to authenticate with your account. But first you need to set some environment variables.
You can also pass this values using however is recommended to use environment variables in the case you need to authenticate several times or if you are running an automatic script.
Open your terminal and execute the following commands in order to setup your terrakube environment and get authenticated. You can get the server, path, scheme, tenant id and client id values during the
You can check the organizations you have access using
For more commands and options in organization see the full documentation for
In the previous command we are creating a new team inside our new Organization and for this case we are providing permissions to manage workspaces, modules and providers. In the name flag we are using an Azure AD Group, so all the team members are defined inside the AD group. For more details about teams and permissions you can see .
