Getting started
terrakube cli is Terrakube on the command line. It brings organizations, workspaces and other Terrakube concepts to the terminal.
You can find installation instructions here Install
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
Run to authenticate with your account. But first you need to set some environment variables.
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
Create your Organization
Organizations are privately shared spaces for teams to collaborate on infrastructure.
You can check the organizations you have access using
If you don't have an organization created yet, you can create a new one.
The result for the above command should be something like this
For more commands and options in organization see the full documentation for
Working with Teams
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.
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 .
Create a Workspace
After having given permissions to our teams we can create a workspace.
And define some variables for the created 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.
After a few minutes the job will finish and you can check the result
Defining your Modules
Usually you will want to define your infrastructure templates as code using terraform and for this you can use the modules so others can reuse them.
Simplifying the commands
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.
Using shorthands
Using environment variables