Deuxfleurs/garage
41
56
Fork 73
Code Issues 99 Pull requests 14 Releases 30 Wiki Activity

Add support for specifying rpc_secret_file, metrics_token_file and admin_token_file using environment variables #643

Merged
lx merged 4 commits from networkException/garage:token-file-env into main-0.8.x 2023-10-19 09:33:12 +00:00
Conversation 4 Commits 4 Files changed 5 +57 -25
networkException commented 2023-10-03 16:35:42 +00:00
Contributor
Copy link

This pull request adds the GARAGE_RPC_SECRET_FILE, GARAGE_METRICS_TOKEN_FILE and GARAGE_ADMIN_TOKEN_FILE environment variables to properly support systemd credentials

This pull request adds the `GARAGE_RPC_SECRET_FILE`, `GARAGE_METRICS_TOKEN_FILE` and `GARAGE_ADMIN_TOKEN_FILE` environment variables to properly support systemd credentials
networkException force-pushed token-file-env from ec7e8f0658 to e05ec5968d 2023-10-03 16:37:11 +00:00 Compare
lx commented 2023-10-04 08:47:49 +00:00
Owner
Copy link

In the existing code, all environment variables used by the Garage CLI are declared in main.rs in the garage crate, here: https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/garage/main.rs.
I feel that it makes the code more confusing and hard to maintain that some environment variables are used directly in garage_util. Also, having the env variables declared in main.rs makes them available as CLI options as well, and they are documented in the --help screen.

I know it's going to be a bit more code, but could you please make it so that all environment variables are declared in garage/main.rs?

In the existing code, all environment variables used by the Garage CLI are declared in `main.rs` in the `garage` crate, here: <https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/garage/main.rs>. I feel that it makes the code more confusing and hard to maintain that some environment variables are used directly in `garage_util`. Also, having the env variables declared in `main.rs` makes them available as CLI options as well, and they are documented in the `--help` screen. I know it's going to be a bit more code, but could you please make it so that all environment variables are declared in `garage/main.rs`?
lx commented 2023-10-04 08:49:17 +00:00
Owner
Copy link

Reading the files specified in the _FILE environment variables will have to happen in fill_secrets. The return type of fill_secrets will have to be changed to a Result<Config, Error>.

Reading the files specified in the `_FILE` environment variables will have to happen in [`fill_secrets`](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/garage/main.rs). The return type of `fill_secrets` will have to be changed to a `Result<Config, Error>`.
flokli requested changes 2023-10-16 19:58:17 +00:00
doc/book/reference-manual/configuration.md Outdated
@ -288,6 +288,9 @@ Since Garage `v0.8.2`, the RPC secret can also be stored in a file whose path is
given in the configuration variable `rpc_secret_file`, or specified as an
environment variable `GARAGE_RPC_SECRET`.
Since Garage `v0.8.5`, you can also specify the path of a file storing the secret
flokli commented 2023-10-16 19:58:08 +00:00
Contributor
Copy link

That's not 0.8.5 anymore, considering 0.9.0 was released.

That's not 0.8.5 anymore, considering 0.9.0 was released.
networkException marked this conversation as resolved
networkException force-pushed token-file-env from e05ec5968d to 8599051c49 2023-10-19 01:40:03 +00:00 Compare
networkException commented 2023-10-19 01:43:10 +00:00
Author
Contributor
Copy link

Sorry for the long delay, I hope the changes are better now. Fell into a few rabbit holes in the meanwhile, including unix socket support for rpc (things like garage status work, I'll need to check cluster operation and will look into opening a pull request afterwards :D)

Sorry for the long delay, I hope the changes are better now. Fell into a few rabbit holes in the meanwhile, including unix socket support for rpc (things like `garage status` work, I'll need to check cluster operation and will look into opening a pull request afterwards :D)
lx changed title from Add support for specifying rpc_secret_file, metrics_token_file and admin_token_file using environment variables to Add support for specifying rpc_secret_file, metrics_token_file and admin_token_file using environment variables 2023-10-19 09:32:39 +00:00
lx changed target branch from main to main-0.8.x 2023-10-19 09:32:39 +00:00
lx merged commit 0215b11402 into main-0.8.x 2023-10-19 09:33:12 +00:00
lx commented 2023-10-19 09:33:20 +00:00
Owner
Copy link

Thanks!

Thanks!
flokli reviewed 2023-10-20 11:10:00 +00:00
src/util/config.rs
@ -240,1 +240,4 @@
pub fn read_secret_file(file_path: &String) -> Result<String, Error> {
#[cfg(unix)]
if std::env::var("GARAGE_ALLOW_WORLD_READABLE_SECRETS").as_deref() != Ok("true") {
flokli commented 2023-10-20 11:10:00 +00:00
Contributor
Copy link

This check will actually fail on more recent versions of systemd, as they switched from plain chmods to ACLs, and it's not trivial to determine if something is readable by others or not.

I think it'd make more sense to drop this check to become a warning.

This check will actually *fail* on more recent versions of systemd, as they switched from plain chmods to ACLs, and it's not trivial to determine if something is readable by others or not. I think it'd make more sense to drop this check to become a warning.
flokli commented 2023-10-20 11:11:00 +00:00
Contributor
Copy link

Upstream systemd issue: https://github.com/systemd/systemd/issues/29435

Upstream systemd issue: https://github.com/systemd/systemd/issues/29435
flokli commented 2023-10-26 07:54:16 +00:00
Contributor
Copy link

workaround in #663

workaround in https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/663
lx referenced this pull request from a commit 2024-01-16 11:13:07 +00:00
Garage v0.8.5
Sign in to join this conversation.
Reviewers
No reviewers
flokli
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#643
No description provided.
Delete branch "networkException/garage:token-file-env"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?