OpenSearch Role Definition 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/extraRoles/items/properties/definition
Configures the permissions the role will have.
This schema does not cover the entire upstream object.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/config.yaml* |
TYPE:
object (OpenSearch Role Definition)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| cluster_permissions | array |
Optional | cannot be null | Welkin Apps Config |
| index_permissions | array |
Optional | cannot be null | Welkin Apps Config |
cluster_permissions¶
Configure permissions that applies cluster-wide.
cluster_permissions
-
is optional
-
Type:
string[](OpenSearch Cluster Permission) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string[] (OpenSearch Cluster Permission)
index_permissions¶
Configure permissions that applies per index.
index_permissions
-
is optional
-
Type:
object[](OpenSearch Role Index Permission) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object[] (OpenSearch Role Index Permission)
Return to the root config schema
Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main