crproxy

README

CRProxy (Container Registry Proxy)

CRProxy is a generic image proxy

Add the prefix m.daocloud.io/ to all places that need to use images

• English
• 简体中文

m.daocloud.io

you can deploy your own image proxy server if you need to.

Refer to

crproxy + registry(pull through cache mode)

• for organizations and companies which need to serve big clusters
• container-image-mirror
  • deploy into k8s with argocd
  • storage with pvc, s3(minio/oss compatible)
  • bind ssl with cert-manager and ingress

On Docker

Just add the prefix m.daocloud.io/

docker pull m.daocloud.io/docker.io/library/busybox

On Kubernetes

Just add the prefix m.daocloud.io/

image: m.daocloud.io/docker.io/library/busybox

Documentation

Index

• func GetSleepDuration(s geario.B, limit geario.B, r time.Duration) time.Duration
• type BlockInfo
• type CRProxy
  • func NewCRProxy(opts ...Option) (*CRProxy, error)
  • func (c *CRProxy) AuthToken(rw http.ResponseWriter, r *http.Request)
  • func (c *CRProxy) ServeHTTP(rw http.ResponseWriter, r *http.Request)
  • func (c *CRProxy) Sync(rw http.ResponseWriter, r *http.Request)
  • func (c *CRProxy) SyncImageLayer(ctx context.Context, ip, image string, ...) error
• type ImageInfo
• type InfoCtxValue
  • func GetCtxValue(ctx context.Context) *InfoCtxValue
• type Logger
• type Option
  • func WithAllowHeadMethod(allowHeadMethod bool) Option
  • func WithBaseClient(baseClient *http.Client) Option
  • func WithBlobsSpeedLimit(limit geario.B, duration time.Duration) Option
  • func WithBlockFunc(blockFunc func(info *BlockInfo) (string, bool)) Option
  • func WithDefaultRegistry(target string) Option
  • func WithDisableKeepAlives(disableKeepAlives []string) Option
  • func WithDisableTagsList(b bool) Option
  • func WithDomainAlias(domainAlias map[string]string) Option
  • func WithIPsSpeedLimit(limit geario.B, duration time.Duration) Option
  • func WithLimitDelay(b bool) Option
  • func WithLinkExpires(d time.Duration) Option
  • func WithLogger(logger Logger) Option
  • func WithManifestCacheDuration(d time.Duration) Option
  • func WithMaxClientSizeForEachRegistry(clientSize int) Option
  • func WithOverrideDefaultRegistry(overrideDefaultRegistry map[string]string) Option
  • func WithPathInfoModifyFunc(modify func(info *ImageInfo) *ImageInfo) Option
  • func WithPrivilegedFunc(f func(r *http.Request, info *ImageInfo) bool) Option
  • func WithPrivilegedNoAuth(b bool) Option
  • func WithRedirectLinks(l *url.URL) Option
  • func WithRedirectToOriginBlobFunc(f func(r *http.Request, info *ImageInfo) bool) Option
  • func WithRetry(retry int, retryInterval time.Duration) Option
  • func WithSimpleAuth(b bool, tokenURL string, forceTLS bool) Option
  • func WithSimpleAuthUserFunc(f func(r *http.Request, userinfo *url.Userinfo) bool) Option
  • func WithStorageDriver(storageDriver storagedriver.StorageDriver) Option
  • func WithTotalBlobsSpeedLimit(limit geario.B) Option
  • func WithUserAndPass(userAndPass map[string]Userpass) Option
• type PathInfo
  • func ParseOriginPathInfo(path string, defaultRegistry string) (*PathInfo, bool)
  • func (p PathInfo) Path() (string, error)
• type SyncProgress
• type Token
• type Userpass

Functions

func GetSleepDuration

func GetSleepDuration(s geario.B, limit geario.B, r time.Duration) time.Duration

Types

type BlockInfo

type BlockInfo struct {
	IP   string
	Host string
	Name string
}

type CRProxy

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

func NewCRProxy

func NewCRProxy(opts ...Option) (*CRProxy, error)

func (*CRProxy) AuthToken

func (c *CRProxy) AuthToken(rw http.ResponseWriter, r *http.Request)

func (*CRProxy) ServeHTTP

func (c *CRProxy) ServeHTTP(rw http.ResponseWriter, r *http.Request)

