Skip to content

Commit b08fcce

Browse files
committed
compatibilities extension in image index platform and image manifest config
This proposal is born from proposal A to H. Based on the maintainers feedback, The purpose of the proposal, is to address the concern maintaining standalone artifact in OCI. Spec update is done on image index platform and image manifest config. Signed-off-by: joehuang <joehuang.sweden@gmail.com>
1 parent 746c9d3 commit b08fcce

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

docs/proposals/PROPOSAL_I.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Proposal I - compatibilities extention in platform object
1+
# Proposal I - compatibilities extension in image index platform and image manifest config
22

33
This proposal is born from proposal A to H.
44

5-
The purpose of the proposal, based on the maintainers feedback, is to address the concern maintaining standalone artifact in OCI.
5+
The purpose of the proposal, based on the maintainers feedback, is to address the concern maintaining a standalone artifact specification in OCI.
66

7-
## image spec platform object extention
7+
## image spec platform object extension
88

99
### revive platform.features
1010

@@ -33,7 +33,7 @@ Add a new descriptor in platform object in [image index](https://github.com/open
3333

3434
- **`features`** _array of strings_
3535

36-
- **`compatibilities`** _[descriptor](https://github.com/opencontainers/image-spec/blob/main/descriptor.md)_
36+
- **`compat`** _[descriptor](https://github.com/opencontainers/image-spec/blob/main/descriptor.md)_
3737

3838
This OPTIONAL property specifies a descriptor of a compatibilities manifest.
3939

@@ -105,14 +105,12 @@ The required rootfs COULD be empty if the config contains compatibilities field.
105105

106106
All labels in this section are only for examples.
107107

108-
#### Example - image is compatible with different hardware combinations
108+
For example image is compatible with different hardware combinations
109109

110110
```json
111111
{
112112
"created": "2024-06-11T22:22:56.015925234Z",
113113
"author": "ChaoyiHuang<joehuang.sweden@gmail.com>",
114-
"architecture": "amd64",
115-
"os": "linux",
116114
"config": {
117115
"compatibilities": [
118116
{
@@ -137,19 +135,19 @@ All labels in this section are only for examples.
137135
}
138136
```
139137

140-
## Major concerns to address
138+
# Major concerns to address
141139

142-
No new standard to maintain, just extention on existing specification.
140+
No new standard to maintain, just extension on existing specification.
143141

144-
Reduce the size of image index considering the 4MB size limitation.
142+
Reduce the risk of image index size exceeding 4MB size limitation.
145143

146-
Update image index entry to new compatibilities manifest without rebuild image.
144+
Update the compat descriptor in image index manifest entry to the new compatibilities manifest without rebuild image.
147145

148146
Image compatibilites validation can be done without runtime engine involved.
149147

150148
Runtime engine can be configured whether to pull compatibilites manifest, and whether to validate the compatibilites in container lifecycle flow.
151149

152-
OCI only maintains common interest compatibility label.
150+
OCI only maintains common interest compatibility labels.
153151

154152
## Compatibility and NFD filed labels
155153

0 commit comments

Comments
 (0)