types

package
v0.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package types catalogs github.com/moby/moby/api/types/registry for wrapping by containerkit.

Code generated by go run ./tools/gencatalog; DO NOT EDIT.

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry

Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/registry/types), not in renamed aliases.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthConfig

type AuthConfig = registry.AuthConfig

AuthConfig wraps registry.AuthConfig.

AuthConfig contains authorization information for connecting to a Registry.

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#AuthConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/authconfig.go Kind: struct Usecase: wrap the Engine API type AuthConfig from registry.

type AuthResponse

type AuthResponse = registry.AuthResponse

AuthResponse wraps registry.AuthResponse.

AuthResponse An identity token was generated successfully.

swagger:model AuthResponse

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#AuthResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/auth_response.go Kind: struct Usecase: wrap the Engine API type AuthResponse from registry.

type DistributionInspect

type DistributionInspect = registry.DistributionInspect

DistributionInspect wraps registry.DistributionInspect.

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

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#DistributionInspect GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/registry.go Kind: struct References: github.com/opencontainers/image-spec/specs-go/v1.Descriptor, github.com/opencontainers/image-spec/specs-go/v1.Platform Usecase: wrap the Engine API type DistributionInspect from registry.

type IndexInfo

type IndexInfo = registry.IndexInfo

IndexInfo wraps registry.IndexInfo.

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,
}

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#IndexInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/registry.go Kind: struct Usecase: wrap the Engine API type IndexInfo from registry.

type RequestAuthConfig

type RequestAuthConfig = registry.RequestAuthConfig

RequestAuthConfig wraps registry.RequestAuthConfig.

RequestAuthConfig is a function interface that clients can supply to retry operations after getting an authorization error.

The function must return the [AuthHeader] value (AuthConfig), encoded in base64url format (RFC4648, section 5), which can be decoded by [DecodeAuthConfig].

It must return an error if the privilege request fails.

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#RequestAuthConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/authconfig.go Kind: func Underlying: func(context.Context) (string, error) References: context.Context Usecase: wrap the Engine API type RequestAuthConfig from registry.

type SearchResult

type SearchResult = registry.SearchResult

SearchResult wraps registry.SearchResult.

SearchResult describes a search result returned from a registry

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#SearchResult GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/search.go Kind: struct Usecase: wrap the Engine API type SearchResult from registry.

type SearchResults

type SearchResults = registry.SearchResults

SearchResults wraps registry.SearchResults.

SearchResults lists a collection search results returned from a registry

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#SearchResults GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/search.go Kind: struct Usecase: wrap the Engine API type SearchResults from registry.

type ServiceConfig

type ServiceConfig = registry.ServiceConfig

ServiceConfig wraps registry.ServiceConfig.

ServiceConfig stores daemon registry services configuration.

Source: https://pkg.go.dev/github.com/moby/moby/api/types/registry#ServiceConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/registry/registry.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type ServiceConfig from registry.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL