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

Configures the CronJob and repository to take snapshots in OpenSearch.

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	Compliant Kubernetes Apps Config
repository	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
ageSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
min	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
max	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
maxRequestSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
backupSchedule	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
backupStartingDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
backupActiveDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionSchedule	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionStartingDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionActiveDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionResources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config

enabled¶

enabled

is optional
Type: boolean (OpenSearch Snapshot Enabled)
cannot be null
defined in: Compliant Kubernetes 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: Compliant Kubernetes 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: Compliant Kubernetes Apps Config

TYPE:

number

DEFAULTS:

The default value is:

min¶

min

is optional
Type: number (OpenSearch Minimum Retained Snapshots)
cannot be null
defined in: Compliant Kubernetes 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: Compliant Kubernetes Apps Config

TYPE:

number (OpenSearch Maximum Retained Snapshots)

DEFAULTS:

The default value is:

maxRequestSeconds¶

maxRequestSeconds

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

TYPE:

number

DEFAULTS:

The default value is:

backupSchedule¶

backupSchedule

is optional
Type: string (OpenSearch Backup CronJob Schedule)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (OpenSearch Backup CronJob Schedule)

DEFAULTS:

The default value is:

"0 */2 * * *"

backupStartingDeadlineSeconds¶

backupStartingDeadlineSeconds

is optional
Type: number (OpenSearch Backup Job Starting Deadline)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

number (OpenSearch Backup Job Starting Deadline)

DEFAULTS:

The default value is:

backupActiveDeadlineSeconds¶

backupActiveDeadlineSeconds

is optional
Type: number (OpenSearch Backup Job Active Deadline)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

number (OpenSearch Backup Job Active Deadline)

DEFAULTS:

The default value is:

retentionSchedule¶

retentionSchedule

is optional
Type: string (OpenSearch Retention CronJob Schedule)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (OpenSearch Retention CronJob Schedule)

DEFAULTS:

The default value is:

"@daily"

retentionStartingDeadlineSeconds¶

retentionStartingDeadlineSeconds

is optional
Type: number (OpenSearch Retention Job Starting Deadline)
cannot be null
defined in: Compliant Kubernetes 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: Compliant Kubernetes 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: Compliant Kubernetes Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

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

Return to the root config schema

Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main