Skip to content

Commit

Permalink
early-boot-config: backtick filepath in doc comment
Browse files Browse the repository at this point in the history
Signed-off-by: Sam Berning <[email protected]>
  • Loading branch information
sam-berning committed Apr 4, 2024
1 parent 03ed7fe commit e38f848
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
2 changes: 1 addition & 1 deletion sources/early-boot-config/early-boot-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Current version: 0.1.0

early-boot-config sends user data to the Bottlerocket API.

Variants include their required user data provider binaries via packages. early-boot-config discovers these binaries at runtime in /usr/libexec/early-boot-config/data-providers.d and runs them in order, sending any user data found to the API.
Variants include their required user data provider binaries via packages. early-boot-config discovers these binaries at runtime in `/usr/libexec/early-boot-config/data-providers.d` and runs them in order, sending any user data found to the API.

User data provider binaries each implement the ability to obtain user data from a single source. Sources include local files, AWS Instance Metadata Service (IMDS), among others.

Expand Down
10 changes: 2 additions & 8 deletions sources/early-boot-config/early-boot-config/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
early-boot-config sends user data to the Bottlerocket API.
Variants include their required user data provider binaries via packages. early-boot-config discovers these binaries at runtime in /usr/libexec/early-boot-config/data-providers.d and runs them in order, sending any user data found to the API.
Variants include their required user data provider binaries via packages. early-boot-config discovers these binaries at runtime in `/usr/libexec/early-boot-config/data-providers.d` and runs them in order, sending any user data found to the API.
User data provider binaries each implement the ability to obtain user data from a single source. Sources include local files, AWS Instance Metadata Service (IMDS), among others.
*/
Expand All @@ -23,9 +23,6 @@ use std::{env, io, process};
use tokio::process::Command as AsyncCommand;
use walkdir::WalkDir;

// TODO
// Tests!

// We only want to run early-boot-config once, at first boot. Our systemd unit file has a
// ConditionPathExists that will prevent it from running again if this file exists.
// We create it after running successfully.
Expand Down Expand Up @@ -284,10 +281,7 @@ mod error {
Provider { source: Box<dyn std::error::Error> },

#[snafu(display("Provider '{}' failed: {}", provider.display(), message))]
ProviderFailure {
provider: PathBuf,
message: String,
},
ProviderFailure { provider: PathBuf, message: String },

#[snafu(display(
"Error deserializing provider output as JSON from {}: '{}'",
Expand Down

0 comments on commit e38f848

Please sign in to comment.