func (*CRProxy) Sync

func (c *CRProxy) Sync(rw http.ResponseWriter, r *http.Request)

func (*CRProxy) SyncImageLayer

func (c *CRProxy) SyncImageLayer(ctx context.Context, ip, image string, filter func(pf manifestlist.PlatformSpec) bool, cb func(sp SyncProgress) error) error

type ImageInfo

type ImageInfo struct {
	Host string
	Name string
}

type InfoCtxValue

type InfoCtxValue struct {
	LastRedirect string
}

func GetCtxValue

func GetCtxValue(ctx context.Context) *InfoCtxValue

type Logger

type Logger interface {
	Println(v ...interface{})
}

type Option

type Option func(c *CRProxy)

func WithAllowHeadMethod

func WithAllowHeadMethod(allowHeadMethod bool) Option

func WithBaseClient

func WithBaseClient(baseClient *http.Client) Option

func WithBlobsSpeedLimit

func WithBlobsSpeedLimit(limit geario.B, duration time.Duration) Option

func WithBlockFunc

func WithBlockFunc(blockFunc func(info *BlockInfo) (string, bool)) Option

func WithDefaultRegistry

func WithDefaultRegistry(target string) Option

func WithDisableKeepAlives

func WithDisableKeepAlives(disableKeepAlives []string) Option

func WithDisableTagsList

func WithDisableTagsList(b bool) Option

func WithDomainAlias

func WithDomainAlias(domainAlias map[string]string) Option

func WithIPsSpeedLimit

func WithIPsSpeedLimit(limit geario.B, duration time.Duration) Option

func WithLimitDelay

func WithLimitDelay(b bool) Option

func WithLinkExpires

func WithLinkExpires(d time.Duration) Option

func WithLogger

func WithLogger(logger Logger) Option

func WithManifestCacheDuration

func WithManifestCacheDuration(d time.Duration) Option

func WithMaxClientSizeForEachRegistry

func WithMaxClientSizeForEachRegistry(clientSize int) Option

func WithOverrideDefaultRegistry

func WithOverrideDefaultRegistry(overrideDefaultRegistry map[string]string) Option

func WithPathInfoModifyFunc

func WithPathInfoModifyFunc(modify func(info *ImageInfo) *ImageInfo) Option

func WithPrivilegedFunc

func WithPrivilegedFunc(f func(r *http.Request, info *ImageInfo) bool) Option

func WithPrivilegedNoAuth

func WithPrivilegedNoAuth(b bool) Option

func WithRedirectLinks

func WithRedirectLinks(l *url.URL) Option

func WithRedirectToOriginBlobFunc

func WithRedirectToOriginBlobFunc(f func(r *http.Request, info *ImageInfo) bool) Option

func WithRetry

func WithRetry(retry int, retryInterval time.Duration) Option

func WithSimpleAuth

func WithSimpleAuth(b bool, tokenURL string, forceTLS bool) Option

func WithSimpleAuthUserFunc

func WithSimpleAuthUserFunc(f func(r *http.Request, userinfo *url.Userinfo) bool) Option

func WithStorageDriver

func WithStorageDriver(storageDriver storagedriver.StorageDriver) Option

func WithTotalBlobsSpeedLimit

func WithTotalBlobsSpeedLimit(limit geario.B) Option

func WithUserAndPass

func WithUserAndPass(userAndPass map[string]Userpass) Option

type PathInfo

type PathInfo struct {
	Host  string
	Image string

	TagsList  bool
	Manifests string
	Blobs     string
}

func ParseOriginPathInfo

func ParseOriginPathInfo(path string, defaultRegistry string) (*PathInfo, bool)

func (PathInfo) Path

func (p PathInfo) Path() (string, error)

type SyncProgress

type SyncProgress struct {
	Digest   string                     `json:"digest,omitempty"`
	Size     int64                      `json:"size,omitempty"`
	Status   string                     `json:"status,omitempty"`
	Platform *manifestlist.PlatformSpec `json:"platform,omitempty"`
}

type Token

type Token struct {
	ExpiresAt time.Time `json:"expires_at,omitempty"`
	Scope     string    `json:"scope,omitempty"`
	Service   string    `json:"service,omitempty"`
}

type Userpass

type Userpass struct {
	Username string
	Password string
}