config

Documentation

Index

• Constants
• type Generator
• type GeneratorImpl
  • func NewGeneratorImpl() GeneratorImpl
  • func (g GeneratorImpl) Generate(conf dataplane.Configuration) []byte

Constants

const (
	// HeaderMatchSeparator is the separator for constructing header-based match for NJS.
	HeaderMatchSeparator = ":"
)

Types

type Generator

type Generator interface {
	// Generate generates NGINX configuration from internal representation.
	Generate(configuration dataplane.Configuration) []byte
}

Generator generates NGINX configuration. This interface is used for testing purposes only.

type GeneratorImpl

type GeneratorImpl struct{}

GeneratorImpl is an implementation of Generator.

func NewGeneratorImpl

func NewGeneratorImpl() GeneratorImpl

NewGeneratorImpl creates a new GeneratorImpl.

func (GeneratorImpl) Generate

func (g GeneratorImpl) Generate(conf dataplane.Configuration) []byte

Generate generates NGINX configuration from internal representation. It is the responsibility of the caller to validate the configuration before calling this function. In case of invalid configuration, NGINX will fail to reload or could be configured with malicious configuration. To validate, use the validators from the validation package.