nginx

Documentation

Index

• Constants
• type FakeManager
  • func NewFakeManager(confPath string) *FakeManager
  • func (*FakeManager) CreateConfig(name string, content []byte)
  • func (fm *FakeManager) CreateDHParam(content string) (string, error)
  • func (*FakeManager) CreateMainConfig(content []byte)
  • func (fm *FakeManager) CreateSecret(name string, content []byte, mode os.FileMode) string
  • func (*FakeManager) DeleteConfig(name string)
  • func (*FakeManager) DeleteSecret(name string)
  • func (fm *FakeManager) GetFilenameForSecret(name string) string
  • func (*FakeManager) Quit()
  • func (*FakeManager) Reload() error
  • func (*FakeManager) SetPlusClients(plusClient *client.NginxClient, plusConfigVersionCheckClient *http.Client)
  • func (*FakeManager) Start(done chan error)
  • func (*FakeManager) UpdateConfigVersionFile()
  • func (*FakeManager) UpdateServersInPlus(upstream string, servers []string, config ServerConfig) error
• type LocalManager
  • func NewLocalManager(confPath string, binaryFilename string, mc collectors.ManagerCollector) *LocalManager
  • func (lm *LocalManager) CreateConfig(name string, content []byte)
  • func (lm *LocalManager) CreateDHParam(content string) (string, error)
  • func (lm *LocalManager) CreateMainConfig(content []byte)
  • func (lm *LocalManager) CreateSecret(name string, content []byte, mode os.FileMode) string
  • func (lm *LocalManager) DeleteConfig(name string)
  • func (lm *LocalManager) DeleteSecret(name string)
  • func (lm *LocalManager) GetFilenameForSecret(name string) string
  • func (lm *LocalManager) Quit()
  • func (lm *LocalManager) Reload() error
  • func (lm *LocalManager) SetPlusClients(plusClient *client.NginxClient, plusConfigVersionCheckClient *http.Client)
  • func (lm *LocalManager) Start(done chan error)
  • func (lm *LocalManager) UpdateConfigVersionFile()
  • func (lm *LocalManager) UpdateServersInPlus(upstream string, servers []string, config ServerConfig) error
• type Manager
• type ServerConfig

Constants

const JWKSecretFileMode = 0644

JWKSecretFileMode defines the default filemode for files with JWK Secrets.

const TLSSecretFileMode = 0600

TLSSecretFileMode defines the default filemode for files with TLS Secrets.

Types

type FakeManager

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

FakeManager provides a fake implementation of the Manager interface.

func NewFakeManager

func NewFakeManager(confPath string) *FakeManager

NewFakeManager creates a FakeMananger.

func (*FakeManager) CreateConfig

func (*FakeManager) CreateConfig(name string, content []byte)

CreateConfig provides a fake implementation of CreateConfig.

func (*FakeManager) CreateDHParam

func (fm *FakeManager) CreateDHParam(content string) (string, error)

CreateDHParam provides a fake implementation of CreateDHParam.

func (*FakeManager) CreateMainConfig

func (*FakeManager) CreateMainConfig(content []byte)

CreateMainConfig provides a fake implementation of CreateMainConfig.

func (*FakeManager) CreateSecret

func (fm *FakeManager) CreateSecret(name string, content []byte, mode os.FileMode) string

CreateSecret provides a fake implementation of CreateSecret.

func (*FakeManager) DeleteConfig

func (*FakeManager) DeleteConfig(name string)

DeleteConfig provides a fake implementation of DeleteConfig.

func (*FakeManager) DeleteSecret

func (*FakeManager) DeleteSecret(name string)

DeleteSecret provides a fake implementation of DeleteSecret.

func (*FakeManager) GetFilenameForSecret

func (fm *FakeManager) GetFilenameForSecret(name string) string

GetFilenameForSecret provides a fake implementation of GetFilenameForSecret.

func (*FakeManager) Quit

func (*FakeManager) Quit()

Quit provides a fake implementation of Quit.

func (*FakeManager) Reload

func (*FakeManager) Reload() error

Reload provides a fake implementation of Reload.

func (*FakeManager) SetPlusClients

func (*FakeManager) SetPlusClients(plusClient *client.NginxClient, plusConfigVersionCheckClient *http.Client)

