Skip to content

Commit

Permalink
docs: docker registry warning on readme and changelog fix
Browse files Browse the repository at this point in the history
  • Loading branch information
hbollon committed Oct 26, 2023
1 parent 62f140d commit b264059
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

### Features

* **go:** upgrade Terraboard's Go version to v1.17 ([e457ebc](https://www.github.com/camptocamp/terraboard/commit/e457ebc154730baea6fbbf1723e52e417c67f55c))
* **go:** upgrade Terraboard's Go version to v1.21
* **internal:** update Terraform's internal packages ([e457ebc](https://www.github.com/camptocamp/terraboard/commit/e457ebc154730baea6fbbf1723e52e417c67f55c))


Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@

---

<p align="center"><strong>Caution: Terraboard's Docker registry was migrated from Dockerhub to GHCR! All new tags will be now pushed <a href="https://github.com/camptocamp/terraboard/pkgs/container/terraboard">here</a>. You can still access to old tags on the legacy Dockerhub repository.</strong></p>

<details><summary>Table of content</summary>

- [What is it?](#what-is-it)
Expand Down Expand Up @@ -93,7 +95,7 @@ It currently supports several remote state backend providers:
- [GitLab](https://docs.gitlab.com/ee/user/infrastructure/terraform_state.html)

Terraboard is now able to handle multiple buckets/providers configuration! 🥳
Check *configuration* section for more details.
Check *configuration* section for more details.

### Overview

Expand Down Expand Up @@ -175,22 +177,22 @@ aws:
s3:
- bucket: test-bucket
force-path-style: true
file-extension:
file-extension:
- .tfstate

- endpoint: http://minio:9000/
region: eu-west-1
s3:
- bucket: test-bucket2
force-path-style: true
file-extension:
file-extension:
- .tfstate
```
In the case of AWS, don't forget to set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.

That's it! Terraboard will now fetch these two buckets on DB refresh. You can also mix providers like AWS and Gitlab or anything else.
You can find a ready-to-use Docker example with two *MinIO* buckets in the `test/multiple-minio-buckets/` sub-folder.
You can find a ready-to-use Docker example with two *MinIO* buckets in the `test/multiple-minio-buckets/` sub-folder.

### Available parameters

Expand All @@ -199,7 +201,7 @@ You can find a ready-to-use Docker example with two *MinIO* buckets in the `test
- `-V`, `--version` Display version.
- `-c`, `--config-file` <default: *$CONFIG_FILE*> Config File path
- Env: *CONFIG_FILE*

#### General Provider Options

- `--no-versioning` <default: *$TERRABOARD_NO_VERSIONING*> Disable versioning support from Terraboard (useful for S3 compatible providers like MinIO)
Expand Down Expand Up @@ -401,7 +403,7 @@ docker run -p 8080:8080 \
-e DB_PASSWORD="<mypassword>" \
-e DB_SSLMODE="disable" \
--net terraboard \
camptocamp/terraboard:latest
ghcr.io/camptocamp/terraboard:latest
```

Then point your browser to http://localhost:8080.
Expand Down

0 comments on commit b264059

Please sign in to comment.