Files
distributor/docs/roadmap/implementation.md

2.1 KiB

Implementation Roadmap

This roadmap records current implementation status and deferred work for distributor. Implemented behavior is documented in the user, operator, and internal documentation listed below.

Canonical current-behavior docs:

  • README.md
  • docs/cli.md
  • docs/config.md
  • docs/operations.md
  • docs/troubleshooting.md
  • docs/internal/
  • docs/integrations/markdown.md
  • docs/policy/
  • examples/

Future, planned, or aspirational behavior belongs under docs/roadmap/ until it is implemented.

Current State

distributor is ready for routine use against producer pipelines using the implemented local, SSH/SFTP, and S3-compatible backends.

Active Roadmap

There are no active implementation items in this roadmap.

Before implementing new product behavior, add a focused roadmap entry when the work changes storage semantics, config, CLI behavior, state schema, transform behavior, notification behavior, operational safety, or user-visible workflows. Keep those entries out of current-behavior docs until the behavior exists.

Deferred Work

These items are not implemented and should stay out of current-behavior docs until a roadmap entry is selected and implemented:

  • external notification adapters;
  • warning-only digest mismatch handling;
  • additional auth mechanisms beyond the implemented SSH and S3 credential paths;
  • compatibility parsing for legacy SSH URI config;
  • broad recursive destination deletion outside managed bundle paths;
  • concurrent fan-out publishing;
  • streaming, resumable, or multipart S3 uploads;
  • cloud-provider-specific IAM integration docs;
  • repository-managed packaging, release, and deployment automation.

Roadmap Maintenance

When adding future roadmap work:

  • describe user-visible behavior and safety boundaries;
  • define which existing docs must change after implementation;
  • keep examples secret-free and runnable or clearly environment-gated;
  • avoid workflow labels in production code, tests, config fields, and user documentation;
  • run focused tests for the changed behavior and go test ./... for cross-package changes.