SetPlusClients provides a fake implementation of SetPlusClients.

func (*FakeManager) Start

func (*FakeManager) Start(done chan error)

Start provides a fake implementation of Start.

func (*FakeManager) UpdateConfigVersionFile

func (*FakeManager) UpdateConfigVersionFile()

UpdateConfigVersionFile provides a fake implementation of UpdateConfigVersionFile.

func (*FakeManager) UpdateServersInPlus

func (*FakeManager) UpdateServersInPlus(upstream string, servers []string, config ServerConfig) error

UpdateServersInPlus provides a fake implementation of UpdateServersInPlus.

type LocalManager

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

LocalManager updates NGINX configuration, starts, reloads and quits NGINX, updates NGINX Plus upstream servers. It assumes that NGINX is running in the same container.

func NewLocalManager

func NewLocalManager(confPath string, binaryFilename string, mc collectors.ManagerCollector) *LocalManager

NewLocalManager creates a LocalManager.

func (*LocalManager) CreateConfig

func (lm *LocalManager) CreateConfig(name string, content []byte)

CreateConfig creates a configuration file. If the file already exists, it will be overridden.

func (*LocalManager) CreateDHParam

func (lm *LocalManager) CreateDHParam(content string) (string, error)

CreateDHParam creates the servers dhparam.pem file. If the file already exists, it will be overridden.

func (*LocalManager) CreateMainConfig

func (lm *LocalManager) CreateMainConfig(content []byte)

CreateMainConfig creates the main NGINX configuration file. If the file already exists, it will be overridden.

func (*LocalManager) CreateSecret

func (lm *LocalManager) CreateSecret(name string, content []byte, mode os.FileMode) string

CreateSecret creates a secret file with the specified name, content and mode. If the file already exists, it will be overridden.

func (*LocalManager) DeleteConfig

func (lm *LocalManager) DeleteConfig(name string)

DeleteConfig deletes the configuration file from the conf.d folder.

func (*LocalManager) DeleteSecret

func (lm *LocalManager) DeleteSecret(name string)

DeleteSecret the file with the secret.

func (*LocalManager) GetFilenameForSecret

func (lm *LocalManager) GetFilenameForSecret(name string) string

GetFilenameForSecret constructs the filename for the secret.

func (*LocalManager) Quit

func (lm *LocalManager) Quit()

Quit shutdowns NGINX gracefully.

func (*LocalManager) Reload

func (lm *LocalManager) Reload() error

Reload reloads NGINX.

func (*LocalManager) SetPlusClients

func (lm *LocalManager) SetPlusClients(plusClient *client.NginxClient, plusConfigVersionCheckClient *http.Client)

SetPlusClients sets the necessary clients to work with NGINX Plus API. If not set, invoking the UpdateServersInPlus will fail.

func (*LocalManager) Start

func (lm *LocalManager) Start(done chan error)

Start starts NGINX.

func (*LocalManager) UpdateConfigVersionFile

func (lm *LocalManager) UpdateConfigVersionFile()

UpdateConfigVersionFile writes the config version file.

func (*LocalManager) UpdateServersInPlus

func (lm *LocalManager) UpdateServersInPlus(upstream string, servers []string, config ServerConfig) error

UpdateServersInPlus updates NGINX Plus servers of the given upstream.

type Manager

type Manager interface {
	CreateMainConfig(content []byte)
	CreateConfig(name string, content []byte)
	DeleteConfig(name string)
	CreateSecret(name string, content []byte, mode os.FileMode) string
	DeleteSecret(name string)
	GetFilenameForSecret(name string) string
	CreateDHParam(content string) (string, error)
	Start(done chan error)
	Reload() error
	Quit()
	UpdateConfigVersionFile()
	SetPlusClients(plusClient *client.NginxClient, plusConfigVersionCheckClient *http.Client)
	UpdateServersInPlus(upstream string, servers []string, config ServerConfig) error
}

The Manager interface updates NGINX configuration, starts, reloads and quits NGINX, updates NGINX Plus upstream servers.

type ServerConfig

type ServerConfig struct {
	MaxFails    int
	FailTimeout string
	SlowStart   string
}

ServerConfig holds the config data for an upstream server in NGINX Plus.