Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for security config upgrade feature #6634

Merged
merged 24 commits into from
Mar 27, 2024
Merged
Changes from 13 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
31cca14
Add documentation for security config upgrade feature
peternied Mar 8, 2024
765ae9d
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 12, 2024
a779ce3
Fix vale annotations
peternied Mar 15, 2024
7f07e97
Merge remote-tracking branch 'origin/main' into security-upgrade
peternied Mar 15, 2024
3d43974
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 21, 2024
57c4605
Feedback round 1
peternied Mar 21, 2024
299a7b7
Resolve OpenSearch.SpacingPunctuation
peternied Mar 21, 2024
059b969
Fix vale error
peternied Mar 22, 2024
cc760bb
Clean up rendering of list of options for upgrade
peternied Mar 22, 2024
b5cc844
Clean up formatting around example a little
peternied Mar 22, 2024
2c759a4
Merge branch 'main' into security-upgrade
peternied Mar 22, 2024
483f499
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 22, 2024
487f805
Merge branch 'main' into security-upgrade
peternied Mar 25, 2024
1243997
PR Feedback 2
peternied Mar 26, 2024
606679c
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 26, 2024
6cfc3ad
Update api.md
Naarcha-AWS Mar 26, 2024
8e65fce
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 26, 2024
6aab4e3
Apply suggestions from code review
Naarcha-AWS Mar 26, 2024
a4d0372
Apply suggestions from code review
Naarcha-AWS Mar 26, 2024
a75aed1
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 26, 2024
a1bc78c
Update _security/access-control/api.md
Naarcha-AWS Mar 27, 2024
c2c266d
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 27, 2024
a3c9892
Merge branch 'main' into security-upgrade
Naarcha-AWS Mar 27, 2024
698542c
Update _security/access-control/api.md
Naarcha-AWS Mar 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions _security/access-control/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1297,6 +1297,91 @@ PATCH _plugins/_security/api/securityconfig
}
```

### Configuration upgrade check
Introduced 2.13
{: .label .label-purple }

Checks the configuration bundled with the Security plugin against the existing security configuration, returns if an upgrade can be performed and what resources would be updated.
peternied marked this conversation as resolved.
Show resolved Hide resolved

Between new OpenSearch version new defaults to the security configuration are added. This endpoint helps cluster operators check if the cluster is missing defaults or has stale definitions of defaults.
peternied marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

#### Request

```json
GET _plugins/_security/api/_upgrade_check
```
{% include copy-curl.html %}

#### Example response

```json
{
"status" : "OK",
"upgradeAvailable" : true,
"upgradeActions" : {
"roles" : {
"add" : [ "flow_framework_full_access" ]
}
}
}
```

#### Response fields

| Field | Data type | Description |
|:---------|:-----------|:------------------------------|
| `upgradeAvailable` | Boolean | True when an upgrade can be performed. |
| `upgradeActions` | Object | The security objects that would be modified by an upgrade. |

### Configuration upgrade
Introduced 2.13
{: .label .label-purple }

Adds and updates resources on the existing security configuration from the configuration bundled with the Security plugin.

These bundled configuration files can be found in the `<OPENSEARCH_HOME>/security/config` directory. Default configuration files are updated on OpenSearch upgrade, whereas the cluster configuration is only updated by the cluster operators. This endpoint helps cluster operators upgrade missing defaults and stale defaults definitions.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"cluster operator" (singular)?


Between new OpenSearch version new defaults to the security configuration are added. This endpoint helps cluster operators check if the cluster is missing default roles or has stale definitions of default roles.
peternied marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

#### Request

```json
POST _plugins/_security/api/_upgrade_perform
{
"configs" : [ "roles" ]
}
```
{% include copy-curl.html %}

#### Request fields

| Field | Data type | Description | Required |
|:----------------|:-----------|:------------------------------------------------------------------------------------------------------------------|:---------|
| configs | Array | Specifies the configurations to be upgraded. This field can include any combination of the following configurations `actiongroups`,`allowlist`, `audit`, `internalusers`, `nodesdn`, `roles`, `rolesmappings`, `tenants`.<br> Default is all supported configurations. | No |
peternied marked this conversation as resolved.
Show resolved Hide resolved


#### Example response

```json
{
"status" : "OK",
"upgrades" : {
"roles" : {
"add" : [ "flow_framework_full_access" ]
}
}
}
```

#### Response fields

| Field | Data type | Description |
|:---------|:-----------|:------------------------------|
| `upgrades` | Object | A container for the upgrade results, organized by configuration type (e.g., `roles`). Each configuration type that has changes will be represented as a key in this object. |
| ↳ `roles` | Object | Demonstrates changes made to the roles configuration. The `roles` object contains keys of actions that list the objects modified by the upgrade. |

---

## Distinguished names
Expand Down
Loading