oci

Documentation

Index

• Constants
• func GenOciManifestFromPkg(kclPkg *pkg.KclPkg) (map[string]string, error)
• func Login(hostname, username, password string, setting *settings.Settings) error
• func Logout(hostname string, setting *settings.Settings) error
• func Pull(localPath, hostName, repoName, tag string, settings *settings.Settings) error
• func Push(localPath, hostName, repoName, tag string, settings *settings.Settings) error
• type OciClient
  • func NewOciClient(regName, repoName string, settings *settings.Settings) (*OciClient, error)
  • func (ociClient *OciClient) ContainsTag(tag string) (bool, *reporter.KpmEvent)
  • func (ociClient *OciClient) FetchManifestIntoJsonStr(opts opt.OciFetchOptions) (string, error)
  • func (ociClient *OciClient) GetReference() string
  • func (ociClient *OciClient) Pull(localPath, tag string) error
  • func (ociClient *OciClient) Push(localPath, tag string) *reporter.KpmEvent
  • func (ociClient *OciClient) PushWithOciManifest(localPath, tag string, opts *opt.OciManifestOptions) *reporter.KpmEvent
  • func (ociClient *OciClient) SetLogWriter(writer io.Writer)
  • func (ociClient *OciClient) TheLatestTag() (string, error)

Constants

const DEFAULT_OCI_ARTIFACT_TYPE = "application/vnd.oci.image.layer.v1.tar"

const OCI_SCHEME = "oci"

Functions

func GenOciManifestFromPkg

func GenOciManifestFromPkg(kclPkg *pkg.KclPkg) (map[string]string, error)

GenOciManifestFromPkg will generate the oci manifest from the kcl package.

func Login

func Login(hostname, username, password string, setting *settings.Settings) error

Login will login 'hostname' by 'username' and 'password'.

func Logout

func Logout(hostname string, setting *settings.Settings) error

Logout will logout from registry.

func Pull

func Pull(localPath, hostName, repoName, tag string, settings *settings.Settings) error

Pull will pull the oci artifacts from oci registry to local path.

func Push

func Push(localPath, hostName, repoName, tag string, settings *settings.Settings) error

Push will push the oci artifacts to oci registry from local path

Types

type OciClient

type OciClient struct {
	// contains filtered or unexported fields
}

OciClient is mainly responsible for interacting with OCI registry

func NewOciClient

func NewOciClient(regName, repoName string, settings *settings.Settings) (*OciClient, error)

NewOciClient will new an OciClient. regName is the registry. e.g. ghcr.io or docker.io. repoName is the repo name on registry.

func (*OciClient) ContainsTag

func (ociClient *OciClient) ContainsTag(tag string) (bool, *reporter.KpmEvent)

ContainsTag will check if the tag exists in the repo.

func (*OciClient) FetchManifestIntoJsonStr

func (ociClient *OciClient) FetchManifestIntoJsonStr(opts opt.OciFetchOptions) (string, error)

FetchManifestByRef will fetch the manifest and return it into json string.

func (*OciClient) GetReference

func (ociClient *OciClient) GetReference() string

func (*OciClient) Pull

func (ociClient *OciClient) Pull(localPath, tag string) error

Pull will pull the oci artifacts from oci registry to local path.

func (*OciClient) Push

func (ociClient *OciClient) Push(localPath, tag string) *reporter.KpmEvent

Push will push the oci artifacts to oci registry from local path

func (*OciClient) PushWithOciManifest

func (ociClient *OciClient) PushWithOciManifest(localPath, tag string, opts *opt.OciManifestOptions) *reporter.KpmEvent

PushWithManifest will push the oci artifacts to oci registry from local path

func (*OciClient) SetLogWriter

func (ociClient *OciClient) SetLogWriter(writer io.Writer)

func (*OciClient) TheLatestTag

func (ociClient *OciClient) TheLatestTag() (string, error)

TheLatestTag will return the latest tag of the kcl packages.