From 0bc5df0354aea5fb9c734e1bb788a166293b8077 Mon Sep 17 00:00:00 2001 From: Phil Estes Date: Wed, 7 Aug 2019 14:35:17 -0400 Subject: [PATCH] Clarify text on `ctr` support/inclusion Add some clarifying language around the expectations on `ctr`. Signed-off-by: Phil Estes --- RELEASES.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/RELEASES.md b/RELEASES.md index f5ec3d1ab..80eeac2f8 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -271,10 +271,15 @@ version of Kubernetes which supports that version of CRI. ### `ctr` tool The `ctr` tool provides the ability to introspect and understand the containerd -API. At this time, it is not considered a primary offering of the project. It -may be completely refactored or have breaking changes in _minor_ releases. +API. It is not considered a primary offering of the project and is unsupported in +that sense. While we understand it's value as a debug tool, it may be completely +refactored or have breaking changes in _minor_ releases. -We will try not break the tool in _patch_ releases. +Targeting `ctr` for feature additions reflects a misunderstanding of the containerd +architecture. Feature addition should focus on the client Go API and additions to +`ctr` may or may not be accepted at the discretion of the maintainers. + +We will do our best to not break compatibility in the tool in _patch_ releases. ### Daemon Configuration