registry

Documentation

Index

• func GetRegistryAddress(ctx context.Context, c client.Client) (*string, error)
• type Auth
  • func (a Auth) GenerateDockerConfig() ([]byte, error)
  • func (a Auth) IsSet() bool
• type DockerConfig
• type DockerConfigList
• type LocalRegistryHostingV1

Functions

func GetRegistryAddress

func GetRegistryAddress(ctx context.Context, c client.Client) (*string, error)

GetRegistryAddress KEP-1755 https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/generic/1755-communicating-a-local-registry

Types

type Auth

type Auth struct {
	Server   string
	Username string
	Password string

	// additional information
	Registry string
}

Auth contains basic information for authenticating against a container registry.

func (Auth) GenerateDockerConfig

func (a Auth) GenerateDockerConfig() ([]byte, error)

GenerateDockerConfig generates a Docker compatible config.json file.

func (Auth) IsSet

func (a Auth) IsSet() bool

IsSet returns if information has been set on the object.

type DockerConfig

type DockerConfig struct {
	Auth     string `json:"auth,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type DockerConfigList

type DockerConfigList struct {
	Auths map[string]DockerConfig `json:"auths,omitempty"`
}

type LocalRegistryHostingV1

type LocalRegistryHostingV1 struct {
	// Host documents the host (hostname and port) of the registry, as seen from
	// outside the cluster.
	//
	// This is the registry host that tools outside the cluster should push images
	// to.
	Host string `yaml:"host,omitempty"`

	// HostFromClusterNetwork documents the host (hostname and port) of the
	// registry, as seen from networking inside the container pods.
	//
	// This is the registry host that tools running on pods inside the cluster
	// should push images to. If not set, then tools inside the cluster should
	// assume the local registry is not available to them.
	HostFromClusterNetwork string `yaml:"hostFromClusterNetwork,omitempty"`

	// HostFromContainerRuntime documents the host (hostname and port) of the
	// registry, as seen from the cluster's container runtime.
	//
	// When tools apply Kubernetes objects to the cluster, this host should be
	// used for image name fields. If not set, users of this field should use the
	// value of Host instead.
	//
	// Note that it doesn't make sense semantically to define this field, but not
	// define Host or HostFromClusterNetwork. That would imply a way to pull
	// images without a way to push images.
	HostFromContainerRuntime string `yaml:"hostFromContainerRuntime,omitempty"`

	// Help contains a URL pointing to documentation for users on how to set
	// up and configure a local registry.
	//
	// Tools can use this to nudge users to enable the registry. When possible,
	// the writer should use as permanent a URL as possible to prevent drift
	// (e.g., a version control SHA).
	//
	// When image pushes to a registry host specified in one of the other fields
	// fail, the tool should display this help URL to the user. The help URL
	// should contain instructions on how to diagnose broken or misconfigured
	// registries.
	Help string `yaml:"help,omitempty"`
}

Copied from https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/generic/1755-communicating-a-local-registry LocalRegistryHostingV1 describes a local registry that developer tools can connect to. A local registry allows clients to load images into the local cluster by pushing to this registry.