Skip to content

Commit

Permalink
Updated docs to support resource classes in Score spec (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
sujaya-sys authored Nov 1, 2023
2 parents fb6f870 + aa8f12f commit b0af6ac
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions content/en/docs/reference/score-spec-reference.md
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

0 comments on commit b0af6ac

Please sign in to comment.