chore(config, docs): Replace 'vector.toml' with 'vector.yaml' (#18388)

* chore(config, docs): Replace 'vector.toml' with 'vector.yaml'

* keep both vector.toml and vector.yaml

* remove vector.toml from asserts, still attempt to load it first and finally fallback to vector.yaml

* update conf-files and docs as well

* clippy fixes

* Update src/cli.rs

Co-authored-by: Jesse Szwedko <[email protected]>

* Update src/config/cmd.rs

Co-authored-by: Jesse Szwedko <[email protected]>

* address Jesse's review points

* add 'pront' to dictionary

* small fixes

* remove conf-files

---------

Co-authored-by: Jesse Szwedko <[email protected]>

Author: pront

Cargo.toml

@@ -50,7 +50,7 @@ section = "admin"
 maintainer-scripts = "distribution/debian/scripts/"
 assets = [
   ["target/release/vector", "/usr/bin/", "755"],
-  ["config/vector.toml", "/etc/vector/vector.toml", "644"],
+  ["config/vector.yaml", "/etc/vector/vector.yaml", "644"],
   ["config/examples/*", "/etc/vector/examples/", "644"],
   ["distribution/systemd/vector.service", "/lib/systemd/system/vector.service", "644"],
   ["distribution/systemd/vector.default", "/etc/default/vector", "600"],

config/vector.yaml

@@ -0,0 +1,47 @@
+#                                    __   __  __
+#                                    \ \ / / / /
+#                                     \ V / / /
+#                                      \_/  \/
+#
+#                                    V E C T O R
+#                                   Configuration
+#
+# ------------------------------------------------------------------------------
+# Website: https://vector.dev
+# Docs: https://vector.dev/docs
+# Chat: https://chat.vector.dev
+# ------------------------------------------------------------------------------
+
+# Change this to use a non-default directory for Vector data storage:
+# data_dir = "/var/lib/vector"
+
+# Random Syslog-formatted logs
+sources:
+  dummy_logs:
+    type: "demo_logs"
+    format: "syslog"
+    interval: 1
+
+# Parse Syslog logs
+# See the Vector Remap Language reference for more info: https://vrl.dev
+transforms:
+  parse_logs:
+    type: "remap"
+    inputs: ["dummy_logs"]
+    source: |
+      . = parse_syslog!(string!(.message))
+
+# Print parsed logs to stdout
+sinks:
+  print:
+    type: "console"
+    inputs: ["parse_logs"]
+    encoding:
+      codec: "json"
+
+# Vector's GraphQL API (disabled by default)
+# Uncomment to try it out with the `vector top` command or
+# in your browser at http://localhost:8686
+# api:
+#   enabled: true
+#   address: "127.0.0.1:8686"

distribution/docker/README.md

@@ -36,7 +36,7 @@ observability data with Vector.
 As shown above, you can pass a custom
 [Vector configuration file][docs.setup.configuration] via the `-c` flag. You'll want
 to do this since the
-[default `/etc/vector/vector.toml` configuration file][urls.default_configuration]
+[default `/etc/vector/vector.yaml` configuration file][urls.default_configuration]
 doesn't do anything.
 
 ## Deploying
@@ -128,7 +128,7 @@ Vector's Docker source files are located
 [docs.transforms]: https://vector.dev/docs/reference/transforms/
 [pages.index#correctness]: https://vector.dev/#correctness
 [pages.index#performance]: https://vector.dev/#performance
-[urls.default_configuration]: https://github.com/vectordotdev/vector/blob/master/config/vector.toml
+[urls.default_configuration]: https://github.com/vectordotdev/vector/blob/master/config/vector.yaml
 [urls.docker_alpine]: https://hub.docker.com/_/alpine
 [urls.docker_debian]: https://hub.docker.com/_/debian
 [urls.rust]: https://www.rust-lang.org/

distribution/docker/alpine/Dockerfile

@@ -13,7 +13,7 @@ FROM docker.io/alpine:3.18
 RUN apk --no-cache add ca-certificates tzdata
 
 COPY --from=builder /vector/bin/* /usr/local/bin/
-COPY --from=builder /vector/config/vector.toml /etc/vector/vector.toml
+COPY --from=builder /vector/config/vector.yaml /etc/vector/vector.yaml
 COPY --from=builder /var/lib/vector /var/lib/vector
 
 # Smoke test

distribution/docker/distroless-static/Dockerfile

@@ -12,7 +12,7 @@ RUN mkdir -p /var/lib/vector
 FROM gcr.io/distroless/static:latest
 
 COPY --from=builder /vector/bin/* /usr/local/bin/
-COPY --from=builder /vector/config/vector.toml /etc/vector/vector.toml
+COPY --from=builder /vector/config/vector.yaml /etc/vector/vector.yaml
 COPY --from=builder /var/lib/vector /var/lib/vector
 
 # Smoke test

distribution/init.d/vector

@@ -4,7 +4,7 @@
 #
 # description: A lightweight and ultra-fast tool for building observability pipelines
 # processname: vector
-# config:      /etc/vector/vector.toml
+# config:      /etc/vector/vector.yaml
 # pidfile:     /var/run/vector.pid
 
 ### BEGIN INIT INFO

distribution/install.sh

@@ -224,7 +224,7 @@ install_from_archive() {
     printf "%s Install succeeded! 🚀\n" "$_prompt"
     printf "%s To start Vector:\n" "$_prompt"
     printf "\n"
-    printf "%s vector --config $prefix/config/vector.toml\n" "$_indent"
+    printf "%s vector --config $prefix/config/vector.yaml\n" "$_indent"
     printf "\n"
     printf "%s More information at https://vector.dev/docs/\n" "$_prompt"
 

distribution/rpm/vector.spec

@@ -56,7 +56,7 @@ mkdir -p %{buildroot}%{_datadir}/%{_name}
 mkdir -p %{buildroot}%{_unitdir}
 
 cp -a %{_builddir}/bin/vector %{buildroot}%{_bindir}
-cp -a %{_builddir}/config/vector.toml %{buildroot}%{_sysconfdir}/%{_name}/vector.toml
+cp -a %{_builddir}/config/vector.yaml %{buildroot}%{_sysconfdir}/%{_name}/vector.yaml
 cp -a %{_builddir}/config/examples/. %{buildroot}%{_sysconfdir}/%{_name}/examples
 cp -a %{_builddir}/systemd/vector.service %{buildroot}%{_unitdir}/vector.service
 cp -a %{_builddir}/systemd/vector.default %{buildroot}%{_sysconfdir}/default/vector

src/cli.rs

@@ -63,8 +63,10 @@ impl Opts {
 pub struct RootOpts {
     /// Read configuration from one or more files. Wildcard paths are supported.
     /// File format is detected from the file name.
-    /// If zero files are specified the default config path
+    /// If zero files are specified the deprecated 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(
         id = "config",
         short,

src/config/cmd.rs

@@ -20,8 +20,10 @@ pub struct Opts {
 
     /// Read configuration from one or more files. Wildcard paths are supported.
     /// File format is detected from the file name.
-    /// If zero files are specified the default config path
+    /// If zero files are specified the deprecated 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(
         id = "config",
         short,

src/config/loading/mod.rs

@@ -305,22 +305,40 @@ where
 }
 
 #[cfg(not(windows))]
-fn default_config_paths() -> Vec<ConfigPath> {
-    vec![ConfigPath::File(
-        "/etc/vector/vector.toml".into(),
-        Some(Format::Toml),
-    )]
+fn default_path() -> PathBuf {
+    "/etc/vector/vector.toml".into()
 }
 
 #[cfg(windows)]
-fn default_config_paths() -> Vec<ConfigPath> {
+fn default_path() -> PathBuf {
     let program_files =
         std::env::var("ProgramFiles").expect("%ProgramFiles% environment variable must be defined");
-    let config_path = format!("{}\\Vector\\config\\vector.toml", program_files);
-    vec![ConfigPath::File(
-        PathBuf::from(config_path),
-        Some(Format::Toml),
-    )]
+    format!("{}\\Vector\\config\\vector.toml", program_files).into()
+}
+
+fn default_config_paths() -> Vec<ConfigPath> {
+    #[cfg(not(windows))]
+    let default_path = default_path();
+
+    #[cfg(windows)]
+    let default_path = default_path();
+
+    let yaml_path = default_path.with_extension("yaml");
+    if default_path.exists() {
+        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);
+
+        vec![ConfigPath::File(default_path, Some(Format::Toml))]
+    } else {
+        warn!(
+            "The {:?} config path does not exist. Vector will attempt to use new default {:?} instead.",
+            default_path, yaml_path
+        );
+
+        vec![ConfigPath::File(yaml_path, Some(Format::Yaml))]
+    }
 }
 
 #[cfg(all(

src/graph.rs

@@ -11,7 +11,7 @@ pub struct Opts {
     /// Read configuration from one or more files. Wildcard paths are supported.
     /// File format is detected from the file name.
     /// If zero files are specified the default config path
-    /// `/etc/vector/vector.toml` will be targeted.
+    /// `/etc/vector/vector.yaml` will be targeted.
     #[arg(
         id = "config",
         short,

src/unit_test.rs

@@ -23,7 +23,7 @@ pub struct Opts {
     paths_yaml: Vec<PathBuf>,
 
     /// Any number of Vector config files to test. If none are specified the
-    /// default config path `/etc/vector/vector.toml` will be targeted.
+    /// default config path `/etc/vector/vector.yaml` will be targeted.
     #[arg(value_delimiter(','))]
     paths: Vec<PathBuf>,
 

src/validate.rs

@@ -54,7 +54,8 @@ 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.toml`
-    /// will be targeted.
+    /// 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>,
 

website/content/en/_index.md

@@ -45,7 +45,7 @@ platform:
 configure:
   title: "Easy to configure"
   description: "A simple, composable format enables you to build flexible pipelines"
-  filename: "/etc/vector/vector.toml"
+  filename: "/etc/vector/vector.yaml"
   below: "Configuration examples are in [TOML](https://toml.io) but Vector also supports [YAML](https://yaml.org) and [JSON](https://json.org)"
   # Example configs are specified in cue/examples.cue
 

website/content/en/docs/administration/management.md

@@ -23,7 +23,7 @@ To manage the Vector executable directly, without a process manager:
 {{< tab title="Start" >}}
 
 ```bash
-vector --config /etc/vector/vector.toml
+vector --config /etc/vector/vector.yaml
 
 # Or supply a JSON or YAML config file
 ```
@@ -129,9 +129,9 @@ If you're running Vector on Windows (perhaps you installed it using [MSI]), you
 
 ```powershell
 C:\Program Files\Vector\bin\vector \
-  --config C:\Program Files\Vector\config\vector.toml
+  --config C:\Program Files\Vector\config\vector.yaml
 
-# Or supply a JSON or YAML config file
+# Or supply a TOML or JSON config file
 ```
 
 {{< /tab >}}
@@ -147,7 +147,7 @@ If you're running Vector using [Docker], the command interface is the same acros
 ```bash
 docker run \
   -d \
-  -v ~/vector.toml:/etc/vector/vector.toml:ro \
+  -v ~/vector.yaml:/etc/vector/vector.yaml:ro \
   -p 8686:8686 \
   timberio/vector:{{< version >}}-alpine
 ```

website/content/en/docs/administration/validating.md

@@ -8,7 +8,7 @@ Vector provides a subcommand, [`validate`][validate], that checks the validity o
 Here's an example:
 
 ```bash
-vector validate /etc/vector/vector.toml
+vector validate /etc/vector/vector.yaml
 ```
 
 You can also check multiple files:
@@ -52,7 +52,7 @@ configured topology:
 These environment checks can be disabled using the [`--no-environment`][no_environment] flag:
 
 ```bash
-vector validate --no-environment /etc/vector/vector.toml
+vector validate --no-environment /etc/vector/vector.yaml
 ```
 
 [components]: /components

website/content/en/docs/reference/configuration/_index.md

@@ -213,7 +213,7 @@ vector --config /etc/vector/vector.yaml
 {{< tab title="TOML" >}}
 
 ```shell
-vector --config /etc/vector/vector.toml
+vector --config /etc/vector/vector.yaml
 ```
 
 {{< /tab >}}
@@ -295,7 +295,7 @@ data templating languages such as [ytt], [Jsonnet] and [Cue].
 
 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.toml`.
+`/etc/vector/vector.yaml`.
 
 ### Multiple files
 

website/content/en/docs/reference/configuration/unit-tests.md

@@ -28,7 +28,7 @@ You can execute tests within a [configuration](#configuring) file using Vector's
 [`test`][vector_test] subcommand:
 
 ```bash
-vector test /etc/vector/vector.toml
+vector test /etc/vector/vector.yaml
 ```
 
 You can also specify multiple configuration files to test:

website/content/en/docs/setup/installation/platforms/docker.md

@@ -59,7 +59,7 @@ EOF
 ```shell
 docker run \
   -d \
-  -v $PWD/vector.toml:/etc/vector/vector.toml:ro \
+  -v $PWD/vector.yaml:/etc/vector/vector.yaml:ro \
   -p 8686:8686 \
   timberio/vector:{{< version >}}-debian
 ```

website/content/en/guides/level-up/troubleshooting.md

@@ -75,7 +75,7 @@ If you see an exception in Vector's logs then we've clearly found the issue.
 Before you report a bug, please enable backtraces:
 
 ```bash
-RUST_BACKTRACE=full vector --config=/etc/vector/vector.toml
+RUST_BACKTRACE=full vector --config=/etc/vector/vector.yaml
 ```
 
 Backtraces are _critical_ for debugging errors. Once you have the backtrace
@@ -95,14 +95,14 @@ Vector rate limits logs in the hot path. As a result, dropping to the
 {{< tab title="Env Var" >}}
 
 ```shell
-VECTOR_LOG=debug vector --config=/etc/vector/vector.toml
+VECTOR_LOG=debug vector --config=/etc/vector/vector.yaml
 ```
 
 {{< /tab >}}
 {{< tab title="Flag" >}}
 
 ```bash
-vector --verbose --config=/etc/vector/vector.toml
+vector --verbose --config=/etc/vector/vector.yaml
 ```
 
 {{< /tab >}}

website/content/en/highlights/2023-09-06-0-33-0-upgrade-guide.md

@@ -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"]
+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.

website/cue/reference/administration/interfaces/docker_cli.cue

@@ -30,7 +30,7 @@ administration: interfaces: docker_cli: {
 			start:        #"""
 				docker run \
 				  -d \
-				  -v \#(paths.config):/etc/vector/vector.toml:ro \
+				  -v \#(paths.config):/etc/vector/vector.yaml:ro \
 				  -p \#(_api_port):\#(_api_port) \{flags}
 				  timberio/vector:{version}-{variant}
 				"""#