images¶
Contents¶
-
Services
-
Messages
ImageService¶
ImageService serves image resource APIs. This is a service endpoint which allows PDS users to get information of all supported data service version's images.
GetImage¶
rpc GetImage(GetImageRequest) Image
GetImage API returns the information about the specified image.
ListImages¶
rpc ListImages(ListImagesRequest) ListImagesResponse
ListImages API lists the data service images.
Messages¶
GetImageRequest¶
Request to get the image details.
| Field | Type | Description |
|---|---|---|
| id | string | UID of the image. |
Image¶
Resource representing the data service image.
| Field | Type | Description |
|---|---|---|
| meta | public.portworx.common.v1.Meta | Metadata of the resource. |
| info | Info | Information related to the data service image. |
Info¶
Information related to the data service image.
| Field | Type | Description |
|---|---|---|
| references | References | Reference of the image. |
| registry | string | Image registry where the image is stored. |
| namespace | string | Image registry namespace where the image is stored. |
| tag | string | Tag associated with the image. |
| build | string | Build version of the image. |
| tls_support | bool | Flag indicating if TLS is supported for a data service using this image. |
| capabilities | map Info.CapabilitiesEntry | Capabilities associated with this image. |
| additional_images | map Info.AdditionalImagesEntry | Additional images associated with this data service image. |
Info.AdditionalImagesEntry¶
| Field | Type | Description |
|---|---|---|
| key | string | none |
| value | string | none |
Info.CapabilitiesEntry¶
| Field | Type | Description |
|---|---|---|
| key | string | none |
| value | string | none |
ListImagesRequest¶
Request to list images for specified data service, version.
| Field | Type | Description |
|---|---|---|
| latest | bool | Only include the latest image for each data service version id. |
| data_service_id | string | UID of the data service. |
| data_service_version_id | string | UID of the data service version. |
| sort | public.portworx.common.v1.Sort | Sorting details using which requested list of data service images to be sorted. |
| pagination | public.portworx.common.v1.PageBasedPaginationRequest | Pagination parameters for listing data service images. |
| enabled | ListImagesRequest.Enabled | Filter images based on enabled flag. |
ListImagesResponse¶
Response to list images request.
| Field | Type | Description |
|---|---|---|
| images | repeated Image | List of images. |
| pagination | public.portworx.common.v1.PageBasedPaginationResponse | Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --) |
References¶
References to other resources.
| Field | Type | Description |
|---|---|---|
| data_service_id | string | UID of the Data service. |
| data_service_version_id | string | UID of the Data service version. |
Enums¶
ListImagesRequest.Enabled¶
Enabled indicate either list all, only enabled or only disabled images.
| Name | Number | Description |
|---|---|---|
| ENABLED_UNSPECIFIED | 0 | List all images. |
| TRUE | 1 | List only enabled images. |
| FALSE | 2 | List only disabled images. |