OpenSearch Secrets 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/secrets.yaml#/properties/opensearch

Secrets for OpenSearch.

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

TYPE:

object (OpenSearch Secrets)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
adminHash	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
adminPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
configurerHash	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
configurerPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
dashboardsCookieEncKey	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
dashboardsHash	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
dashboardsPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
clientSecret	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
curatorPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
fluentdPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
metricsExporterPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
snapshotterPassword	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
extraUsers	`array`	Optional	cannot be null	Compliant Kubernetes Apps Secrets

adminHash¶

adminHash

is optional
Type: string (OpenSearch Admin User Hash)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Admin User Hash)

adminPassword¶

adminPassword

is optional
Type: string (OpenSearch Admin User Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Admin User Password)

configurerHash¶

configurerHash

is optional
Type: string (OpenSearch Configurer User Hash)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Configurer User Hash)

configurerPassword¶

configurerPassword

is optional
Type: string (OpenSearch Configurer User Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Configurer User Password)

dashboardsCookieEncKey¶

dashboardsCookieEncKey

is optional
Type: string (OpenSearch Dashboards Cookie Encryption Key)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Dashboards Cookie Encryption Key)

dashboardsHash¶

dashboardsHash

is optional
Type: string (OpenSearch Dashboards User Hash)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Dashboards User Hash)

dashboardsPassword¶

dashboardsPassword

is optional
Type: string (OpenSearch Dashboards User Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Dashboards User Password)

clientSecret¶

clientSecret

is optional
Type: string (OpenSearch Client Secret)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Client Secret)

curatorPassword¶

curatorPassword

is optional
Type: string (OpenSearch Curator Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Curator Password)

fluentdPassword¶

fluentdPassword

is optional
Type: string (OpenSearch Fluentd Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Fluentd Password)

metricsExporterPassword¶

metricsExporterPassword

is optional
Type: string (OpenSearch Exporter Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Exporter Password)

snapshotterPassword¶

snapshotterPassword

is optional
Type: string (OpenSearch Snapshot Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Snapshot Password)

extraUsers¶

Configures extra users for OpenSearch Security.

extraUsers

is optional
Type: object[] (OpenSearch Extra User)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

object[] (OpenSearch Extra User)

Definitions¶

user¶

Reference this group by using

{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/secrets.yaml#/properties/opensearch/$defs/user"}

Property	Type	Required	Nullable	Defined by
name	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
definition	`object`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
attributes	`object`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
groups	`array`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
securityRoles	`array`	Optional	cannot be null	Compliant Kubernetes Apps Secrets
password	`string`	Optional	cannot be null	Compliant Kubernetes Apps Secrets

name¶

name

is optional
Type: string (OpenSearch Username)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch Username)

definition¶

Configures the permissions the role will have.

This schema does not cover the entire upstream object.

definition

is optional
Type: object (OpenSearch User Definition)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

object (OpenSearch User Definition)

attributes¶

Configures the attributes the user will have.

attributes

is optional
Type: object (OpenSearch User Attributes)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

object (OpenSearch User Attributes)

groups¶

Configures the backend roles or groups the user will have.

groups

is optional
Type: string[]
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string[]

securityRoles¶

Configures the security roles the user will have.

Note

These roles must exists or be created via extraRoles.

securityRoles

is optional
Type: string[] (OpenSearch Security Role)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string[] (OpenSearch Security Role)

password¶

password

is optional
Type: string (OpenSearch User Password)
cannot be null
defined in: Compliant Kubernetes Apps Secrets

TYPE:

string (OpenSearch User Password)

Return to the root secrets schema

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