summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYusuke Tsutsumi <yusuke@tsutsumi.io>2021-05-25 22:32:35 -0700
committerYusuke Tsutsumi <yusuke@tsutsumi.io>2021-05-25 22:32:35 -0700
commitac7999cb51bd93f9af1f21e85291336a2ae33bed (patch)
treee74376445fbb54562d22a28592b5c36fce958e01
parentbda0f5062ea22eac28e53efc4d76723597c3ce02 (diff)
Addressing comments
including blurb recommending using multi resource object references if there is a chance it will be used that way.
-rw-r--r--contributors/devel/sig-architecture/api-conventions.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md
index a319c237..5c4c4a21 100644
--- a/contributors/devel/sig-architecture/api-conventions.md
+++ b/contributors/devel/sig-architecture/api-conventions.md
@@ -934,7 +934,7 @@ objects expand, and therefore are backwards compatible.
For example, it is possible to go from a single resource type to multiple resource types without
a breaking change in the schema.
-#### References to a single resource type
+#### Single resource reference
A single kind object reference is straightforward in that the controller can hard-code most qualifiers needed to identify the object. As such as the only value needed to be provided is the name (and namespace, although cross-namespace references are discouraged):
@@ -948,11 +948,14 @@ secretRef:
namespace: foo-namespace
```
+This schema should only be used when the intention is to always have the reference only be to a single resource.
+If extending to multiple resource types is possible, use the [multiple resource reference](#multiple-resource-reference).
+
##### Controller behavior
The operator is expected to know the version, group, and resource name of the object it needs to retrieve the value from, and can use the discovery client or construct the API path directly.
-#### References which can point to multiple resource types
+#### Multiple resource reference
Multi-kind object references are used when there is a bounded set of valid resource types that a reference can point to.