Documentation
¶
Overview ¶
Package docker provides support for HSDP Docker Registry services
Index ¶
- type Client
- type Config
- type Namespace
- type NamespaceAccess
- type NamespaceInput
- type NamespaceUser
- type NamespaceUserResult
- type NamespacesService
- func (s *NamespacesService) AddNamespaceUser(ctx context.Context, namespaceID, username string, ...) (*NamespaceUserResult, error)
- func (s *NamespacesService) CreateNamespace(ctx context.Context, id string) (*Namespace, error)
- func (s *NamespacesService) DeleteNamespace(ctx context.Context, ns Namespace) error
- func (s *NamespacesService) DeleteNamespaceUser(ctx context.Context, namespaceID, userId string) error
- func (s *NamespacesService) GetNamespaceByID(ctx context.Context, id string) (*Namespace, error)
- func (s *NamespacesService) GetNamespaceUsers(ctx context.Context, ns Namespace) (*[]NamespaceUser, error)
- func (s *NamespacesService) GetNamespaces(ctx context.Context) (*[]Namespace, error)
- func (s *NamespacesService) GetRepositories(ctx context.Context, namespaceId string) (*[]Repository, error)
- func (s *NamespacesService) UpdateNamespaceUserAccess(ctx context.Context, id int, access UserNamespaceAccessInput) error
- type OptionFunc
- type RepositoriesService
- func (r *RepositoriesService) CreateRepository(ctx context.Context, repository RepositoryInput, ...) (*RepositoryResult, error)
- func (r *RepositoriesService) DeleteRepository(ctx context.Context, repository Repository) error
- func (r *RepositoriesService) GetLatestTag(ctx context.Context, repositoryId string) (*Tag, error)
- func (r *RepositoriesService) GetRepository(ctx context.Context, namespaceId, name string) (*Repository, error)
- func (r *RepositoriesService) GetTags(ctx context.Context, repositoryId string) (*[]Tag, error)
- func (r *RepositoriesService) UpdateRepository(ctx context.Context, repository Repository, details RepositoryDetailsInput) (*RepositoryDetailsInput, error)
- type Repository
- type RepositoryDetailsInput
- type RepositoryInput
- type RepositoryResult
- type ServiceKey
- type ServiceKeyNode
- type ServiceKeysService
- func (a *ServiceKeysService) CreateServiceKey(ctx context.Context, description string) (*ServiceKey, error)
- func (a *ServiceKeysService) DeleteServiceKey(ctx context.Context, key ServiceKey) error
- func (a *ServiceKeysService) GetServiceKeyByID(ctx context.Context, id int) (*ServiceKeyNode, error)
- func (a *ServiceKeysService) GetServiceKeys(ctx context.Context) (*[]ServiceKeyNode, error)
- type Tag
- type UpdateUserNamespacesAccessInput
- type UserNamespaceAccessInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// HTTP consoleClient used to communicate with IAM API
*console.Client
// User agent used when communicating with the HSDP DICOM API.
UserAgent string
ServiceKeys *ServiceKeysService
Namespaces *NamespacesService
Repositories *RepositoriesService
// contains filtered or unexported fields
}
A Client manages communication with HSDP DICOM API
func NewClient ¶
NewClient returns a new HSDP Docker Registry API client. A configured console client must be provided as the underlying API requires tokens from respective service
type Config ¶
type Config struct {
Region string
DockerAPIURL string
DebugLog io.Writer
// contains filtered or unexported fields
}
Config contains the configuration of a consoleClient
type NamespaceAccess ¶
type NamespaceAccess struct {
ID int `json:"id"`
UserNamespaceAccessInput
}
type NamespaceInput ¶
type NamespaceUser ¶
type NamespaceUser struct {
ID string `json:"id"`
Name string `json:"name"`
Username string `json:"username"`
NamespaceAccess NamespaceAccess `json:"namespaceAccess"`
}
type NamespaceUserResult ¶
type NamespaceUserResult struct {
ID int `json:"id"`
UserID string `json:"userId"`
UserNamespaceAccessInput
}
type NamespacesService ¶
type NamespacesService struct {
// contains filtered or unexported fields
}
func (*NamespacesService) AddNamespaceUser ¶
func (s *NamespacesService) AddNamespaceUser(ctx context.Context, namespaceID, username string, access UserNamespaceAccessInput) (*NamespaceUserResult, error)
func (*NamespacesService) CreateNamespace ¶
func (*NamespacesService) DeleteNamespace ¶
func (s *NamespacesService) DeleteNamespace(ctx context.Context, ns Namespace) error
func (*NamespacesService) DeleteNamespaceUser ¶
func (s *NamespacesService) DeleteNamespaceUser(ctx context.Context, namespaceID, userId string) error
func (*NamespacesService) GetNamespaceByID ¶
func (*NamespacesService) GetNamespaceUsers ¶
func (s *NamespacesService) GetNamespaceUsers(ctx context.Context, ns Namespace) (*[]NamespaceUser, error)
func (*NamespacesService) GetNamespaces ¶
func (s *NamespacesService) GetNamespaces(ctx context.Context) (*[]Namespace, error)
func (*NamespacesService) GetRepositories ¶
func (s *NamespacesService) GetRepositories(ctx context.Context, namespaceId string) (*[]Repository, error)
func (*NamespacesService) UpdateNamespaceUserAccess ¶ added in v0.48.1
func (s *NamespacesService) UpdateNamespaceUserAccess(ctx context.Context, id int, access UserNamespaceAccessInput) error
type OptionFunc ¶
OptionFunc is the function signature function for options
type RepositoriesService ¶
type RepositoriesService struct {
// contains filtered or unexported fields
}
func (*RepositoriesService) CreateRepository ¶
func (r *RepositoriesService) CreateRepository(ctx context.Context, repository RepositoryInput, details RepositoryDetailsInput) (*RepositoryResult, error)
func (*RepositoriesService) DeleteRepository ¶
func (r *RepositoriesService) DeleteRepository(ctx context.Context, repository Repository) error
func (*RepositoriesService) GetLatestTag ¶ added in v0.51.1
GetLatestTag returns the tag that was most recently updated
func (*RepositoriesService) GetRepository ¶
func (r *RepositoriesService) GetRepository(ctx context.Context, namespaceId, name string) (*Repository, error)
func (*RepositoriesService) UpdateRepository ¶
func (r *RepositoriesService) UpdateRepository(ctx context.Context, repository Repository, details RepositoryDetailsInput) (*RepositoryDetailsInput, error)
type Repository ¶
type RepositoryDetailsInput ¶
type RepositoryInput ¶
type RepositoryResult ¶
type ServiceKey ¶
type ServiceKeyNode ¶
type ServiceKeysService ¶
type ServiceKeysService struct {
// contains filtered or unexported fields
}
func (*ServiceKeysService) CreateServiceKey ¶
func (a *ServiceKeysService) CreateServiceKey(ctx context.Context, description string) (*ServiceKey, error)
func (*ServiceKeysService) DeleteServiceKey ¶
func (a *ServiceKeysService) DeleteServiceKey(ctx context.Context, key ServiceKey) error
func (*ServiceKeysService) GetServiceKeyByID ¶
func (a *ServiceKeysService) GetServiceKeyByID(ctx context.Context, id int) (*ServiceKeyNode, error)
func (*ServiceKeysService) GetServiceKeys ¶
func (a *ServiceKeysService) GetServiceKeys(ctx context.Context) (*[]ServiceKeyNode, error)
type UpdateUserNamespacesAccessInput ¶ added in v0.48.1
type UpdateUserNamespacesAccessInput struct {
ID int `json:"id"`
UserNamespaceAccessInput
}
Click to show internal directories.
Click to hide internal directories.