Deuxfleurs/garage
49
56
Fork 73
Code Issues 99 Pull requests 12 Releases 30 Wiki Activity

Implement rpc_secret_file #466

Merged
lx merged 3 commits from felix.scheinost/garage:feature/implement-rpc-secret-file into main 2023-01-11 16:04:36 +00:00
Conversation 2 Commits 3 Files changed 12 +208 -24
felix.scheinost commented 2023-01-04 19:19:54 +00:00
Contributor
Copy link

This PR implements reading of rpc_secret from a file using the new option rpc_secret_file.

When both rpc_secret and rpc_secret_file are set, rpc_secret is preferred.
Otherwise read_config tries to read the file and set rpc_secret.

The current implementation is not ideal because before pub rpc_secret: String wasn't optional, now it is. Ideally reading the file would be handled during serde deserialization and an error would be returned if no property would be set or if the file could not be read. This way rpc_secret would already be either a valid string from rpc_secret TOML or the contents of rpc_secret_file. The downstream code would not need to handle the Option<String>.

I also added a .direnv file and a devShell to flake.nix. I tried getting shell.nix to work on my machine (aarch64-darwin) but adding devShell to flake.nix was quicker and should also be the more future-proof situtation.

With this setup I could properly do development with VS Code + Rust plugin + direnv plugin without even having Rust or Cargo installed globally, on macOS.

I formatted flake.nix using nixfmt, I hope that's okay. I don't like manually formatting code :-) (Actually I have undone the changes to the first line, nixfmt would insert a linebreak there. I personally wouldn't mind the linebreak though.)

This PR implements reading of `rpc_secret` from a file using the new option `rpc_secret_file`. When both `rpc_secret` and `rpc_secret_file` are set, `rpc_secret` is preferred. Otherwise `read_config` tries to read the file and set `rpc_secret`. The current implementation is not ideal because before `pub rpc_secret: String` wasn't optional, now it is. Ideally reading the file would be handled during serde deserialization and an error would be returned if no property would be set or if the file could not be read. This way `rpc_secret` would already be either a valid string from `rpc_secret` TOML or the contents of `rpc_secret_file`. The downstream code would not need to handle the `Option<String>`. --- I also added a `.direnv` file and a `devShell` to `flake.nix`. I tried getting `shell.nix` to work on my machine (`aarch64-darwin`) but adding `devShell` to `flake.nix` was quicker and should also be the more future-proof situtation. With this setup I could properly do development with VS Code + Rust plugin + direnv plugin without even having Rust or Cargo installed globally, on macOS. I formatted `flake.nix` using `nixfmt`, I hope that's okay. I don't like manually formatting code :-) (Actually I have undone the changes to the first line, nixfmt would insert a linebreak there. I personally wouldn't mind the linebreak though.)
felix.scheinost added 1 commit 2023-01-04 19:19:56 +00:00
Implement rpc_secret_file
All checks were successful
continuous-integration/drone/pr Build is passing
Details
f2106c2733
lx reviewed 2023-01-05 10:47:10 +00:00
lx left a comment
Owner
Copy link

Otherwise LGTM

Otherwise LGTM
src/util/config.rs
@ -180,1 +183,3 @@
Ok(toml::from_str(&config)?)
let mut parsed_config: Config = toml::from_str(&config)?;
match (&parsed_config.rpc_secret, &parsed_config.rpc_secret_file) {
lx commented 2023-01-05 10:46:10 +00:00
Owner
Copy link

I think in case we have both rpc_secret and rpc_secret_file, we should at least warn the user that something is wrong (probably just throw an Err)

I think in case we have both `rpc_secret` and `rpc_secret_file`, we should at least warn the user that something is wrong (probably just throw an Err)
felix.scheinost added 1 commit 2023-01-07 12:49:22 +00:00
felix.scheinost force-pushed feature/implement-rpc-secret-file from fec9a53e6f to d6ea0cbefa 2023-01-07 13:20:06 +00:00 Compare
felix.scheinost commented 2023-01-07 13:31:18 +00:00
Author
Contributor
Copy link

I added throwing an error when both rpc_secret and rpc_secret_file are set and I added some tests.

I added throwing an error when both `rpc_secret` and `rpc_secret_file` are set and I added some tests.
lx commented 2023-01-11 16:04:33 +00:00
Owner
Copy link

Thank you for your contribution

Thank you for your contribution
lx merged commit 94d723f27c into main 2023-01-11 16:04:36 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
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
2 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#466
No description provided.
Delete branch "felix.scheinost/garage:feature/implement-rpc-secret-file"

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?