From bdc2218605bc3d7c5856c1760571caf2cb3a2b37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susanne=20T=C3=BCnker?= Date: Tue, 24 Oct 2023 12:12:00 +0200 Subject: [PATCH 1/3] Updated docs to support resource classes in Score spec --- content/en/docs/reference/score-spec-reference.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/score-spec-reference.md b/content/en/docs/reference/score-spec-reference.md index 3cd45b8a..be9e1b81 100644 --- a/content/en/docs/reference/score-spec-reference.md +++ b/content/en/docs/reference/score-spec-reference.md @@ -75,6 +75,7 @@ resources: annotations: # optional [annotation-name]: [value] type: [resource-type] + class: [resource-class] ``` **`resources`**: defines dependencies needed by the Workload. @@ -91,7 +92,12 @@ resources: - **`Type`**: object. - **`Constraints`**: alphanumeric string key-value pairs. -`resource-type`: specifies the resource in the target environment. +`type`: specifies the resource type. + +- **Type**: string. +- **Constraints**: alphanumeric string. + +`class`: a specialisation of the resource type. - **Type**: string. - **Constraints**: alphanumeric string. From 25324f40393ac4d18406535d9f11941616ea325d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susanne=20T=C3=BCnker?= Date: Tue, 24 Oct 2023 13:58:35 +0200 Subject: [PATCH 2/3] Added example --- content/en/docs/reference/score-spec-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/reference/score-spec-reference.md b/content/en/docs/reference/score-spec-reference.md index be9e1b81..99da5b74 100644 --- a/content/en/docs/reference/score-spec-reference.md +++ b/content/en/docs/reference/score-spec-reference.md @@ -97,7 +97,7 @@ resources: - **Type**: string. - **Constraints**: alphanumeric string. -`class`: a specialisation of the resource type. +`class`: a specialisation of the resource type. For example, a workload that needs an externally accessible resource might set the class to external while the workload that requires an encrypted resource might have a class of sensitive. - **Type**: string. - **Constraints**: alphanumeric string. From aa8f12fa24fd1f005d11d4bf35a55541d7312b09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susanne=20T=C3=BCnker?= Date: Wed, 25 Oct 2023 18:25:48 +0200 Subject: [PATCH 3/3] updated constrains --- content/en/docs/reference/score-spec-reference.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/reference/score-spec-reference.md b/content/en/docs/reference/score-spec-reference.md index 99da5b74..c0ef12a7 100644 --- a/content/en/docs/reference/score-spec-reference.md +++ b/content/en/docs/reference/score-spec-reference.md @@ -83,24 +83,24 @@ resources: **`resource-name`**: a required property that specifies the resource name. - **Type**: string. -- **Constraints**: alphanumeric string. +- **Constraints**: alphanumeric characters and dashes "-". **`metadata`**: an optional property that specifies additional resource metadata. - **`Type`**: object. - **`annotations`**: an optional property that specifies metadata annotations. - **`Type`**: object. - - **`Constraints`**: alphanumeric string key-value pairs. + - **`Constraints`**: key-value pairs with alphanumeric characters and dashes "-". `type`: specifies the resource type. - **Type**: string. -- **Constraints**: alphanumeric string. +- **Constraints**: alphanumeric characters and dashes "-". -`class`: a specialisation of the resource type. For example, a workload that needs an externally accessible resource might set the class to external while the workload that requires an encrypted resource might have a class of sensitive. +`class`: a specialisation of the resource type. For example, a workload that needs an externally accessible storage bucket might set the class to external while the workload that requires an encrypted resource might have a class of sensitive. - **Type**: string. -- **Constraints**: alphanumeric string. +- **Constraints**: alphanumeric characters and dashes "-". ### Reserved resource types