A Private Terraform Module and Terraform Provider registry.
Also, you can use to launch the registry server. The docker image is in GitHub Container Registry .
$ docker run -d -p "3000:3000" ghcr.io/outsideris/citizen:0.5.0
To launch the registry server
$ ./citizen server
It will be launched at http://localhost:3000. You can check it at http://localhost:3000/health.
Because Terraform CLI works with only HTTPS server, you should set up HTTPS in front of the registry server.
If you want to test it at local, you need a tool which provides HTTPS like ngrok.
Environment variables:
-
CITIZEN_DATABASE_TYPE
: Backend provider for registry metadata. Set tomongodb
orsqlite
. -
CITIZEN_DATABASE_URL
: The URL of the database.protocol//username:password@hosts:port/database?options
-
CITIZEN_STORAGE
: Storage type to store module files. You can usefile
ors3
type. -
CITIZEN_STORAGE_PATH
: A directory to save module files only ifCITIZEN_STORAGE
isfile
(absolute/relative path can be used). -
CITIZEN_AWS_S3_BUCKET
: A S3 bucket to save module files only ifCITIZEN_STORAGE
iss3
.(And AWS credentials required.)
To migrate the database, you can use citizen generate-migration
command.
The command will generate migration files which are schema.prisma
and migrations/
directory.
Because we use prisma to handle databases, you need to install prisma CLI.
Then, Set CITIZEN_DATABASE_TYPE
and CITIZEN_DATABASE_URL
envorinment variables
and Run prisma migrate deploy
for Sqlite.
For MongoDB, migration is not required.
Since official Terraform Module Registry is integrated with GitHub, users can publish terraform modules if they just push it on GitHub.
Citizen provides a special command to publish a module onto citizen registry server instead integrating GitHub.
In a module directory, you can publish your terraform module via a command below:
$ ./citizen module <namespace> <name> <provider> <version>
You should set CITIZEN_ADDR
as citizen registry server address which you will publish your modules to. e.g. https://registry.example.com
.
If you have ALB module in ./alb
directory, and your registry server is launched at https://registry.example.com
, you run below command in ./alb
directory to publish ALB module.
$ CITIZEN_ADDR=https://registry.example.com \
citizen module dev-team alb aws 0.1.0
Then, you can define it in your terraform file like this:
module "alb" { source = "registry.example.com/dev-team/alb/aws" version = "0.1.0" }
Citizen provides a special command to publish providers onto citizen.
-
-g, --gpg-key <gpgkey>
: GPG key to sign your SHA256SUMS.-
You need to publish your provider with your GPG public key to terraform registry. Otherwise, terraform will refuse to install providers. Terraform official resistry manage partners' public keys, but, each provider version has own public key and signature in citizen registry.
-
You must first build and package, citizen expects following files in the provider location:
-
<namespace>-<type>_<version>_<os>_<arch>.zip
(one per os/arch combination)
Where <namespace>
and <type>
is a name of the provider and <version>
is a provider
version in the MAJOR.MINOR.PATCH
version format.
Citizen will generate a SHA256SUMS file and a GPG signature file automatically for you: Following files will be generated in your directory during publising provider. So, You don’t need prepare theses files.
-
<namespace>-<type>_<version>_SHA256SUMS
-
<namespace>-<type>_<version>_SHA256SUMS.sig
Therefore, shasum
and gpg
commands should be available in your machine.
In a provider directory, you can publish your terraform provider via a command below:
$ ./citizen provider <namespace> <type> <version> [protocols]
[protocols]
is comma separated Terraform provider API versions, with MAJOR.MINOR
.
You should set CITIZEN_ADDR
as citizen registry server address which you will publish your modules to. e.g. https://registry.example.com
.
If you have ALB provider in ./utilities
directory, and your registry server is launched at https://registry.example.com
,
you run below command in ./utilities
directory to publish utilities provider.
$ CITIZEN_ADDR=https://registry.example.com \
citizen provider dev-team utilities 0.1.0 4.1,5.0
Then, you can define it in your terraform file like this:
provider "utilities" { } terraform { required_providers { utilities = { source = "registry.example.com/dev-team/utilities" version = "0.1.0" } } }
Node.js 16+ required
Set environment variables, see above.
$ ./bin/citizen server
$ ./bin/citizen module
$ ./bin/citizen provider
Set at least a storage path and the s3 bucket name variables for the tests to succeed. You need to be able to access the bucket, so you probably want to have an active aws or aws-vault profile.
Run mongodb as replica set first like:
$ docker-compose -f test/docker-compose-mongodb-cluster.yaml up
Run the tests:
$ npm test
Run the tests with the environment variables prefixed:
$ CITIZEN_STORAGE_PATH=storage CITIZEN_AWS_S3_BUCKET=terraform-registry-modules npm test