module V1::Remote
Overview
Module Remote provides facilities for reading/writing v1.Images from/to a remote image registry.
Extended Modules
Defined in:
v1/remote/write.crv1/remote/descriptor.cr
v1/remote/image.cr
v1/remote/index.cr
v1/remote/list.cr
v1/remote/mount.cr
v1/remote/options.cr
v1/remote/remote.cr
Constant Summary
-
DEFAULT_PLATFORM =
V1::Platform.new(architecture: "amd64", os: "linux")
Instance Method Summary
-
#delete(ref : Name::References, *options : Option) : Nil
delete removes the specified image reference from the remote registry.
-
#get(ref : Name::References, *options : Option)
Get returns a remote.Descriptor for the given reference.
-
#image(ref : Name::References, *options : Option) : V1::Image
image provides access to remote image reference.
-
#index(ref : Name::References, *options : Option)
Index provides access to a remote index reference.
-
#list(repo : Name::Repository, *opts : Option)
List calls /tags/list for the given repository, returning the list of tags in the "tags" property.
- #scopes_for_uploading_image(ref : Name::References, layers : Array(V1::Layer))
-
#with_auth(auth : Authn::Authenticator)
functional option for overriding the default authenticator for remove operations The default authenticator is Authn::Anonymous
-
#with_auth_from_keychain(keys : Authn::Keychain)
functional option for overriding the default authenticator for remote operations, using an Authn::KeyChain to find credentials
-
#with_platform(p : V1::Platform)
a functional option for overriding the default platform that Image and Descriptor.Image use for resolving an index to an image.
-
#with_transport(t : Cossack::Client)
functional option for overriding default transport for remote operations
-
#write(ref : Name::References, img : V1::Image, *options : Option)
write pushes the provided img to the specified image reference
-
#write_index(ref : Name::References, ii : V1::ImageIndex, *options : Option)
write_index pushes the provided ImageIndex to the specified image reference.
Instance Method Detail
delete removes the specified image reference from the remote registry.
Get returns a remote.Descriptor for the given reference. The response from the registry is left un-interpreted, for the most part. This is useful for querying what kind of artifact a reference represents.
image provides access to remote image reference.
Index provides access to a remote index reference.
List calls /tags/list for the given repository, returning the list of tags in the "tags" property.
functional option for overriding the default authenticator for remove operations The default authenticator is Authn::Anonymous
functional option for overriding the default authenticator for remote operations, using an Authn::KeyChain to find credentials
The default authenticator is Authn::Anonymous
a functional option for overriding the default platform that Image and Descriptor.Image use for resolving an index to an image.
The default platform is amd64/linux
functional option for overriding default transport for remote operations
write pushes the provided img to the specified image reference
write_index pushes the provided ImageIndex to the specified image reference. write_index will attempt to push all of the referenced manifests before attempting to push the ImageIndex, to retain referential integrity.