Provide backstage.io/kubernetes-id and backstage.io/kubernetes-label-selector annotations as exported constants (#28710)

* export default kubernetes annotations Signed-off-by: Kurt King <kurtaking@gmail.com> * replace deprecations Signed-off-by: Kurt King <kurtaking@gmail.com> * Add changesets Signed-off-by: Kurt King <kurtaking@gmail.com> * regenerate api reports Signed-off-by: Kurt King <kurtaking@gmail.com> * Update additional references Signed-off-by: Kurt King <kurtaking@gmail.com> * fix api reports Signed-off-by: Kurt King <kurtaking@gmail.com> --------- Signed-off-by: Kurt King <kurtaking@gmail.com>
2025-02-21 06:41:39 -07:00
parent d9bc8b6bab
commit d517d13f74
7 changed files with 55 additions and 12 deletions
@@ -317,6 +317,13 @@ export interface JobsFetchResponse {
  type: 'jobs';
 }

+// @public
+export const KUBERNETES_ANNOTATION = 'backstage.io/kubernetes-id';
+
+// @public
+export const KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION =
+  'backstage.io/kubernetes-label-selector';
+
 // @public
 export const kubernetesClustersReadPermission: BasicPermission;

@@ -14,6 +14,29 @@
 * limitations under the License.
 */

+/**
+ * The annotation key used to identify Kubernetes resources in Backstage.
+ * This constant represents the standard annotation 'backstage.io/kubernetes-id'
+ * which links catalog entities to their corresponding Kubernetes resources.
+ *
+ * @public
+ */
+export const KUBERNETES_ANNOTATION = 'backstage.io/kubernetes-id';
+
+/**
+ * Annotation used to specify a Kubernetes label selector query for filtering resources.
+ * When this annotation is added to a catalog entity, it defines criteria for selecting
+ * Kubernetes resources based on their labels.
+ *
+ * @public
+ *
+ * @remarks
+ * The value of this annotation should be a valid Kubernetes label selector query string.
+ * For example: 'app=my-app,environment=production'
+ */
+export const KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION =
+  'backstage.io/kubernetes-label-selector';
+
 /**
 * Annotation for specifying the API server of a Kubernetes cluster
 *