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

hub: refresh usage #22097

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix table
Signed-off-by: Craig <craig.osterhout@docker.com>
  • Loading branch information
craig-osterhout committed Feb 25, 2025
commit 34ae30be65008b04e0246cb50a8422c42507095a
2 changes: 1 addition & 1 deletion content/manuals/docker-hub/usage.md
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@

When utilizing the Docker Platform, users should be aware that excessive data
transfer, pull rates, or data storage can lead to throttling, or additional
charges. To ensure fair resource usage and maintain service quality, we reserve

Check warning on line 36 in content/manuals/docker-hub/usage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.We] Avoid using first-person plural like 'we'. Raw Output: {"message": "[Docker.We] Avoid using first-person plural like 'we'.", "location": {"path": "content/manuals/docker-hub/usage.md", "range": {"start": {"line": 36, "column": 70}}}, "severity": "WARNING"}
the right to impose restrictions or apply additional charges to accounts
exhibiting excessive data and storage consumption.

@@ -243,13 +243,13 @@
| `datehour` | The date and hour (`yyyy/mm/dd/hh`) of the pull that resulted in the data transfer. | This helps in identifying peak usage times and patterns. |
| `user_name` | The Docker ID of the user that pulled the image | This lets organization owners track data consumption per user and manage resources effectively. |
| `repository` | The name of the repository of the image that was pulled. | This lets you identify which repositories are most frequently accessed and consume most of the data transfer. |
| `access_token_name` | Name of the access token that was used for authentication with Docker CLI. `generated` tokens are automatically generated by the Docker client when a user signs in. | Personal access tokens are usually used to authenticate automated tools (Docker Desktop, CI/CD tools, etc.). This is useful for identifying which automated system issued the pull. |

Check warning on line 246 in content/manuals/docker-hub/usage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Acronyms] 'CD' has no definition. Raw Output: {"message": "[Docker.Acronyms] 'CD' has no definition.", "location": {"path": "content/manuals/docker-hub/usage.md", "range": {"start": {"line": 246, "column": 331}}}, "severity": "WARNING"}
| `ips` | The IP address that was used to pull the image. This field is aggregated, so more than one IP address may appear, representing all the IPs used to pull an image within the same date and hour. | This helps you understand the origin of the data transfer, which is useful for diagnosing and identifying patterns in automated or manual pulls. |
| `repository_privacy` | The privacy state of the image repository that was pulled. This can either be `public` or `private`. | This distinguishes between public and private repositories to identify which data transfer threshold the pull impacts. |
| `tag` | The tag for the image. The tag is only available if the pull included a tag. | This helps in identifying the image. Tags are often used to identify specific versions or variants of an image. |
| `digest` | The unique image digest for the image. | This helps in identifying the image. |
| `version_checks` | The number of version checks accumulated for the date and hour of each image repository. Depending on the client, a pull can do a version check to verify the existence of an image or tag without downloading it. | This helps identify the frequency of version checks, which you can use to analyze usage trends and potential unexpected behaviors. |
| `pulls` | The number of pulls accumulated for the date and hour of each image repository. | This helps identify the frequency of repository pulls, which you can use to analyze usage trends and potential unexpected behaviors.
| `pulls` | The number of pulls accumulated for the date and hour of each image repository. | This helps identify the frequency of repository pulls, which you can use to analyze usage trends and potential unexpected behaviors. |

## Optimize usage

@@ -266,14 +266,14 @@
- Inefficient pull behavior: Identify frequently accessed repositories to
assess whether you can optimize caching practices or consolidate usage to
reduce pulls.
- Inefficient automated systems: Check which automated tools, such as CI/CD

Check warning on line 269 in content/manuals/docker-hub/usage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Acronyms] 'CD' has no definition. Raw Output: {"message": "[Docker.Acronyms] 'CD' has no definition.", "location": {"path": "content/manuals/docker-hub/usage.md", "range": {"start": {"line": 269, "column": 77}}}, "severity": "WARNING"}
pipelines, may be causing higher pull rates, and configure them to avoid
unnecessary image pulls.

3. Optimize image pulls by:

- Using caching: Implement local image caching via
[mirroring](/docker-hub/mirror/) or within your CI/CD pipelines to reduce

Check warning on line 276 in content/manuals/docker-hub/usage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Acronyms] 'CD' has no definition. Raw Output: {"message": "[Docker.Acronyms] 'CD' has no definition.", "location": {"path": "content/manuals/docker-hub/usage.md", "range": {"start": {"line": 276, "column": 57}}}, "severity": "WARNING"}
redundant pulls.
- Automating manual workflows: Avoid unnecessary pulls by configuring automated
systems to pull only when a new version of an image is available.