notmain

Documentation

Index

• type Config
• type Throughput

Types

type Config

type Config struct {
	AkamaiPurger struct {
		cmd.ServiceConfig

		// MaxQueueSize is the maximum size of the purger stack. If this value
		// isn't provided it will default to `defaultQueueSize`.
		MaxQueueSize int

		BaseURL      string `validate:"required,url"`
		ClientToken  string `validate:"required"`
		ClientSecret string `validate:"required"`
		AccessToken  string `validate:"required"`
		V3Network    string `validate:"required,oneof=staging production"`

		// Throughput is a container for all throughput related akamai-purger
		// settings.
		Throughput Throughput

		// PurgeRetries is the maximum number of attempts that will be made to purge a
		// batch of URLs before the batch is added back to the stack.
		PurgeRetries int

		// PurgeRetryBackoff is the base duration that will be waited before
		// attempting to purge a batch of URLs which previously failed to be
		// purged.
		PurgeRetryBackoff config.Duration `validate:"-"`
	}
	Syslog        cmd.SyslogConfig
	OpenTelemetry cmd.OpenTelemetryConfig
}

type Throughput

type Throughput struct {
	// QueueEntriesPerBatch the number of cached OCSP responses to included in each
	// purge request. One cached OCSP response is composed of 3 URLs totaling <
	// 400 bytes. If this value isn't provided it will default to
	// 'defaultQueueEntriesPerBatch'.
	//
	// Deprecated: Only set TotalInstances and let it compute the defaults.
	QueueEntriesPerBatch int `validate:"min=0"`

	// PurgeBatchInterval is the duration waited between dispatching an Akamai
	// purge request containing 'QueueEntriesPerBatch' * 3 URLs. If this value
	// isn't provided it will default to 'defaultPurgeBatchInterval'.
	//
	// Deprecated: Only set TotalInstances and let it compute the defaults.
	PurgeBatchInterval config.Duration `validate:"-"`

	// TotalInstances is the number of akamai-purger instances running at the same
	// time, across all data centers.
	TotalInstances int `validate:"min=0"`
}

Throughput is a container for all throuput related akamai-purger configuration settings.