From 8bef5491158aee8e85dac4d2551b612f08aa7f7e Mon Sep 17 00:00:00 2001 From: Adrian Plata <51415348+adrian-plata@users.noreply.github.com> Date: Wed, 21 Aug 2019 13:53:53 -0700 Subject: [PATCH] Create deprecated-schema-v1.md Signed-off-by: Adrian Plata smoothing content Signed-off-by: Adrian Plata more information and link Signed-off-by: Adrian Plata minor text changes Signed-off-by: Adrian Plata added another link Signed-off-by: Adrian Plata --- docs/spec/deprecated-schema-v1.md | 40 +++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/spec/deprecated-schema-v1.md diff --git a/docs/spec/deprecated-schema-v1.md b/docs/spec/deprecated-schema-v1.md new file mode 100644 index 00000000000..40909abb584 --- /dev/null +++ b/docs/spec/deprecated-schema-v1.md @@ -0,0 +1,40 @@ +--- +title: Update deprecated schema image manifest version 2, v1 images +description: Update deprecated schema v1 iamges +keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest +--- + +## Image manifest version 2, schema 1 +As of xx-yyyy, image manifest version 2, schema 1 has been +deprecated. This could lead to compatibility and vulnerability issues in images +that haven't been updated to image manifest version 2, schema 2. + +This page contains information on how to update from image manifest version 2, +schema 1. However, these instructions will not ensure your new image will run +successfully. There may be several other issues to troubleshoot that are +associated with the deprecated image manifest that will block your image from +running succesfully. A list of possible methods to help update your image is +also included below. + +### Update to image manifest version 2, schema 2 + +One way to upgrade an image from image manifest version 2, schema 1 to +schema 2 is to `docker pull` the image and then `docker push` the image with a +current version of Docker. Doing so will automatically convert the image to use +the latest image manifest specification. + +Converting an image to image manifest version 2, schema 2 converts the +manifest format, but does not update the contents within the image. Images +using manifest version 2, schema 1 may contain unpatched vulnerabilities. We +recommend looking for an alternative image or rebuilding it. + + +### Update FROM statement + +One way to rebuild the image is to update the `FROM` statement in your +`Dockerfile`. If your image manifest is out-of-date, there is a chance the +image pulled from your `FROM` statement in your `Dockerfile` is also +out-of-date. See the [Dockerfile reference](https://docs.docker.com/engine/reference/builder/#from) +and the [Dockerfile best practices guide](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) +for more information on how to update the `FROM` statement in your +`Dockerfile`.