nginxingress

Documentation

Overview

package nginx contains an addon that installs nginx-ingress

Index

• type Details
  • func (d *Details) NewTestDomain() string
• type Nginx
  • func (n *Nginx) Deprovision() error
  • func (n *Nginx) Details() *Details
  • func (n *Nginx) Logs() (map[string]string, error)
  • func (n *Nginx) Provision() error
  • func (n *Nginx) Setup(cfg *config.Config) error
  • func (n *Nginx) SupportsGlobal() bool

Types

type Details

type Details struct {
	// BaseDomain is a domain name that can be used during e2e tests.
	// This domain should have records for *.example.com and example.com pointing
	// to the IP listed above.
	BaseDomain string

	// IngressClass configured for this controller
	IngressClass string
}

func (*Details) NewTestDomain

func (d *Details) NewTestDomain() string

type Nginx

type Nginx struct {

	// Name is a unique name for this nginx-ingress deployment
	Name string

	// Namespace is the namespace to deploy nginx into
	Namespace string

	// Tiller is the tiller instance used to deploy the chart
	Tiller *tiller.Tiller

	// IPAddress is the IP address that the nginx-ingress service will be
	// exposed on.
	// This must be a part of the service CIDR, and must not already be allocated
	// else provisioning will fail.
	IPAddress string

	// Domain is a domain name that can be used during e2e tests.
	// This domain should have records for *.example.com and example.com pointing
	// to the IP listed above.
	Domain string
	// contains filtered or unexported fields
}

Nginx describes the configuration details for an instance of nginx-ingress deployed to a cluster.

func (*Nginx) Deprovision

func (n *Nginx) Deprovision() error

Deprovision will destroy this instance of nginx-ingress

func (*Nginx) Details

func (n *Nginx) Details() *Details

Details returns details that can be used to utilise the instance of nginx ingress.

func (*Nginx) Logs

func (n *Nginx) Logs() (map[string]string, error)

func (*Nginx) Provision

func (n *Nginx) Provision() error

Provision will actually deploy this instance of nginx-ingress to the cluster.

func (*Nginx) Setup

func (n *Nginx) Setup(cfg *config.Config) error

func (*Nginx) SupportsGlobal

func (n *Nginx) SupportsGlobal() bool

SupportsGlobal will return whether this addon supports having a global, shared instance deployed. In order for an addon to support 'global mode', the Config() *must* be able to be derived from the inputs to the addon only, i.e. there must be no state created by Provision that is required for the output of Config(). This is because multiple test processes are started in order to run tests in parallel, and only one invocation (the 'root') will actually call the Provision function. Tests themselves will only call the Details() function.