From 0b78ac9cae62f0bfe46dafb5749881f58fbbf69e Mon Sep 17 00:00:00 2001 From: Amir Romashkin Date: Mon, 29 Jan 2024 12:39:32 +0100 Subject: [PATCH 1/4] fix(AIP-128): clarify usage of `annotations` field --- aip/general/0128.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/aip/general/0128.md b/aip/general/0128.md index 14baa48724..08cec99883 100644 --- a/aip/general/0128.md +++ b/aip/general/0128.md @@ -75,14 +75,13 @@ is a comprehensive reference to declarative-friendly guidance in other AIPs: - Resources **should** provide change validation: see AIP-163. - Resources **should not** implement soft-delete. If the id cannot be re-used, the resource **must** implement soft-delete and the undelete RPC: see AIP-164 - - -### Annotations - -See [AIP-148 annotations][]. +- Resources **must** include a +`map annotations` field to allow clients to store small amounts +of arbitrary data: see AIP-148 ## Changelog +- **2024-01-29**: Clarify usage of `annotations`. - **2023-07-13**: Move `annotations` from AIP-148. - **2023-06-17**: Definition of plane was removed and incorporated into AIP-111. - **2023-05-11**: Removed must on resource_id, which was upstreamed to a general From 5e0e54c22cf35c7e1a3aae111e6e0296759d9dd7 Mon Sep 17 00:00:00 2001 From: Amir Romashkin Date: Mon, 29 Jan 2024 12:58:28 +0100 Subject: [PATCH 2/4] fix(AIP-148): clatify guide for annotations regarding Declarative-friendly resources --- aip/general/0148.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/aip/general/0148.md b/aip/general/0148.md index e75599e831..721a209183 100644 --- a/aip/general/0148.md +++ b/aip/general/0148.md @@ -116,7 +116,7 @@ field **may** be added. The `annotations` field **must** use the [Kubernetes limits][] to maintain wire compatibility, and **should** require dot-namespaced annotation keys to prevent -tools from trampling over one another. +tools from trampling over one another. [Declarative-friendly resources][] **should** include this field. Examples of information that might be valuable to store in annotations include: @@ -185,4 +185,4 @@ Before 2023-07, `purge_time` for soft-deleted resources was also called [aip-202]: ./0202.md [declarative-friendly resources]: ./0128.md#resources [kubernetes limits]: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set -[uuid4]: https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random) \ No newline at end of file +[uuid4]: https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random) From 3a2d26966d1f66666e860f225f3b0cb81dc8f82d Mon Sep 17 00:00:00 2001 From: Amir Romashkin Date: Mon, 29 Jan 2024 13:00:05 +0100 Subject: [PATCH 3/4] fix(AIP-148): fix should to must in regard to annotations for declarative resources --- aip/general/0148.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aip/general/0148.md b/aip/general/0148.md index 721a209183..2428995c41 100644 --- a/aip/general/0148.md +++ b/aip/general/0148.md @@ -116,7 +116,7 @@ field **may** be added. The `annotations` field **must** use the [Kubernetes limits][] to maintain wire compatibility, and **should** require dot-namespaced annotation keys to prevent -tools from trampling over one another. [Declarative-friendly resources][] **should** include this field. +tools from trampling over one another. [Declarative-friendly resources][] **must** include this field. Examples of information that might be valuable to store in annotations include: From 56f1c61f92335a2668bd756dd4e76db34fe21a03 Mon Sep 17 00:00:00 2001 From: Amir Romashkin Date: Mon, 29 Jan 2024 13:07:39 +0100 Subject: [PATCH 4/4] Add changelog for AIP-0148 --- aip/general/0148.md | 1 + 1 file changed, 1 insertion(+) diff --git a/aip/general/0148.md b/aip/general/0148.md index 2428995c41..633420960c 100644 --- a/aip/general/0148.md +++ b/aip/general/0148.md @@ -175,6 +175,7 @@ Before 2023-07, `purge_time` for soft-deleted resources was also called ## Changelog +- **2024-01-29**: Clarify usage of `annotations` in `Declarative-friendly resources`. - **2023-10-05**: Introduce well known string fields with IP Address and `uid`. - **2023-08-14**: Introduce the term `annotations` from AIP-128. - **2023-07-13**: Introduce the term `purge_time`.