Terraform provides a public registry, where you can share and reuse your terraform modules or providers, but sometimes you need to define a Terraform module that can be accessed only within your organization.
Manage Modules permission is required to perform this action, please check Team Management for more info.
Click Registry in the main menu and then click the Publish module button
Select an existing version control provider or click Connect to a different VCS to configure a new one. See VCS Providers for more details.
Provide the git repository URL and click the Continue button.
In the next screen, configure the required fields and click the Publish Module button.
The module will be published inside the specified organization. On the details page, you can view available versions, read documentation, and copy a usage example.
Releasing New Versions of a Module
To release a new version of a module, create a new release tag to its VCS repository. The registry automatically imports the new version.
Deleting Modules
In the Module details page click the Delete Module button and then click the Yes button to confirm
Using Private Modules
All users in an organization with Manage Modules permission can view the Terrakube private registry and use the available providers and modules.
Using private modules
Click Registry in the main menu. And then click the module you want to use.
In the module page, select the version in the dropdown list
You can copy the code reference from the module page
For example:
module "google-network" {
source = "8075-azbuilder-terrakube-gmnub6flawx.ws-us89b.gitpod.io/terrakube/google-network/google"
version = "v6.0.1"
# insert required variables here
}
Submodules
If your repository has submodules, Terrakube will scan the modules folder to identify all the submodules. Then, you will see a dropdown list with the submodules in the UI.
To view the readme file, inputs, outputs, resources and other information for any submodule, you can choose the submodule you want.
You can also copy the details of how to configure any submodule, just like the main module. Example:
module "iam" {
source = "8075-azbuilder-terrakube-7qovhyoq3u9.ws-eu105.gitpod.io/aws/iam/aws//modules/iam-account"
version = "v5.30.0"
# insert required variables here
}
In the submodule view you can switch to the differents submodules.
Or you can back to the main module with the Back button on the top of the page.
Configure Authentication
When running Terraform on the CLI, you must configure credentials in .terraformrc or terraform.rc to access the private modules.
For example:
credentials "8075-azbuilder-terrakube-gmnub6flawx.ws-us89b.gitpod.io" {
# valid user API token:
token = "xxxxxx.yyyyyy.zzzzzzzzzzzzz"
}
As an alternative you can run the terraform login command to obtain and save an user API token.
terraform login [terrakube hostname]
Using Providers
The following will explain how to add a provider to Terrakube.
The provider needs to be added using the API, currently there is no support to do it using the UI and if you want to upload a private provider you will need to upload the provider binary and related files to some domain that you can manage.
Lets add the random provider version 3.0.1 to terrakube, we can get the information that we need from the following endpoints:
GET https://registry.terraform.io/v1/providers/hashicorp/random/versions
GET https://registry.terraform.io/v1/providers/hashicorp/random/3.0.1/download/linux/amd64
You can change the URL from the above paramaters and use a URL that you control, I was using the terraform registry url for example purposes
Now in your terraform code you can have something like this:
terraform {
required_providers {
random = {
source = "terrakube-reg.minikube.net/simple/random"
version = "3.0.1"
}
}
}
And when running terraform init you will see something like:
user@pop-os:~/git/simple-terraform$ terraform init
Initializing the backend...
Initializing modules...
Initializing provider plugins...
- Finding terrakube-reg.minikube.net/simple/random versions matching "3.0.1"...
- Finding latest version of hashicorp/null...
- Finding latest version of hashicorp/time...
- Finding latest version of hashicorp/random...
- Installing hashicorp/null v3.2.2...
- Installed hashicorp/null v3.2.2 (signed by HashiCorp)
- Installing hashicorp/time v0.12.0...
- Installed hashicorp/time v0.12.0 (signed by HashiCorp)
- Installing hashicorp/random v3.6.2...
- Installed hashicorp/random v3.6.2 (signed by HashiCorp)
- Installing terrakube-reg.minikube.net/simple/random v3.0.1...
- Installed terrakube-reg.minikube.net/simple/random v3.0.1 (signed by HashiCorp)
Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.
Terraform has been successfully initialized!
You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.
If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.
