Skip to content

Commit

Permalink
address Jesse's review points
Browse files Browse the repository at this point in the history
  • Loading branch information
pront committed Sep 6, 2023
1 parent 7f344c2 commit 34eb5bb
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/config/loading/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,8 @@ fn default_config_paths() -> Vec<ConfigPath> {

let yaml_path = default_path.with_extension("yaml");
if default_path.exists() {
warn!("Using the deprecated {:?} config path as the default config location. Vector is migrating to YAML as the \
default config format. Future Vector versions will use {:?} as the default config location.",
warn!("DEPRECATED Using the deprecated {:?} config path as the default config location. Vector is migrating \
to YAML as the default config format. Future Vector versions will use {:?} as the default config location.",
default_path,
yaml_path);

Expand Down
5 changes: 3 additions & 2 deletions src/validate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ pub struct Opts {

/// Any number of Vector config files to validate.
/// Format is detected from the file name.
/// If none are specified the default config path `/etc/vector/vector.yaml`
/// will be targeted.
/// If none are specified the default config path `/etc/vector/vector.toml`
/// will be targeted. And if the aforementioned file does not exist,
// then `/etc/vector/vector.yaml` will be used.
#[arg(env = "VECTOR_CONFIG", value_delimiter(','))]
pub paths: Vec<PathBuf>,

Expand Down
26 changes: 26 additions & 0 deletions website/content/en/highlights/2023-09-06-0-33-0-upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
date: "2023-09-06"
title: "0.33 Upgrade Guide"
description: "An upgrade guide that addresses breaking changes in 0.33.0"
authors: ["pront"]

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error

pront is not a recognized word. (unrecognized-spelling)
release: "0.33.0"
hide_on_release_notes: false
badges:
type: breaking change
---

Vector's 0.33.0 release includes **deprecations**:

1. [Default config location change](#default-config-location-change)

We cover them below to help you upgrade quickly:

## Upgrade guide

### Deprecations

#### Default config location change {#default-config-location-change}

The default config location `/etc/vector/vector.toml` which is used by Vector `0.32.0` is now deprecated. This location will still be used in `0.33.0`. The new default path is `/etc/vector/vector.yaml`, please migrate to this new default path or specify the config path explicitly.

Vector `0.33.0` will attempt to load `/etc/vector/vector.toml` first, and if it is not present, it will fallback to `/etc/vector/vector.yaml`. However, Vector release `0.34.0` will automatically load `/etc/vector/vector.yaml` only.
3 changes: 2 additions & 1 deletion website/cue/reference/configuration.cue
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,8 @@ configuration: {
title: "Location"
body: """
The location of your Vector configuration file depends on your installation method. For most Linux
based systems, the file can be found at `/etc/vector/vector.yaml`.
based systems, the file can be found at `/etc/vector/vector.toml`. And if the aforementioned file does
not exist, then `/etc/vector/vector.yaml` will be used.
All files in `/etc/vector` are user configuration files and can be safely overridden to craft your
desired Vector configuration.
Expand Down

0 comments on commit 34eb5bb

Please sign in to comment.