harbor_api

Documentation

Overview

Package harbor_api

Index

• Constants
• func NewProjectReq(reqCfg ProjectReqConfig) *models.ProjectReq
• func UnwrapErr[T any](v T, err error) (T, error)
• type ArtifactCopyTagGet
• type ArtifactURI
  • func (a ArtifactURI) String() string
• type Client
  • func New(harborRegistry string, harborInsecure bool, ...) (*Client, error)
  • func (c *Client) AdminCreateUser(userCreationReq *models.UserCreationReq) (*user.CreateUserCreated, error)
  • func (c *Client) AdminDeleteUser(userID int64) (*user.DeleteUserOK, error)
  • func (c *Client) ArtifactCopyTagGet(toURI, fromURI ArtifactURI) (resp ArtifactCopyTagGet, err error)
  • func (c *Client) CopyArtifact(toArtifactURI, fromArtifactURI ArtifactURI) (*artifact.CopyArtifactCreated, error)
  • func (c *Client) CreateAdmin(userCreationReq *models.UserCreationReq) (*user.CreateUserCreated, error)
  • func (c *Client) CreateArtifactTag(toArtifactURI, fromArtifactURI ArtifactURI) (*artifact.CreateTagCreated, error)
  • func (c *Client) CreateProject(projectReqConfig ProjectReqConfig) (*project.CreateProjectCreated, error)
  • func (c *Client) DeleteAdmin(userID int64) (*user.DeleteUserOK, error)
  • func (c *Client) DeleteArtifact(artifactURI ArtifactURI) (*artifact.DeleteArtifactOK, error)
  • func (c *Client) DeleteArtifactTag(artifactURI ArtifactURI) (*artifact.DeleteTagOK, error)
  • func (c *Client) DeleteProject(projectNameOrID string) (*project.DeleteProjectOK, error)
  • func (c *Client) DeleteRepository(projectName, repositoryName string) (*repository.DeleteRepositoryOK, error)
  • func (c *Client) GC(gcFn ...util.Func)
  • func (c *Client) GetArtifact(artifactURI ArtifactURI) (*artifact.GetArtifactOK, error)
  • func (c *Client) GetProject(projectNameOrID string) (*project.GetProjectOK, error)
  • func (c *Client) GetRepository(projectName, repositoryName string) (*repository.GetRepositoryOK, error)
  • func (c *Client) ListArtifactTags(artifactURI ArtifactURI, queryStr string) (*artifact.ListTagsOK, error)
  • func (c *Client) ListArtifacts(artifactURI ArtifactURI) (*artifact.ListArtifactsOK, error)
  • func (c *Client) ListProjects(public bool) (*project.ListProjectsOK, error)
  • func (c *Client) ListRepositories(projectName string) (*repository.ListRepositoriesOK, error)
  • func (c *Client) Ping() (*ping.GetPingOK, error)
  • func (c *Client) UpdateProjectStorageLimit(reqCfg *ProjectReqConfig) (*project.UpdateProjectOK, error)
  • func (c *Client) WithContext(ctx context.Context) *Client
  • func (c *Client) WithHttpClient(httpCli *http.Client) *Client
  • func (c *Client) WithPageConfig(pCfg *util.Page) *Client
  • func (c *Client) WithTimeout(httpTimeout time.Duration) *Client
• type ProjectReqConfig

Constants

const (
	ProjectNoStorageLimit int64 = -1
)

Functions

func NewProjectReq

func NewProjectReq(reqCfg ProjectReqConfig) *models.ProjectReq

func UnwrapErr

func UnwrapErr[T any](v T, err error) (T, error)

Types

type ArtifactCopyTagGet

type ArtifactCopyTagGet struct {
	*artifact.CopyArtifactCreated
	*artifact.CreateTagCreated
	*artifact.GetArtifactOK
}

type ArtifactURI

type ArtifactURI struct {
	Project    string
	Repository string
	Tag        string
	Digest     string
}

func (ArtifactURI) String

func (a ArtifactURI) String() string

Example: library/s3fstest:latest

