Skip to content

Commit

Permalink
doc: update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
katallaxie committed Jul 16, 2024
1 parent 78c6701 commit 5b0619b
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,49 @@

Knox is a simple and secure Terraform backend.

## Features

- **Simple**: Knox is a simple and secure Terraform backend.
- **Secure**: Knox uses a secure and encrypted storage backend.
- **Fast**: Knox is fast and lightweight.
- **Versioned**: Knox supports versioning of the Terraform state.

Knox has a team-based management of the Terraform state. It is designed to be used in a multi-team environment where each team has its own workspace.

## Terraform

To use Knox as a Terraform backend, you need to configure the backend in your Terraform configuration file.

The url contains the `team/project/environment` name. The `team` is the team name, the `project` is the project name, and the `environment` is the environment name.

```hcl
terraform {
backend "http" {
username = "super"
password = "secret"
address = "http://localhost:8084/client/zeiss/demo/dev/state"
lock_address = "http://localhost:8084/client/zeiss/demo/dev/lock"
unlock_address = "http://localhost:8084/client/zeiss/demo/dev/unlock"
lock_method = "POST"
unlock_method = "POST"
}
}
```

## Helm Chart

There is a Helm chart available for Knox. You can find it in the [helm/charts](/helm/charts) directory.

:warning: **Please note that the Helm chart is still in development and should not be used in production.**

Knox requires a PostgreSQL database to store the state. [CockroachDB](https://www.cockroachlabs.com/) is recommended for production use.

```bash
helm repo add knox https://zeiss.github.io/knox/helm/charts
helm repo update
helm search repo knox
```

## License

[Apache 2.0](/LICENSE)

0 comments on commit 5b0619b

Please sign in to comment.