download

Documentation

Overview

Package download provides a download with retries for machine configuration and userdata.

Index

• func Download(ctx context.Context, endpoint string, opts ...Option) (b []byte, err error)
• func NewTFTPTransport() http.RoundTripper
• type Option
  • func WithEndpointFunc(endpointFunc func(context.Context) (string, error)) Option
  • func WithErrorOnBadRequest(e error) Option
  • func WithErrorOnEmptyResponse(e error) Option
  • func WithErrorOnNotFound(e error) Option
  • func WithFormat(format string) Option
  • func WithHeaders(headers map[string]string) Option
  • func WithLowSrcPort() Option
  • func WithRetryOptions(opts ...retry.Option) Option
  • func WithTimeout(timeout time.Duration) Option

Functions

func Download

func Download(ctx context.Context, endpoint string, opts ...Option) (b []byte, err error)

Download downloads a config.

func NewTFTPTransport

func NewTFTPTransport() http.RoundTripper

NewTFTPTransport returns an http.RoundTripper capable of handling the TFTP protocol.

Types

type Option

type Option func(*downloadOptions)

Option configures the download options.

func WithEndpointFunc

func WithEndpointFunc(endpointFunc func(context.Context) (string, error)) Option

WithEndpointFunc provides a function that sets the endpoint of the download options.

func WithErrorOnBadRequest

func WithErrorOnBadRequest(e error) Option

WithErrorOnBadRequest provides specific error to return when response has HTTP 400 error.

func WithErrorOnEmptyResponse

func WithErrorOnEmptyResponse(e error) Option

WithErrorOnEmptyResponse provides specific error to return when response is empty.

func WithErrorOnNotFound

func WithErrorOnNotFound(e error) Option

WithErrorOnNotFound provides specific error to return when response has HTTP 404 error.

func WithFormat

func WithFormat(format string) Option

WithFormat specifies the source format. This ultimately will be a yaml but may be represented in different formats. For example, the config may be base64 encoded.

func WithHeaders

func WithHeaders(headers map[string]string) Option

WithHeaders specifies any http headers that are needed for downloading the config.

func WithLowSrcPort

func WithLowSrcPort() Option

WithLowSrcPort sets low source port to download the config.

func WithRetryOptions

func WithRetryOptions(opts ...retry.Option) Option

WithRetryOptions sets the retry options for the download.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout sets the timeout for the download.