nginx

Documentation

Index

• Variables
• func Compare(listA, listB interface{}, eq equalFunction) bool
• type Configuration
  • func (c *Configuration) Equal(to *Configuration) bool
• type Endpoint
  • func (e *Endpoint) Equal(to *Endpoint) bool
• type NGINX
  • func NewInstance(path string) (NGINX, error)
• type Server
  • func (e *Server) Equal(to *Server) bool

Variables

var Binary = "/usr/local/openresty/nginx/sbin/nginx"

Binary location of NGINX binary.

var StatusSocket = "/tmp/nginx-config-socket.sock"

StatusSocket defines the location of the unix socket used by NGINX for the status server

var Template = "/etc/nginx/template/nginx.tmpl"

Template NGINX template useed to render the configuration file

Functions

func Compare

func Compare(listA, listB interface{}, eq equalFunction) bool

Compare checks if the parameters are iterable and contains the same elements

Types

type Configuration

type Configuration struct {
	// Servers server sections
	Servers []Server `json:"servers"`
}

Configuration defines an NGINX configuration

func (*Configuration) Equal

func (c *Configuration) Equal(to *Configuration) bool

Equal tests for equality between two Server types

type Endpoint

type Endpoint struct {
	Address string `json:"address,omitempty"`
	Port    string `json:"port,omitempty"`
}

Endpoint defines the IP address and port of a pod from the deployment

func (*Endpoint) Equal

func (e *Endpoint) Equal(to *Endpoint) bool

Equal compares the endpoint with another one

type NGINX

type NGINX interface {
	// Start creates a new NGINX process
	Start(stopCh <-chan struct{}) error

	// Update changes the running configuration in NGINX
	Update(*Configuration) error
}

NGINX defines

func NewInstance

func NewInstance(path string) (NGINX, error)

NewInstance returns an NGINX instance

type Server

type Server struct {
	Name      string     `json:"name,omitempty"`
	Port      string     `json:"port,omitempty"`
	Endpoints []Endpoint `json:"endpoints"`
}

Server defines an NGINX server section

func (*Server) Equal

func (e *Server) Equal(to *Server) bool

Equal compares the server with another one