OpenSearch Plugins Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/opensearch/properties/plugins
Configures plugins used in 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 Plugins)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| installExternalObjectStoragePlugin | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| additionalPlugins | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
installExternalObjectStoragePlugin¶
When enabled OpenSearch will install the required object storage plugin when it starts.
In an air-gapped environment where the nodes are not connected to the Internet, set this to false to prevent downloading any external object storage plugins.
installExternalObjectStoragePlugin
-
is optional
-
Type:
boolean(OpenSearch Install External Object Storage Plugin) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (OpenSearch Install External Object Storage Plugin)
additionalPlugins¶
Configures OpenSearch to install plugins when it starts.
In an air-gapped environment this can be used to install plugins from known sources.
additionalPlugins
-
is optional
-
Type:
array(OpenSearch Install Additional Plugins) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
array (OpenSearch Install Additional Plugins)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main