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.

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

config: Clarify ociVersion covering the configuration <-> runtime API #523

Merged
merged 1 commit into from
Sep 15, 2016

Commits on Sep 14, 2016

  1. config: Clarify ociVersion covering the configuration <-> runtime API

    There are other APIs described in this specification (e.g. the state
    JSON format, and the in-flight command-line API [1]), but this string
    covers the configuration file and referenced objects (e.g. the
    filesystem at root.path).  As additional, backwards compatible
    features are added to the spec (leading to 1.1, 1.2, etc. releases)
    and supported by runtimes, those runtimes will *still* stupport 1.0
    configs.  Once a 2.0 spec is cut, runtimes that only support 2.0 (and
    nothing in the 1.0 line) will no longer support the 1.0 config.
    
    My preferred approach here would be to use JSON-LD [2,3,4] to
    explicitly document the intended semantics for each field, which would
    allow us to drop the config-wide version and version each field
    independently.  That would mean a breaking change on a particular
    field would only break compatibility for folks who were using that
    field.  Unfortunately, I haven't had much luck pushing the consensus
    in that direction.
    
    This commit does not add wording about how the runtime and other
    consumers should handle an incompatible version.  We can address that
    once the command-line API lands.
    
    [1]: opencontainers#513
    [2]: opencontainers#371 (comment)
    [3]: opencontainers/image-spec#111 (comment)
    [4]: opencontainers#510 (comment)
    
    Signed-off-by: W. Trevor King <wking@tremily.us>
    wking committed Sep 14, 2016
    Configuration menu
    Copy the full SHA
    c94e7c0 View commit details
    Browse the repository at this point in the history