Changes the config layer of the feature manifest to a empty descriptor #815
Conversation
This commit changes the config layer of the feature manifest to a empty descriptor according to the OCI image manifest specification to to increase the available feature registry. Some registries that implement the OCI image manifest specification, such as AWS ECR, do not support pushing empty content (size 0). However, the manifest may contain layers with no content. Therefore, the OCI Image Manifest specification specifies an empty descriptor of non-zero size to represent a layer with no content. Currently, the devcontainer feature manifest specifies the config layer as an empty content (size 0) layer. If the devcontainer feature manifest conforms to this specification, it can also available registries that cannot publish empty content (size 0). Specification: https://github.com/opencontainers/image-spec/blob/8f3820ccf8f65db8744e626df17fe8a64462aece/manifest.md#guidelines-for-artifact-usage Note: If the config is set to an empty descriptor, the manifest media type must be defined in the artifactType.
There was a problem hiding this comment.
Looping in @joshspicer for his expertise with OCI spec changes.
|
@microsoft-github-policy-service agree company="freee" |
…scriptor" This reverts commit 1b290f0.
The content of the configuration layer of the feature manifest is specified as empty content (size 0). This is because there is no content to reference in the config layer content of the feature manifest. However, some registries that implement the OCI image manifest specification, such as AWS ECR, do not support pushing empty content (size 0). Therefore, this commit changes the content of the config layer of the feature manifestto indicate that empty objects have no content to reference.
ych-tnk
force-pushed
the
change-config-layer-to-empty-descriptor
branch
from
4b379ae
to
a83bb7e
Compare
There was a problem hiding this comment.
The changes here look good to me - thanks! You've tested against AWS's container registry with the very latest changes?
For the failing tests looks like you'll want to revert those hashes back (since blobs with those hashes aren't yet pushed to the registry)
If you want to further exercise via tests, you may want to consider expanding upon the tests here, which runs a locally-hosted container registry instead of depending on previously-published Features.
ych-tnk
force-pushed
the
change-config-layer-to-empty-descriptor
branch
from
0abc8b8
to
192abc4
Compare
I updated the branch and tested pushing and installing the feature again using the AWS Container Registry without any issues.
I don't know how to run the GitHub registry locally, so I decided to revert the test changes. After this PR is merged and the feature that the test depends on is pushed, I will create a PR that will change to depend on the new version of the feature. 192abc4 |
Just for clarity, the tests I linked to interact directly with a "local" registry in a docker container (I bit meta, I know). Nothing ever leaves the test infrastructure, so it's a nice place to write tests since it's all "emulated" in containers instead of hitting a real registry |
|
I used your changes here to publish to ghcr.io as a final smoke test 🚀 I pushed these Features: And consumed the Feature in this test repo: I don't see any concerns with older CLI backwards compatibility 👍 |
|
Since the test was failing, I changed the tests to depend on the package you created for the smoke test. If there seems to be a problem, I will replace the test with a local registry on the docker container. d134da7 |
|
Given that you're now just wrestling with tests that i've set up, i'm happy to take over the PR to get it over the line :) Appreciate all the work and communication! |
I forgot to include #815 in the changelog
I forgot to include #815 in the changelog
Description
This commit changes the config layer of the feature manifest to a empty descriptor according to the OCI image manifest specification to to increase the available feature registry.
Related Issue
Issue #814
Motivation and Context
Some registries that implement the OCI image manifest specification, such as AWS ECR, do not support pushing empty content (size 0). However, the manifest may contain layers with no content. Therefore, the OCI Image Manifest specification specifies an empty descriptor of non-zero size to represent a layer with no content.
Currently, the devcontainer feature manifest specifies the config layer as an empty content (size 0) layer. If the devcontainer feature manifest conforms to this specification, it can also available registries that cannot publish empty content (size 0).
Specification: https://github.com/opencontainers/image-spec/blob/8f3820ccf8f65db8744e626df17fe8a64462aece/manifest.md#guidelines-for-artifact-usage
Note: If the config is set to an empty descriptor, the manifest media type must be defined in the artifactType.
How Has This Been Tested?