OpenSearch Curator 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/curator

Configures the CronJob that removes indices.

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 Curator)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Compliant Kubernetes Apps Config
retention	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
startingDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
activeDeadlineSeconds	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
resources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
tolerations	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
nodeSelector	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
affinity	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config

enabled¶

enabled

is optional
Type: boolean (OpenSearch Curator Enabled)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

boolean (OpenSearch Curator Enabled)

DEFAULTS:

The default value is:

true

retention¶

Configures the retention of indices in OpenSearch.

retention

is optional
Type: object[] (OpenSearch Curator Retention)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object[] (OpenSearch Curator Retention)

DEFAULTS:

The default value is:

[
  {
    "pattern": "authlog-*",
    "ageDays": 30,
    "sizeGB": 1
  },
  {
    "pattern": "kubeaudit-*",
    "ageDays": 30,
    "sizeGB": 50
  },
  {
    "pattern": "kubernetes-*",
    "ageDays": 30,
    "sizeGB": 50
  },
  {
    "pattern": "other-*",
    "ageDays": 7,
    "sizeGB": 1
  },
  {
    "pattern": "security-auditlog-*",
    "ageDays": 7,
    "sizeGB": 1
  }
]

startingDeadlineSeconds¶

startingDeadlineSeconds

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

TYPE:

number (OpenSearch Curator Starting Deadline Seconds)

DEFAULTS:

The default value is:

activeDeadlineSeconds¶

activeDeadlineSeconds

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

TYPE:

number (OpenSearch Curator Active Deadline Seconds)

DEFAULTS:

The default value is:

resources¶

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'.

resources

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

tolerations¶

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

an array of merged types (Details)

nodeSelector¶

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

is optional
Type: object (Kubernetes Node Selector)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

is optional
Type: object (Affinity)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Affinity)

Return to the root config schema

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