Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs to support resource classes in Score spec #63

Merged
merged 3 commits into from
Nov 1, 2023
Merged

Updated docs to support resource classes in Score spec #63

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bdc2218
Updated docs to support resource classes in Score spec
sujaya-sys Oct 24, 2023
25324f4
Added example
sujaya-sys Oct 24, 2023
aa8f12f
updated constrains
sujaya-sys Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions content/en/docs/reference/score-spec-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,26 +75,32 @@ resources:
annotations: # optional
[annotation-name]: [value]
type: [resource-type]
class: [resource-class]
```

**`resources`**: defines dependencies needed by the Workload.

**`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 "-".

`resource-type`: specifies the resource in the target environment.
`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 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 characters and dashes "-".

### Reserved resource types

Expand Down