add Compose OCI artifact how-to page #22240
Merged
+145
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
area/compose
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
glours
force-pushed
the
compose-oci-artifact
branch
2 times, most recently
from
1a080f1 to
d4516b3
Compare
ndeloof
approved these changes
Mar 13, 2025
| @@ -0,0 +1 @@ | |||
| Docker Compose supports working with OCI (Open Container Initiative) artifacts, allowing you to package and distribute your Compose applications through container registries. This means you can store your Compose files alongside your container images, making it easier to version, share, and deploy your multi-container applications. | |||
There was a problem hiding this comment.
Suggested change
| Docker Compose supports working with OCI (Open Container Initiative) artifacts, allowing you to package and distribute your Compose applications through container registries. This means you can store your Compose files alongside your container images, making it easier to version, share, and deploy your multi-container applications. | |
| Docker Compose supports working with [OCI artifacts](https://docs.docker.com/docker-hub/repos/manage/hub-images/oci-artifacts/), allowing you to package and distribute your Compose applications through container registries. This means you can store your Compose files alongside your container images, making it easier to version, share, and deploy your multi-container applications. |
| When you run an application from an OCI artifact, Compose may display warning messages requiring your confirmation to limit risks of running a malicious application: | ||
| * Listing the interpolation variables used along with their values | ||
| * Listing all environment variables used by the application | ||
| * Let you know if your OCI artifact application is using another remote resources (via `include` for example) |
There was a problem hiding this comment.
Suggested change
| * Let you know if your OCI artifact application is using another remote resources (via `include` for example) | |
| * Let you know if your OCI artifact application is using another remote resources (via [`include`](/reference/compose-file/include/) for example) |
| ``` | ||
| or passing multiple Compose files | ||
| ```bash | ||
| $ docker compose -f docker-compose.yml -f docker-compose.override.yml publish username/my-compose-app:latest |
There was a problem hiding this comment.
not a good example, as compose + override are the default files being selected when flag is not set.
Also prefer compose.yaml over docker-compose.yml according to the spec
| ## Limitations and considerations | ||
|
|
||
| There is limitations to publishing Compose applications as OCI artifacts: | ||
| * You can't publish Compose configuration using `include` of local files |
There was a problem hiding this comment.
maybe explain: "if you include another compose model, you should publish this one as well"
Signed-off-by: Guillaume Lours <[email protected]>
glours
force-pushed
the
compose-oci-artifact
branch
from
d4516b3 to
7d48392
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add a new Compose how-to page explaining usage OCI artifacts with Compose
Related issues or tickets
https://docker.atlassian.net/browse/APCLI-1015
Reviews