-
Notifications
You must be signed in to change notification settings - Fork 43
Starts documentation for pull stats feature #1470
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| = getManifestPullStatistics | ||
| Get pull statistics for a specific manifest. | ||
|
|
||
| [discrete] | ||
| == GET /api/v1/repository/{repository}/manifest/{manifestref}/pull_statistics | ||
|
|
||
|
|
||
| **Authorizations: **oauth2_implicit (**repo:read**) | ||
|
|
||
|
|
||
| [discrete] | ||
| == Path parameters | ||
|
|
||
| [options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] | ||
| |=== | ||
| |Type|Name|Description|Schema | ||
| |path|**manifestref** + | ||
| _required_|The digest of the manifest|string | ||
| |path|**repository** + | ||
| _required_|The full path of the repository. e.g. namespace/name|string | ||
| |=== | ||
|
|
||
|
|
||
| [discrete] | ||
| == Responses | ||
|
|
||
| [options="header", width=100%, cols=".^2a,.^14a,.^4a"] | ||
| |=== | ||
| |HTTP Code|Description|Schema | ||
| |200|Successful invocation| | ||
| |400|Bad Request|<<_apierror,ApiError>> | ||
| |401|Session required|<<_apierror,ApiError>> | ||
| |403|Unauthorized access|<<_apierror,ApiError>> | ||
| |404|Not found|<<_apierror,ApiError>> | ||
| |=== | ||
|
|
||
| [discrete] | ||
| == Example command | ||
|
|
||
| [source,terminal] | ||
| ---- | ||
| curl -X GET \ | ||
| "https://<quay-server.example.com>/api/v1/repository/<organization>/<repository>/manifest/sha256:<manifest>/pull_statistics" \ | ||
| -H "Authorization: <bearer_token>" \ | ||
| -H "Accept: application/json" | ||
| ---- |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
|
|
||
| = getTagPullStatistics | ||
| Get pull statistics for a specific tag. | ||
|
|
||
| [discrete] | ||
| == GET /api/v1/repository/{repository}/tag/{tag}/pull_statistics | ||
|
|
||
| **Authorizations: **oauth2_implicit (**repo:read**) | ||
|
|
||
| [discrete] | ||
| == Path parameters | ||
|
|
||
| [options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] | ||
| |=== | ||
| |Type|Name|Description|Schema | ||
| |path|**repository** + | ||
| _required_|The full path of the repository. e.g. namespace/name|string | ||
| |path|**tag** + | ||
| _required_|The name of the tag|string | ||
| |=== | ||
|
|
||
| [discrete] | ||
| == Responses | ||
|
|
||
| [options="header", width=100%, cols=".^2a,.^14a,.^4a"] | ||
| |=== | ||
| |HTTP Code|Description|Schema | ||
| |200|Successful invocation| | ||
| |400|Bad Request|<<_apierror,ApiError>> | ||
| |401|Session required|<<_apierror,ApiError>> | ||
| |403|Unauthorized access|<<_apierror,ApiError>> | ||
| |404|Not found|<<_apierror,ApiError>> | ||
| |=== | ||
|
|
||
| [discrete] | ||
| == Example command | ||
|
|
||
| [source,terminal] | ||
| ---- | ||
| $ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<organization>/<repository>/tag/<tag>/pull_statistics" -H "Authorization: <bearer_token>" -H "Accept: application/json" | ||
| ---- |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
| [id="config-fields-image-activity-tracking"] | ||
| = Image activity tracking configuration fields | ||
|
|
||
| The following configuration options are available to track image activities. When enabled, clear visibility into how often and when image tags are pulled are provided in the UI. | ||
|
|
||
| .Image activity configuration fields | ||
| [cols="3a,1a,2a",options="header"] | ||
| |=== | ||
| | Field | Type | Description | ||
| |*FEATURE_IMAGE_PULL_STATS* |Boolean | Whether to track and display image pull statistics. + | ||
| + | ||
| **Default:** False | ||
|
|
||
| |*REDIS_FLUSH_INTERVAL_SECONDS* |Integer | Interval, in seconds, at which the Redis flush worker clears old data. Shorter intervals keep data fresher and help prevent Redis from bloating, while longer intervals reduce flush frequency. + | ||
| + | ||
| **Default:** 300 (5 minutes) | ||
|
|
||
| |*PULL_METRICS_REDIS* |Object | Connection settings for the Redis database used to store image pull metrics. The `host` field specifies the Redis server hostname, and the optional `db` field identifies the Redis database index to use. + | ||
| + | ||
| **Default:** {"host": "<redis_password>", "password": "<redis_password>", "port": "<port>" "db": 1} | ||
| |=== | ||
|
|
||
| .Image activity tracking example YAML | ||
| [source,yaml] | ||
| ---- | ||
| # ... | ||
| FEATURE_IMAGE_PULL_STATS: true | ||
| REDIS_FLUSH_INTERVAL_SECONDS: 30 | ||
| PULL_METRICS_REDIS: | ||
| host: <redis_host> | ||
| password: <redis_password> | ||
| port: 6379 | ||
| db: 1 | ||
| # ... | ||
| ---- | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.