discovery

package
Version: v0.8.11 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2017 License: Apache-2.0 Imports: 15 Imported by: 95

Documentation

Overview

Package discovery contains an experimental implementation of the Image Discovery section of the appc specification.

Index

Constants

This section is empty.

Variables

View Source
var (
	// Client is the default http.Client used for discovery requests.
	Client            *http.Client
	ClientInsecureTLS *http.Client
)

Functions

func DiscoverACIEndpoints added in v0.8.0

func DiscoverACIEndpoints(app App, hostHeaders map[string]http.Header, insecure InsecureOption, port uint) (ACIEndpoints, []FailedAttempt, error)

DiscoverACIEndpoints will make HTTPS requests to find the ac-discovery meta tags and optionally will use HTTP if insecure is set. hostHeaders specifies the header to apply depending on the host (e.g. authentication). It will not give up until it has exhausted the path or found an image discovery. If port is 0, the default port will be used.

func DiscoverPublicKeys added in v0.4.0

func DiscoverPublicKeys(app App, hostHeaders map[string]http.Header, insecure InsecureOption, port uint) (PublicKeys, []FailedAttempt, error)

DiscoverPublicKey will make HTTPS requests to find the ac-public-keys meta tags and optionally will use HTTP if insecure is set. hostHeaders specifies the header to apply depending on the host (e.g. authentication). It will not give up until it has exhausted the path or found an public key. If port is 0, the default port will be used.

func DiscoverWalk added in v0.4.0

func DiscoverWalk(app App, hostHeaders map[string]http.Header, insecure InsecureOption, port uint, discoverFn DiscoverWalkFunc) (dd *discoveryData, err error)

DiscoverWalk will make HTTPS requests to find discovery meta tags and optionally will use HTTP if insecure is set. hostHeaders specifies the header to apply depending on the host (e.g. authentication). Based on the response of the discoverFn it will continue to recurse up the tree. If port is 0, the default port will be used.

Types

type ACIEndpoint added in v0.3.0

type ACIEndpoint struct {
	ACI string
	ASC string
}

type ACIEndpoints added in v0.8.0

type ACIEndpoints []ACIEndpoint

type App

type App struct {
	Name   types.ACIdentifier
	Labels map[types.ACIdentifier]string
}

func NewApp

func NewApp(name string, labels map[types.ACIdentifier]string) (*App, error)

func NewAppFromString

func NewAppFromString(app string) (*App, error)

NewAppFromString takes a command line app parameter and returns a map of labels.

Example app parameters:

example.com/reduce-worker:1.0.0
example.com/reduce-worker,channel=alpha,label=value
example.com/reduce-worker:1.0.0,label=value

As can be seen in above examples - colon, comma and equal sign have special meaning. If any of them has to be a part of a label's value then consider writing your own string to App parser.

func (*App) Copy added in v0.6.0

func (a *App) Copy() *App

func (*App) String added in v0.5.2

func (a *App) String() string

String returns the URL-like image name

type DiscoverWalkFunc added in v0.4.0

type DiscoverWalkFunc func(prefix string, dd *discoveryData, err error) error

DiscoverWalkFunc can stop a DiscoverWalk by returning non-nil error.

type FailedAttempt added in v0.4.0

type FailedAttempt struct {
	Prefix string
	Error  error
}

FailedAttempt represents a failed discovery attempt. This is for debugging and user feedback.

type InsecureOption added in v0.7.4

type InsecureOption int
const (
	InsecureNone InsecureOption = 0

	InsecureTLS InsecureOption = 1 << iota
	InsecureHTTP
)

type PublicKeys added in v0.8.0

type PublicKeys []string

Jump to

Keyboard shortcuts

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