runtime

Documentation

Index

• Constants
• func CreatePlusClient() (*client.NginxClient, error)
• func GetSocketClient(sockPath string) http.Client
• type CheckFileFunc
• type Manager
• type ManagerImpl
  • func NewManagerImpl(ngxPlusClient NginxPlusClient, collector MetricsCollector, logger logr.Logger, ...) *ManagerImpl
  • func (m *ManagerImpl) GetUpstreams() (ngxclient.Upstreams, error)
  • func (m *ManagerImpl) IsPlus() bool
  • func (m *ManagerImpl) Reload(ctx context.Context, configVersion int) error
  • func (m *ManagerImpl) UpdateHTTPServers(upstream string, servers []ngxclient.UpstreamServer) error
• type MetricsCollector
• type NginxPlusClient
• type ProcessHandler
• type ProcessHandlerImpl
  • func NewProcessHandlerImpl(readFile ReadFileFunc, checkFile CheckFileFunc) *ProcessHandlerImpl
  • func (p *ProcessHandlerImpl) FindMainProcess(ctx context.Context, timeout time.Duration) (int, error)
  • func (p *ProcessHandlerImpl) Kill(pid int) error
  • func (p *ProcessHandlerImpl) ReadFile(file string) ([]byte, error)
• type ReadFileFunc
• type VerifyClient
  • func NewVerifyClient(timeout time.Duration) *VerifyClient
  • func (c *VerifyClient) EnsureConfigVersion(ctx context.Context, expectedVersion int) error
  • func (c *VerifyClient) GetConfigVersion() (int, error)
  • func (c *VerifyClient) WaitForCorrectVersion(ctx context.Context, expectedVersion int, childProcFile string, ...) error

Constants

const (
	// PidFile specifies the location of the PID file for the Nginx process.
	PidFile = "/var/run/nginx/nginx.pid"
	// PidFileTimeout defines the timeout duration for accessing the PID file.
	PidFileTimeout = 10000 * time.Millisecond
	// NginxReloadTimeout sets the timeout duration for reloading the Nginx configuration.
	NginxReloadTimeout = 60000 * time.Millisecond
)

Functions

func CreatePlusClient

func CreatePlusClient() (*client.NginxClient, error)

CreatePlusClient returns a client for communicating with the NGINX Plus API.

func GetSocketClient

func GetSocketClient(sockPath string) http.Client

GetSocketClient gets an http.Client with a unix socket transport.

Types

type CheckFileFunc

type CheckFileFunc func(string) (fs.FileInfo, error)

type Manager

type Manager interface {
	// Reload reloads NGINX configuration. It is a blocking operation.
	Reload(ctx context.Context, configVersion int) error
	// IsPlus returns whether or not we are running NGINX plus.
	IsPlus() bool
	// UpdateHTTPServers uses the NGINX Plus API to update HTTP servers.
	// Only usable if running NGINX Plus.
	UpdateHTTPServers(string, []ngxclient.UpstreamServer) error
	// GetUpstreams uses the NGINX Plus API to get the upstreams.
	// Only usable if running NGINX Plus.
	GetUpstreams() (ngxclient.Upstreams, error)
}

Manager manages the runtime of NGINX.

type ManagerImpl

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

ManagerImpl implements Manager.

func NewManagerImpl

func NewManagerImpl(
	ngxPlusClient NginxPlusClient,
	collector MetricsCollector,
	logger logr.Logger,
	processHandler ProcessHandler,
	verifyClient nginxConfigVerifier,
) *ManagerImpl

NewManagerImpl creates a new ManagerImpl.

func (*ManagerImpl) GetUpstreams

func (m *ManagerImpl) GetUpstreams() (ngxclient.Upstreams, error)

GetUpstreams uses the NGINX Plus API to get the upstreams. Only usable if running NGINX Plus.

func (*ManagerImpl) IsPlus

func (m *ManagerImpl) IsPlus() bool

IsPlus returns whether or not we are running NGINX plus.

func (*ManagerImpl) Reload

func (m *ManagerImpl) Reload(ctx context.Context, configVersion int) error

func (*ManagerImpl) UpdateHTTPServers

func (m *ManagerImpl) UpdateHTTPServers(upstream string, servers []ngxclient.UpstreamServer) error

UpdateHTTPServers uses the NGINX Plus API to update HTTP upstream servers. Only usable if running NGINX Plus.

type MetricsCollector

type MetricsCollector interface {
	IncReloadCount()
	IncReloadErrors()
	ObserveLastReloadTime(ms time.Duration)
}

MetricsCollector is an interface for the metrics of the NGINX runtime manager.

type NginxPlusClient

type NginxPlusClient interface {
	UpdateHTTPServers(
		upstream string,
		servers []ngxclient.UpstreamServer,
	) (
		added []ngxclient.UpstreamServer,
		deleted []ngxclient.UpstreamServer,
		updated []ngxclient.UpstreamServer,
		err error,
	)
	GetUpstreams() (*ngxclient.Upstreams, error)
}

type ProcessHandler

type ProcessHandler interface {
	FindMainProcess(
		ctx context.Context,
		timeout time.Duration,
	) (int, error)
	ReadFile(file string) ([]byte, error)
	Kill(pid int) error
}

type ProcessHandlerImpl

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

func NewProcessHandlerImpl

func NewProcessHandlerImpl(readFile ReadFileFunc, checkFile CheckFileFunc) *ProcessHandlerImpl

func (*ProcessHandlerImpl) FindMainProcess

func (p *ProcessHandlerImpl) FindMainProcess(
	ctx context.Context,
	timeout time.Duration,
) (int, error)

func (*ProcessHandlerImpl) Kill

func (p *ProcessHandlerImpl) Kill(pid int) error

func (*ProcessHandlerImpl) ReadFile

func (p *ProcessHandlerImpl) ReadFile(file string) ([]byte, error)

type ReadFileFunc

type ReadFileFunc func(string) ([]byte, error)

type VerifyClient

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

VerifyClient is a client for verifying the config version.

func NewVerifyClient

func NewVerifyClient(timeout time.Duration) *VerifyClient

NewVerifyClient returns a new client pointed at the config version socket.

func (*VerifyClient) EnsureConfigVersion

func (c *VerifyClient) EnsureConfigVersion(ctx context.Context, expectedVersion int) error

func (*VerifyClient) GetConfigVersion

func (c *VerifyClient) GetConfigVersion() (int, error)

GetConfigVersion gets the version number that we put in the nginx config to verify that we're using the correct config.

func (*VerifyClient) WaitForCorrectVersion

func (c *VerifyClient) WaitForCorrectVersion(
	ctx context.Context,
	expectedVersion int,
	childProcFile string,
	previousChildProcesses []byte,
	readFile ReadFileFunc,
) error

WaitForCorrectVersion first ensures any new worker processes have been started, and then calls the config version endpoint until it gets the expectedVersion, which ensures that a new worker process has been started for that config version.