roboto.image_registry#

Submodules#

Package Contents#

class roboto.image_registry.ContainerCredentials(/, **data)#

Bases: pydantic.BaseModel

Credentials used by a container

Parameters:

data (Any)

expiration: datetime.datetime#
is_expired()#
Return type:

bool

password: str#
registry_url: str#
to_dict()#
Return type:

dict[str, Any]

username: str#
class roboto.image_registry.ContainerImageRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a container image.

Parameters:

data (Any)

image_tag: str#
image_uri: str#
org_id: str#
repository_name: str#
class roboto.image_registry.ContainerImageRepositoryRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a container image repository.

Parameters:

data (Any)

arn: str#
org_id: str#
repository_name: str#
repository_uri: str#
class roboto.image_registry.ContainerUploadCredentials(/, **data)#

Bases: pydantic.BaseModel

Container upload credentials

Parameters:

data (Any)

image_uri: str#
password: str#
registry_url: str#
username: str#
class roboto.image_registry.CreateImageRepositoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create an image repository

Parameters:

data (Any)

immutable_image_tags: bool#
repository_name: str#
class roboto.image_registry.CreateImageRepositoryResponse(/, **data)#

Bases: pydantic.BaseModel

Response payload to create an image repository

Parameters:

data (Any)

repository_name: str#
repository_uri: str#
class roboto.image_registry.DeleteImageRepositoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to delete an image repository

Parameters:

data (Any)

force: bool = False#

Delete all images in the repository before deleting the repository if the repository is not empty.

repository_name: str#

The name of the repository to delete.

class roboto.image_registry.DeleteImageRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to delete an image

Parameters:

data (Any)

image_uri: str#
class roboto.image_registry.ImageRegistry(roboto_client)#
Parameters:

roboto_client (roboto.http.RobotoClient)

create_repository(repository_name, immutable_image_tags=False, org_id=None)#

Create a repository for a container image in Roboto’s private image registry. Images with different tags can be pushed to the same repository.

Parameters:
  • repository_name (str) – The name of the repository to create.

  • immutable_image_tags (bool) – Whether to allow image tags to be overwritten. If set to True, then any attempt to overwrite an existing image tag will error.

  • org_id (Optional[str])

Returns:

A dictionary contains the repository_name and repository_uri of the created repository.

Return type:

ImageRepository

delete_image(image_uri, org_id=None)#

Delete a container image from Roboto’s private registry.

Parameters:
  • image_uri (str) – The full URI of the image to delete.

  • org_id (Optional[str]) – ID of organization owning the provided image.

Return type:

None

delete_repository(repository_name, org_id=None, force=False)#

Delete a container image from Roboto’s private registry.

Parameters:
  • repository_name (str) – The name of the repository to delete.

  • org_id (Optional[str]) – ID of organization owning the provided image.

  • force (bool) – Delete all images in the repository before deleting the repository if the repository is not empty.

Return type:

None

get_container_image_record(org_id, image_uri)#
Parameters:
  • org_id (str)

  • image_uri (str)

Return type:

roboto.image_registry.record.ContainerImageRecord

get_temporary_credentials(repository_uri, permissions=Permissions.ReadOnly, org_id=None)#
Parameters:
Return type:

ContainerCredentials

list_images(repository_name=None, page_token=None, org_id=None)#
Parameters:
  • repository_name (Optional[str])

  • page_token (Optional[str])

  • org_id (Optional[str])

Return type:

roboto.http.PaginatedList[roboto.image_registry.record.ContainerImageRecord]

list_repositories(page_token=None, org_id=None)#
Parameters:
  • page_token (Optional[str])

  • org_id (Optional[str])

Return type:

roboto.http.PaginatedList[roboto.image_registry.record.ContainerImageRepositoryRecord]

repository_contains_image(repository_name, image_tag, org_id=None)#
Parameters:
  • repository_name (str)

  • image_tag (str)

  • org_id (Optional[str])

Return type:

bool

class roboto.image_registry.ImageRepository#

Bases: TypedDict

Image repository details

repository_name: str#
repository_uri: str#
class roboto.image_registry.RepositoryContainsImageResponse(/, **data)#

Bases: pydantic.BaseModel

Response payload to repository contains image

Parameters:

data (Any)

contains_image: bool#
class roboto.image_registry.RepositoryPurpose#

Bases: enum.Enum

Repository purpose enum

Executor = 'executor'#
class roboto.image_registry.RepositoryTag#

Bases: enum.Enum

Repository tag enum

CreatedBy = 'created_by'#
OrgId = 'org_id'#
Purpose = 'purpose'#
class roboto.image_registry.SetImageRepositoryImmutableTagsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to set image repository tags

Parameters:

data (Any)

immutable_image_tags: bool#
repository_name: str#