OpenSearch Snapshot 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/opensearch/properties/snapshot

Configure OpenSearch snapshot creation and retention.

This requires that objectStorage is configured, and will use the bucket or container set in objectStorage.buckets.opensearch.

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 (OpenSearch Snapshot)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Welkin Apps Config
repository	`string`	Optional	cannot be null	Welkin Apps Config
ageSeconds	`number`	Optional	cannot be null	Welkin Apps Config
min	`number`	Optional	cannot be null	Welkin Apps Config
max	`number`	Optional	cannot be null	Welkin Apps Config
maxRequestSeconds	`number`	Optional	cannot be null	Welkin Apps Config
backupSchedule	`string`	Optional	cannot be null	Welkin Apps Config
retentionSchedule	`string`	Optional	cannot be null	Welkin Apps Config
retentionStartingDeadlineSeconds	`number`	Optional	cannot be null	Welkin Apps Config
retentionActiveDeadlineSeconds	`number`	Optional	cannot be null	Welkin Apps Config
retentionResources	`object`	Optional	cannot be null	Welkin Apps Config
retentionAge	`string`	Optional	cannot be null	Welkin Apps Config

enabled¶

enabled

is optional
Type: boolean (OpenSearch Snapshot Enabled)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (OpenSearch Snapshot Enabled)

DEFAULTS:

The default value is:

true

repository¶

repository

is optional
Type: string (OpenSearch Snapshot Repository)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (OpenSearch Snapshot Repository)

DEFAULTS:

The default value is:

"opensearch-snapshots"

ageSeconds¶

ageSeconds

is optional
Type: number
cannot be null
defined in: Welkin Apps Config

TYPE:

number

DEFAULTS:

The default value is:

min¶

min

is optional
Type: number (OpenSearch Minimum Retained Snapshots)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (OpenSearch Minimum Retained Snapshots)

DEFAULTS:

The default value is:

max¶

max

is optional
Type: number (OpenSearch Maximum Retained Snapshots)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (OpenSearch Maximum Retained Snapshots)

DEFAULTS:

The default value is:

maxRequestSeconds¶

maxRequestSeconds

is optional
Type: number
cannot be null
defined in: Welkin Apps Config

TYPE:

number

DEFAULTS:

The default value is:

backupSchedule¶

Schedule to trigger Opensearch backups. Uses the Cron format, see https://en.wikipedia.org/wiki/Cron.

backupSchedule

is optional
Type: string (OpenSearch Snapshot Backup Schedule)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (OpenSearch Snapshot Backup Schedule)

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

DEFAULTS:

The default value is:

"0 */2 * * *"

retentionSchedule¶

Schedule to check for and remove old snapshots. Uses the Cron format, see https://en.wikipedia.org/wiki/Cron.

retentionSchedule

is optional
Type: string (OpenSearch Snapshot Retention Schedule)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (OpenSearch Snapshot Retention Schedule)

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

DEFAULTS:

The default value is:

"0 0 * * *"

retentionStartingDeadlineSeconds¶

retentionStartingDeadlineSeconds

is optional
Type: number (OpenSearch Retention Job Starting Deadline)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (OpenSearch Retention Job Starting Deadline)

DEFAULTS:

The default value is:

retentionActiveDeadlineSeconds¶

retentionActiveDeadlineSeconds

is optional
Type: number (OpenSearch Retention Job Active Deadline)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (OpenSearch Retention Job Active Deadline)

DEFAULTS:

The default value is:

retentionResources¶

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

retentionResources

is optional
Type: object (Kubernetes Resource Requirements)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

retentionAge¶

retentionAge

is optional
Type: string (OpenSearch Maximum Snapshot Age)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (OpenSearch Maximum Snapshot Age)

DEFAULTS:

The default value is:

"10d"

Return to the root config schema

Generated Wed Jul 2 04:00:02 UTC 2025 from elastisys/compliantkubernetes-apps@main