vectordotdev / vectordotdev/vector

Security guide

Open
#4,144 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

domain: external docs
Dominant language
Rust
Stars
22.6k
Forks
2.3k
Avg merge
1d 7h
Merged PRs (30d)
146

Description

In https://github.com/timberio/vector/issues/1553 we added TLS to all applicable sources, and work to add this support to remaining sinks is ongoing.

As we discussed timberio/vector#2017 we noted that it would be of benefit to users if we did have a full guide for properly configuring TLS support.

Possible content:

  • The right security for your deployment
  • Understanding your threat model
  • Configuration:
    • No security
    • Tokens + Plaintext (Authentication)
    • Pre-shared keys (Encryption)
    • mTLS (Authentication, Authorization, Encryption)
  • Provisioning and configuration management tips

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the context in timberio/vector#1553 and timberio/vector#2017 first, then inspect the existing TLS configuration guidance in Vector. The guide should explain deployment security and threat models, cover the four listed configuration approaches, and include provisioning and configuration-management tips.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.