docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

hub: remove advanced image management 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2023-11-22 16:40:03 +01:00
parent 019a9f79d2
commit f64a0f4ce8
4 changed files with 6 additions and 308 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

259
content/docker-hub/api/latest.yaml
View File

@ -77,16 +77,6 @@ tags:
***Treat your personal access token like your password and keep it secret. You cannot retrieve
your token after it is generated.***
- name: images
x-displayName: Advanced Image Management
description: |
The Advanced Image Management API endpoints allow you to manage Docker
images across all repositories.
**<span style="color: red;">Deprecated</span>**: Advanced Image
Management is deprecated, and scheduled for removal on December 11th, 2023.
For more information, see [Deprecation of Advanced Image Management](https://github.com/docker/roadmap/issues/534).
- name: audit-logs
x-displayName: Audit Logs
description: |
@ -308,255 +298,6 @@ paths:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
/v2/namespaces/{namespace}/repositories/{repository}/images-summary:
get:
deprecated: true
tags:
- images
summary: Get summary of repository's images
description: |
Gets the number of images in a repository and the number of images
counted as active and inactive.
operationId: GetNamespacesRepositoriesImagesSummary
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: active_from
in: query
required: false
description: |
Sets the time from which an image must have been pushed or pulled to
be counted as active.
Defaults to 1 month before the current time.
schema:
type: string
responses:
200:
description: Success
content:
application/json:
schema:
$ref:
"#/components/schemas/GetNamespaceRepositoryImagesSummaryResponse"
401:
description: Unauthorized - user does not have read access to the namespace
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/repositories/{repository}/images:
get:
deprecated: true
tags:
- images
summary: Get details of repository's images
description: Gets details on the images in a repository.
operationId: GetNamespacesRepositoriesImages
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: status
in: query
required: false
description: Filters to only show images of this status.
schema:
type: string
enum:
- active
- inactive
- name: currently_tagged
in: query
required: false
description: |
Filters to only show images with:
- `true`: at least 1 current tag.
- `false`: no current tags.
schema:
type: boolean
- name: ordering
in: query
required: false
description: |
Orders the results by this property.
Prefixing with `-` sorts by descending order.
schema:
type: string
enum:
- last_activity
- -last_activity
- digest
- -digest
- name: active_from
in: query
required: false
description: |
Sets the time from which an image must have been pushed or pulled to
be counted as active.
Defaults to 1 month before the current time.
schema:
type: string
- name: page
in: query
required: false
description: Page number to get. Defaults to 1.
schema:
type: integer
- name: page_size
in: query
required: false
description: Number of images to get per page. Defaults to 10. Max of 100.
schema:
type: integer
responses:
200:
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetNamespaceRepositoryImagesResponse"
401:
description: Unauthorized - user does not have read access to the namespace.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
403:
description: Forbidden - this API is only available to users on Pro or Team plans.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/repositories/{repository}/images/{digest}/tags:
get:
deprecated: true
tags:
- images
summary: Get image's tags
description: Gets current and historical tags for an image.
operationId: GetNamespacesRepositoriesImagesTags
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: digest
in: path
required: true
description: Digest of the image.
schema:
type: string
- name: page
in: query
required: false
description: Page number to get. Defaults to 1.
schema:
type: integer
- name: page_size
in: query
required: false
description: Number of images to get per page. Defaults to 10. Max of 100.
schema:
type: integer
responses:
200:
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetNamespaceRepositoryImagesTagsResponse"
401:
description: Unauthorized - user does not have read access to the namespace
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
403:
description: Forbidden - this API is only available to users on Pro or Team plans
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/delete-images:
post:
deprecated: true
tags:
- images
summary: Delete images
operationId: PostNamespacesDeleteImages
description: |
Deletes one or more images within a namespace. This is currently limited to a single
repository.
If you attempt to delete images that are marked as active or are currently tagged, the deletion does not happen and it displays the warnings.
To continue with the deletion, you must ignore these warnings by putting them in the `ignore_warnings` property.
Deleting a currently tagged image deletes the tag from the repository.
You cannot ignore errors. It is not possible to directly delete children of multi-arch images.
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesRequest"
description: Delete request.
required: true
responses:
200:
description: Deletion completed
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesResponseSuccess"
400:
description: Deletion not possible
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesResponseError"
403:
description: Forbidden - this API is only available to users on Pro or Team plans
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/auditlogs/{account}:
get:
summary: Returns list of audit log events

45
content/docker-hub/image-management.md
View File

@ -1,45 +0,0 @@
---
description: Advanced Image Management dashboard
keywords: dashboard, images, image management, inactive
title: Advanced Image Management dashboard
---
> **Deprecated**
>
> The Advanced Image Management dashboard and API are deprecated, and scheduled
> for removal on December 11th, 2023. You can continue to use the **Tags** in
> Docker Hub to manage tags for your repository.
>
> For more information, see [Deprecation of Advanced Image Management](https://github.com/docker/roadmap/issues/534)
{ .warning }
Advanced Image Management allows you to manage Docker images across all repositories and streamline storage in Docker Hub.
It provides:
- A snapshot of your existing images
- Allows you to view, sort, and filter images by tags, activity status, and date
- Contains options to clean up your workspace by deleting images that are no longer required
## Access the Advanced Image Management dashboard
1. Sign in to [Docker Hub](https://hub.docker.com).
2. Select **Repositories**.
3. Choose a repository.
4. Select **General** or **Tags**, and then select **Go to Advanced Image Management**.
## Understand image activity status and tags
An image retains its 'active' status if it's pulled or pushed in the last month. If there isn’t any activity on the image in the last month, it's considered 'inactive'.
The dashboard also displays the old versions of images you have pushed. When you push an image to Docker Hub, you push a manifest, which is a list of all the layers of your image and the layers themselves. When you update an existing tag, only the new layers are pushed along with the new manifest which references the new layers. This new manifest gets the tag you specify when you push the image, such as `myNamespace/mytag:latest`. This doesn't remove the old manifests or the unique layers referenced by them from Hub. You can still use and reference these using the digest of the manifest if you know the SHA.
## Deleting a tagged image
A Docker image can contain multiple tags. A tag refers to a combination of artifacts or labels associated with the image. When you attempt to delete a tagged image, it deletes the tag associated with the image. This means, if there are any untagged images in your repository that previously held the same tag, those images will also be deleted even if they are active. Therefore, you must be careful when deleting tagged images.
For example, let's assume that Image A is tagged as ‘latest’. You push another image, Image B, and tag it as the new 'latest'. If you now delete Image-B, the 'latest' tag will be deleted, along with all images it previously referred to. However, if those images are tagged by another tag - in this case, if Image-B is also tagged with '1.5.0', for example, that tag would prevent its deletion.
## Advanced Image Management API
The Advanced Image Management API endpoints allow you to manage Docker images across all repositories. For more information, see [Advanced Image management API](./api/latest.md).

8
content/docker-hub/release-notes.md
View File

@ -12,6 +12,11 @@ known issues for each Docker Hub release.
Take a look at the [Docker Public Roadmap](https://github.com/docker/roadmap/projects/1) to see what's coming next.
## 2023-12-11
- The Advanced Image Management feature, along with the corresponding API endpoints, has been retired.
See [docker/roadmap#534](https://github.com/docker/roadmap/issues/534).
## 2023-08-28
- Organizations with SSO enabled can assign members to roles, organizations, and teams with [SCIM role mapping](scim.md#set-up-role-mapping).
@ -117,7 +122,6 @@ The updated [Docker Subscription Service Agreement](https://www.docker.com/legal
### Enhancement
When managing the content of your repositories, you can now filter the results based on the currentness of the tags and more easily identify your untagged images.
For more information, see [Advanced Management Dashboard](image-management.md).
For Docker Hub API documentation, see [Docker Hub API Reference](api/latest.md#operation/GetNamespacesRepositoriesImages).
@ -143,7 +147,7 @@ For details on how to update your billing information, see [Update billing infor
**Advanced Image Management dashboard**
Docker introduces the Advanced Image Management dashboard that enables you to view and manage Docker images in your repositories. For more information, see [Advanced Image Management dashboard](image-management.md).
Docker introduces the Advanced Image Management dashboard that enables you to view and manage Docker images in your repositories.
## 2021-01-25

2
data/toc.yaml
View File

@ -2032,8 +2032,6 @@ Manuals:
title: Link to GitHub and BitBucket
- path: /docker-hub/vulnerability-scanning/
title: Vulnerability scanning
- path: /docker-hub/image-management/
title: Advanced Image Management
- path: /registry/
title: Registry
- path: /docker-hub/oci-artifacts/