type Client

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

func New

func New(
	harborRegistry string,
	harborInsecure bool,
	harborUsername,
	harborPassword string) (*Client, error)

func (*Client) AdminCreateUser

func (c *Client) AdminCreateUser(userCreationReq *models.UserCreationReq) (*user.CreateUserCreated, error)

func (*Client) AdminDeleteUser

func (c *Client) AdminDeleteUser(userID int64) (*user.DeleteUserOK, error)

func (*Client) ArtifactCopyTagGet

func (c *Client) ArtifactCopyTagGet(toURI, fromURI ArtifactURI) (resp ArtifactCopyTagGet, err error)

func (*Client) CopyArtifact

func (c *Client) CopyArtifact(toArtifactURI, fromArtifactURI ArtifactURI) (*artifact.CopyArtifactCreated, error)

func (*Client) CreateAdmin

func (c *Client) CreateAdmin(userCreationReq *models.UserCreationReq) (*user.CreateUserCreated, error)

func (*Client) CreateArtifactTag

func (c *Client) CreateArtifactTag(toArtifactURI, fromArtifactURI ArtifactURI) (*artifact.CreateTagCreated, error)

func (*Client) CreateProject

func (c *Client) CreateProject(projectReqConfig ProjectReqConfig) (*project.CreateProjectCreated, error)

CreateProject preserve a project named: public create new project for each user by a specified name restrict the quota of each user

func (*Client) DeleteAdmin

func (c *Client) DeleteAdmin(userID int64) (*user.DeleteUserOK, error)

func (*Client) DeleteArtifact

func (c *Client) DeleteArtifact(artifactURI ArtifactURI) (*artifact.DeleteArtifactOK, error)

func (*Client) DeleteArtifactTag

func (c *Client) DeleteArtifactTag(artifactURI ArtifactURI) (*artifact.DeleteTagOK, error)

func (*Client) DeleteProject

func (c *Client) DeleteProject(projectNameOrID string) (*project.DeleteProjectOK, error)

func (*Client) DeleteRepository

func (c *Client) DeleteRepository(projectName, repositoryName string) (*repository.DeleteRepositoryOK, error)

func (*Client) GC

func (c *Client) GC(gcFn ...util.Func)

func (*Client) GetArtifact

func (c *Client) GetArtifact(artifactURI ArtifactURI) (*artifact.GetArtifactOK, error)

func (*Client) GetProject

func (c *Client) GetProject(projectNameOrID string) (*project.GetProjectOK, error)

func (*Client) GetRepository

func (c *Client) GetRepository(projectName, repositoryName string) (*repository.GetRepositoryOK, error)

func (*Client) ListArtifactTags

func (c *Client) ListArtifactTags(artifactURI ArtifactURI, queryStr string) (*artifact.ListTagsOK, error)

func (*Client) ListArtifacts

func (c *Client) ListArtifacts(artifactURI ArtifactURI) (*artifact.ListArtifactsOK, error)

func (*Client) ListProjects

func (c *Client) ListProjects(public bool) (*project.ListProjectsOK, error)

func (*Client) ListRepositories

func (c *Client) ListRepositories(projectName string) (*repository.ListRepositoriesOK, error)

func (*Client) Ping

func (c *Client) Ping() (*ping.GetPingOK, error)

func (*Client) UpdateProjectStorageLimit

func (c *Client) UpdateProjectStorageLimit(reqCfg *ProjectReqConfig) (*project.UpdateProjectOK, error)

func (*Client) WithContext

func (c *Client) WithContext(ctx context.Context) *Client

func (*Client) WithHttpClient

func (c *Client) WithHttpClient(httpCli *http.Client) *Client

func (*Client) WithPageConfig

func (c *Client) WithPageConfig(pCfg *util.Page) *Client

func (*Client) WithTimeout

func (c *Client) WithTimeout(httpTimeout time.Duration) *Client

type ProjectReqConfig

type ProjectReqConfig struct {
	MetaDataPublic string
	ProjectName    string
	RegistryId     int64
	StorageLimit   int64
}