Log Manager Compaction Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/fluentd/properties/scLogs/properties/compaction

Configure the compaction of logs stored in object storage.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	config/schemas/config.yaml*

TYPE:

object (Log Manager Compaction)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Welkin Apps Config
days	`number`	Optional	cannot be null	Welkin Apps Config
schedule	`string`	Optional	cannot be null	Welkin Apps Config
ephemeralVolumes	`object`	Optional	cannot be null	Welkin Apps Config

enabled¶

enabled

is optional
Type: boolean (Log Manager Job Enabled)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (Log Manager Job Enabled)

DEFAULTS:

The default value is:

true

days¶

Configure the days to consider for compaction or the days to retain.

days

is optional
Type: number (Log Manager Job Enabled)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Log Manager Job Enabled)

schedule¶

Schema for when to run Log Manager Job. Uses the Cron format, see https://en.wikipedia.org/wiki/Cron.

schedule

is optional
Type: string (Log Manager Job Schema)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Log Manager Job Schema)

CONSTRAINTS:

pattern: the string must match the following regular expression:

^(((\*\/)?([0-5]?[0-9])((\,|\-|\/)([0-5]?[0-9]))*|\*)[^\S\r\n]+((\*\/)?((2[0-3]|1[0-9]|[0-9]|00))((\,|\-|\/)(2[0-3]|1[0-9]|[0-9]|00))*|\*)[^\S\r\n]+((\*\/)?([1-9]|[12][0-9]|3[01])((\,|\-|\/)([1-9]|[12][0-9]|3[01]))*|\*)[^\S\r\n]+((\*\/)?([1-9]|1[0-2])((\,|\-|\/)([1-9]|1[0-2]))*|\*|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec))[^\S\r\n]+((\*\/)?[0-6]((\,|\-|\/)[0-6])*|\*|00|(sun|mon|tue|wed|thu|fri|sat)))$|^@(annually|yearly|monthly|weekly|daily|hourly|reboot)$

try pattern

ephemeralVolumes¶

Configure the job to run with an ephemeral volume if the nodes risk running out of storage.

ephemeralVolumes

is optional
Type: object (Log Manager Job Ephemeral Volume)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Log Manager Job Ephemeral Volume)

Return to the root config schema

Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main