citizen

citizen copied to clipboard

= Citizen

image:https://github.com/outsideris/citizen/workflows/Unit%20tests/badge.svg["Unit Test Status", link="https://github.com/outsideris/citizen/actions?query=workflow%3A%22Unit+tests%22+branch%3Amain"] image:https://github.com/outsideris/citizen/workflows/Integration%20Tests/badge.svg["Integration Test Status", link="https://github.com/outsideris/citizen/actions?query=workflow%3A%22Integration+Tests%22+branch%3Amain"] image:https://app.fossa.io/api/projects/git%2Bgithub.com%2Foutsideris%2Fcitizen.svg?type=shield["FOSSA Status", link="https://app.fossa.io/projects/git%2Bgithub.com%2Foutsideris%2Fcitizen?ref=badge_shield"]

A Private link:https://registry.terraform.io/[Terraform Module] and link:https://www.terraform.io/docs/internals/provider-registry-protocol.html[Terraform Provider] registry.

== Requirements

• HTTPS - Terraform module registry only support HTTPS.

== Download link:https://github.com/outsideris/citizen/releases/latest[Download the latest release!]

Also, you can use to launch the registry server. The docker image is in link:https://github.com/users/outsideris/packages/container/package/citizen[GitHub Container Registry ].

[source, sh] .... $ docker run -d -p "3000:3000" ghcr.io/outsideris/citizen:0.5.0 ....

== Server Usage

=== citizen server

To launch the registry server [source, sh] .... $ ./citizen server ....

It will be launched at link:http://localhost:3000[http://localhost:3000]. You can check it at link:http://localhost:3000/health[http://localhost:3000/health].

Because link:https://www.terraform.io/[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 link:https://ngrok.com/[ngrok].

Environment variables:

• CITIZEN_DATABASE_TYPE: Backend provider for registry metadata. Set to mongodb or sqlite.
• 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 use file or s3 type.
• CITIZEN_STORAGE_PATH: A directory to save module files only if CITIZEN_STORAGE is file (absolute/relative path can be used).
• CITIZEN_AWS_S3_BUCKET: A S3 bucket to save module files only if CITIZEN_STORAGE is s3.(And AWS credentials required.)

=== Database migration 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 link:https://www.prisma.io/[prisma] to handle databases, you need to link:https://www.prisma.io/docs/concepts/components/prisma-cli/installation[install prisma CLI].

Then, Set CITIZEN_DATABASE_TYPE and CITIZEN_DATABASE_URL envorinment variables and Run link:https://www.prisma.io/docs/reference/api-reference/command-reference#migrate-deploy[prisma migrate deploy] for Sqlite. For MongoDB, migration is not required.

== Client Usage

=== citizen module <namespace> <name> <provider> <version>

Since link:https://registry.terraform.io/[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: [source, sh] .... $ ./citizen module ....

You should set CITIZEN_ADDR as citizen registry server address which you will publish your modules to. e.g. https://registry.example.com.

=== Examples 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. [source, sh] .... $ 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 provider <namespace> <type> <version> [protocols]

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 link:https://www.terraform.io/docs/registry/providers/publishing.html[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: [source, sh] .... $ ./citizen provider [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.

=== Examples 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. [source, sh] .... $ 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" } } } ....

== Development Node.js 16+ required

Set environment variables, see above.

[source, sh] .... $ ./bin/citizen server $ ./bin/citizen module $ ./bin/citizen provider ....

=== Test 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: [source, sh] .... $ docker-compose -f test/docker-compose-mongodb-cluster.yaml up ....

Run the tests: [source, sh] .... $ npm test ....

Run the tests with the environment variables prefixed: [source, sh] .... $ CITIZEN_STORAGE_PATH=storage CITIZEN_AWS_S3_BUCKET=terraform-registry-modules npm test ....

=== Build distributions

[source, sh] .... $ npm run client $ npm run build ....

It will generate prisma clients for databases.

Under dist/, citizen binaries for linux, darwin(amd64/arm64) and windows made.

== License image:https://app.fossa.io/api/projects/git%2Bgithub.com%2Foutsideris%2Fcitizen.svg?type=large["FOSSA Status", link="https://app.fossa.io/projects/git%2Bgithub.com%2Foutsideris%2Fcitizen?ref=badge_large"]