registry

Documentation

Index

• type AuthenticateOKBody
• type DistributionInspect
• type IndexInfo
• type NetIPNet
  • func (ipnet *NetIPNet) MarshalJSON() ([]byte, error)
  • func (ipnet *NetIPNet) String() string
  • func (ipnet *NetIPNet) UnmarshalJSON(b []byte) (err error)
• type SearchResult
• type SearchResults
• type ServiceConfig

Types

type AuthenticateOKBody

type AuthenticateOKBody struct {

	// An opaque token used to authenticate a user after a successful login
	// Required: true
	IdentityToken string `json:"IdentityToken"`

	// The status of the authentication
	// Required: true
	Status string `json:"Status"`
}

AuthenticateOKBody authenticate o k body swagger:model AuthenticateOKBody

type DistributionInspect

type DistributionInspect struct {
	// Descriptor contains information about the manifest, including
	// the content addressable digest
	Descriptor v1.Descriptor
	// Platforms contains the list of platforms supported by the image,
	// obtained by parsing the manifest
	Platforms []v1.Platform
}

DistributionInspect describes the result obtained from contacting the registry to retrieve image metadata

type IndexInfo

type IndexInfo struct {
	// Name is the name of the registry, such as "docker.io"
	Name string
	// Mirrors is a list of mirrors, expressed as URIs
	Mirrors []string
	// Secure is set to false if the registry is part of the list of
	// insecure registries. Insecure registries accept HTTP and/or accept
	// HTTPS with certificates from unknown CAs.
	Secure bool
	// Official indicates whether this is an official registry
	Official bool
}

IndexInfo contains information about a registry

RepositoryInfo Examples:

{
  "Index" : {
    "Name" : "docker.io",
    "Mirrors" : ["https://registry-2.docker.io/v1/", "https://registry-3.docker.io/v1/"],
    "Secure" : true,
    "Official" : true,
  },
  "RemoteName" : "library/debian",
  "LocalName" : "debian",
  "CanonicalName" : "docker.io/debian"
  "Official" : true,
}

{
  "Index" : {
    "Name" : "127.0.0.1:5000",
    "Mirrors" : [],
    "Secure" : false,
    "Official" : false,
  },
  "RemoteName" : "user/repo",
  "LocalName" : "127.0.0.1:5000/user/repo",
  "CanonicalName" : "127.0.0.1:5000/user/repo",
  "Official" : false,
}

type NetIPNet

type NetIPNet net.IPNet

NetIPNet is the net.IPNet type, which can be marshalled and unmarshalled to JSON

func (*NetIPNet) MarshalJSON

func (ipnet *NetIPNet) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON representation of the IPNet

func (*NetIPNet) String

func (ipnet *NetIPNet) String() string

String returns the CIDR notation of ipnet

func (*NetIPNet) UnmarshalJSON

func (ipnet *NetIPNet) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON sets the IPNet from a byte array of JSON

type SearchResult

type SearchResult struct {
	// StarCount indicates the number of stars this repository has
	StarCount int `json:"star_count"`
	// IsOfficial is true if the result is from an official repository.
	IsOfficial bool `json:"is_official"`
	// Name is the name of the repository
	Name string `json:"name"`
	// IsAutomated indicates whether the result is automated
	IsAutomated bool `json:"is_automated"`
	// Description is a textual description of the repository
	Description string `json:"description"`
}

SearchResult describes a search result returned from a registry

type SearchResults

type SearchResults struct {
	// Query contains the query string that generated the search results
	Query string `json:"query"`
	// NumResults indicates the number of results the query returned
	NumResults int `json:"num_results"`
	// Results is a slice containing the actual results for the search
	Results []SearchResult `json:"results"`
}

SearchResults lists a collection search results returned from a registry

type ServiceConfig

type ServiceConfig struct {
	AllowNondistributableArtifactsCIDRs     []*NetIPNet
	AllowNondistributableArtifactsHostnames []string
	InsecureRegistryCIDRs                   []*NetIPNet           `json:"InsecureRegistryCIDRs"`
	IndexConfigs                            map[string]*IndexInfo `json:"IndexConfigs"`
	Mirrors                                 []string
}

ServiceConfig stores daemon registry services configuration.