OpenSearch Role 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/$defs/role
Definitions for OpenSearch roles.
| 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)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| definition | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| clusterPermissions | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| indexPermissions | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| indexPatterns | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| allowedActions | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
name¶
Configures the name of the create role.
name
-
is optional
-
Type:
string(OpenSearch Role Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Role Name)
definition¶
Configures the permissions the role will have.
This schema does not cover the entire upstream object.
definition
-
is optional
-
Type:
object(OpenSearch Role Definition) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (OpenSearch Role Definition)
clusterPermissions¶
Configure permissions that applies cluster-wide.
clusterPermissions
-
is optional
-
Type:
string[](OpenSearch Cluster Permission) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (OpenSearch Cluster Permission)
indexPermissions¶
Configure permissions that applies per index.
indexPermissions
-
is optional
-
Type:
object[](OpenSearch Role Index Permission) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object[] (OpenSearch Role Index Permission)
indexPatterns¶
Configure the index pattern this permission applies to.
indexPatterns
-
is optional
-
Type:
string[](OpenSearch Role Index Pattern) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (OpenSearch Role Index Pattern)
allowedActions¶
Configure the actions this permission allows.
allowedActions
-
is optional
-
Type:
string[](OpenSearch Role Allowed Action) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (OpenSearch Role Allowed Action)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main