Skip to content

Commit

Permalink
Correct plugin capitalization (#3838)
Browse files Browse the repository at this point in the history
* Correct plugin capitalization

Signed-off-by: Fanit Kolchina <[email protected]>

* Revert cluster-stats because the name is in response

Signed-off-by: Fanit Kolchina <[email protected]>

* Revert cluster-stats once more

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
  • Loading branch information
kolchfa-aws authored May 4, 2023
1 parent 9e5b044 commit 8463c8f
Show file tree
Hide file tree
Showing 80 changed files with 222 additions and 222 deletions.
2 changes: 1 addition & 1 deletion _api-reference/analyze-apis/perform-text-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 2

The perform text analysis API analyzes a text string and returns the resulting tokens.

If you use the security plugin, you must have the `manage index` privilege. If you simply want to analyze text, you must have the `manager cluster` privilege.
If you use the Security plugin, you must have the `manage index` privilege. If you simply want to analyze text, you must have the `manager cluster` privilege.
{: .note}

## Path and HTTP methods
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v

Typically, for any operation you can find out what headers are available using the `help` parameter, and then use the `h` parameter to limit the output to only the headers that you care about.

If you use the security plugin, make sure you have the appropriate permissions.
If you use the Security plugin, make sure you have the appropriate permissions.
{: .note }
2 changes: 1 addition & 1 deletion _api-reference/index-apis/clear-index-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 320
The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes.


If you use the security plugin, you must have the `manage index` privileges.
If you use the Security plugin, you must have the `manage index` privileges.
{: .note}

### Path parameters
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ redirect_from:

The index API operations let you interact with indices in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations.

If you use the security plugin, make sure you have the appropriate permissions.
If you use the Security plugin, make sure you have the appropriate permissions.
{: .note }
2 changes: 1 addition & 1 deletion _api-reference/nodes-apis/nodes-hot-threads.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,4 @@ Then information about threads of the selected type is provided.

## Required permissions

If you use the security plugin, make sure you set the following permissions: `cluster:monitor/nodes/hot_threads`.
If you use the Security plugin, make sure you set the following permissions: `cluster:monitor/nodes/hot_threads`.
2 changes: 1 addition & 1 deletion _api-reference/nodes-apis/nodes-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,4 @@ aggregations | Information about the available aggregation types.

## Required permissions

If you use the security plugin, make sure you have the appropriate permissions: `cluster:monitor/nodes/info`.
If you use the Security plugin, make sure you have the appropriate permissions: `cluster:monitor/nodes/info`.
2 changes: 1 addition & 1 deletion _api-reference/nodes-apis/nodes-reload-secure.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ The following is an example response:

## Required permissions

If you use the security plugin, make sure you set the following permissions: `cluster:manage/nodes`.
If you use the Security plugin, make sure you set the following permissions: `cluster:manage/nodes`.
2 changes: 1 addition & 1 deletion _api-reference/nodes-apis/nodes-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -978,4 +978,4 @@ enforced | Boolean | If true, the shard indexing pressure runs in enforced mode

## Required permissions

If you use the security plugin, make sure you have the appropriate permissions: `cluster:monitor/nodes/stats`.
If you use the Security plugin, make sure you have the appropriate permissions: `cluster:monitor/nodes/stats`.
2 changes: 1 addition & 1 deletion _api-reference/nodes-apis/nodes-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ The following is an example response:

## Required permissions

If you use the security plugin, make sure you set the following permissions: `cluster:manage/nodes` or `cluster:monitor/nodes`.
If you use the Security plugin, make sure you set the following permissions: `cluster:manage/nodes` or `cluster:monitor/nodes`.
2 changes: 1 addition & 1 deletion _api-reference/snapshots/get-snapshot-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Returns details about a snapshot’s state during and after snapshot creation.

To learn about snapshot creation, see [Create snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot).

If you use the security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges.
If you use the Security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges.
{: .note}

### Path parameters
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/snapshots/verify-snapshot-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Verifies that a snapshot repository is functional. Verifies the repository on ea

If verification is successful, the verify snapshot repository API returns a list of nodes connected to the snapshot repository. If verification failed, the API returns an error.

If you use the security plugin, you must have the `manage cluster` privilege.
If you use the Security plugin, you must have the `manage cluster` privilege.
{: .note}

### Path parameters
Expand Down
2 changes: 1 addition & 1 deletion _clients/java-rest-high-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can now start your OpenSearch cluster. The OpenSearch 1.x high-level REST cl

## Security

Before using the REST client in your Java application, you must configure the application's truststore to connect to the security plugin. If you are using self-signed certificates or demo configurations, you can use the following command to create a custom truststore and add in root authority certificates.
Before using the REST client in your Java application, you must configure the application's truststore to connect to the Security plugin. If you are using self-signed certificates or demo configurations, you can use the following command to create a custom truststore and add in root authority certificates.

If you're using certificates from a trusted Certificate Authority (CA), you don't need to configure the truststore.

Expand Down
2 changes: 1 addition & 1 deletion _clients/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can now start your OpenSearch cluster.

## Security

Before using the REST client in your Java application, you must configure the application's truststore to connect to the security plugin. If you are using self-signed certificates or demo configurations, you can use the following command to create a custom truststore and add in root authority certificates.
Before using the REST client in your Java application, you must configure the application's truststore to connect to the Security plugin. If you are using self-signed certificates or demo configurations, you can use the following command to create a custom truststore and add in root authority certificates.

If you're using certificates from a trusted Certificate Authority (CA), you don't need to configure the truststore.

Expand Down
2 changes: 1 addition & 1 deletion _dashboards/branding.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ You can continue using the top header bar in the default view for custom navigat

## Sample configuration

The following configuration enables the security plugin and SSL within OpenSearch Dashboards and uses custom branding elements to replace the OpenSearch logo and application title.
The following configuration enables the Security plugin and SSL within OpenSearch Dashboards and uses custom branding elements to replace the OpenSearch logo and application title.

```yml
server.host: "0"
Expand Down
2 changes: 1 addition & 1 deletion _dashboards/discover/multi-data-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A data source connection specifies the parameters needed to connect to a data so

To create a new data source connection:

1. Open Dashboards. If you’re not running the security plugin, go to [`http://localhost:5601`](http://localhost:5601/). If you’re running the security plugin, go to [`https://localhost:5601`](https://localhost:5601/) and log in with the username `admin` and password `admin`.
1. Open Dashboards. If you’re not running the Security plugin, go to [`http://localhost:5601`](http://localhost:5601/). If you’re running the Security plugin, go to [`https://localhost:5601`](https://localhost:5601/) and log in with the username `admin` and password `admin`.

1. Under **Management** in the OpenSearch Dashboards main menu, choose **Stack Management**, **Data Sources `Experimental`**, **Data Sources**, and then choose **Create data source connection**, as shown in the following image.

Expand Down
2 changes: 1 addition & 1 deletion _dashboards/reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 70

# Creating reports with the Dashboards interface

You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [security plugin]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).
You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [Security plugin]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).

CSV reports have a non-configurable 10,000 row limit. They have no explicit size limit (for example, MB), but extremely large documents could cause report generation to fail with an out of memory error from the V8 JavaScript engine.
{: .tip }
Expand Down
4 changes: 2 additions & 2 deletions _dashboards/visualize/visbuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ vis_builder.enabled: false
Follow these steps to create a new visualization using VisBuilder in your environment:

1. Open Dashboards:
- If you're not running the security plugin, go to http://localhost:5601.
- If you're running the security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).
- If you're not running the Security plugin, go to http://localhost:5601.
- If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).

2. Confirm that the **Enable experimental visualizations** option is turned on.
- From the top menu, select **Management** **>** **Stack Management** **>** **Advanced Settings**.
Expand Down
2 changes: 1 addition & 1 deletion _data-prepper/pipelines/configuration/sinks/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following table describes options you can configure for the `opensearch` sin
Option | Required | Type | Description
:--- | :--- | :--- | :---
hosts | Yes | List | List of OpenSearch hosts to write to (for example, `["https://localhost:9200", "https://remote-cluster:9200"]`).
cert | No | String | Path to the security certificate (for example, `"config/root-ca.pem"`) if the cluster uses the OpenSearch security plugin.
cert | No | String | Path to the security certificate (for example, `"config/root-ca.pem"`) if the cluster uses the OpenSearch Security plugin.
username | No | String | Username for HTTP basic authentication.
password | No | String | Password for HTTP basic authentication.
aws_sigv4 | No | Boolean | Default value is false. Whether to use AWS Identity and Access Management (IAM) signing to connect to an Amazon OpenSearch Service domain. For your access key, secret key, and optional session token, Data Prepper uses the default credential chain (environment variables, Java system properties, `~/.aws/credential`, etc.).
Expand Down
2 changes: 1 addition & 1 deletion _im-plugin/data-streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,4 +268,4 @@ You can use wildcards to delete more than one data stream.

We recommend deleting data from a data stream using an ISM policy.

You can also use [asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/index/), [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/), and [PPL]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index/) to query your data stream directly. You can also use the security plugin to define granular permissions for the data stream name.
You can also use [asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/index/), [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/), and [PPL]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index/) to query your data stream directly. You can also use the Security plugin to define granular permissions for the data stream name.
4 changes: 2 additions & 2 deletions _im-plugin/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ has_children: false

# Index management security

Using the security plugin with index management lets you limit non-admin users to certain actions. For example, you might want to set up your security such that a group of users can only read ISM policies, while others can create, delete, or change policies.
Using the Security plugin with index management lets you limit non-admin users to certain actions. For example, you might want to set up your security such that a group of users can only read ISM policies, while others can create, delete, or change policies.

All index management data are protected as system indices, and only a super admin or an admin with a Transport Layer Security (TLS) certificate can access system indices. For more information, see [System indices]({{site.url}}{{site.baseurl}}/security/configuration/system-indices).

## Basic permissions

The security plugin comes with one role that offers full access to index management: `index_management_full_access`. For a description of the role's permissions, see [Predefined roles]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).
The Security plugin comes with one role that offers full access to index management: `index_management_full_access`. For a description of the role's permissions, see [Predefined roles]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).

With security enabled, users not only need the correct index management permissions, but they also need permissions to execute actions to involved indices. For example, if a user wants to use the REST API to attach a policy that executes a rollup job to an index named `system-logs`, they would need the permissions to attach a policy and execute a rollup job, as well as access to `system-logs`.

Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ action.auto_create_index: true
compatibility.override_main_response_version: true
```
The demo configuration includes a number of settings for the security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security/).
The demo configuration includes a number of settings for the Security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security/).
### (Optional) CORS header configuration
If you are working on a client application running against an OpenSearch cluster on a different domain, you can configure headers in `opensearch.yml` to allow for developing a local application on the same machine. Use [Cross Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) so your application can make calls to the OpenSearch API running locally. Add the following lines in your `custom-opensearch.yml` file (note that the "-" must be the first character in each line).
Expand Down
10 changes: 5 additions & 5 deletions _install-and-configure/install-opensearch/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ Before modifying any configuration files, it's always a good idea to save a back
# fail when you try to start the service.
discovery.type: single-node
# If you previously disabled the security plugin in opensearch.yml,
# If you previously disabled the Security plugin in opensearch.yml,
# be sure to re-enable it. Otherwise you can skip this setting.
plugins.security.disabled: false
```
Expand All @@ -239,7 +239,7 @@ Before modifying any configuration files, it's always a good idea to save a back
### Configure TLS
TLS certificates provide additional security for your cluster by allowing clients to confirm the identity of hosts and encrypt traffic between the client and host. For more information, refer to [Configure TLS Certificates]({{site.url}}{{site.baseurl}}/security-plugin/configuration/tls/) and [Generate Certificates]({{site.url}}{{site.baseurl}}/security-plugin/configuration/generate-certificates/), which are included in the [Security Plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/) documentation. For work performed in a development environment, self-signed certificates are usually adequate. This section will guide you through the basic steps required to generate your own TLS certificates and apply them to your OpenSearch host.
TLS certificates provide additional security for your cluster by allowing clients to confirm the identity of hosts and encrypt traffic between the client and host. For more information, refer to [Configure TLS Certificates]({{site.url}}{{site.baseurl}}/security-plugin/configuration/tls/) and [Generate Certificates]({{site.url}}{{site.baseurl}}/security-plugin/configuration/generate-certificates/), which are included in the [Security plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/) documentation. For work performed in a development environment, self-signed certificates are usually adequate. This section will guide you through the basic steps required to generate your own TLS certificates and apply them to your OpenSearch host.
1. Navigate to the directory where the certificates will be stored.
```bash
Expand All @@ -258,7 +258,7 @@ TLS certificates provide additional security for your cluster by allowing client
# replace the arguments passed to -subj so they reflect your specific host.
sudo openssl req -new -x509 -sha256 -key root-ca-key.pem -subj "/C=CA/ST=ONTARIO/L=TORONTO/O=ORG/OU=UNIT/CN=ROOT" -out root-ca.pem -days 730
```
1. Next, create the admin certificate. This certificate is used to gain elevated rights for performing administrative tasks relating to the security plugin.
1. Next, create the admin certificate. This certificate is used to gain elevated rights for performing administrative tasks relating to the Security plugin.
```bash
# Create a private key for the admin certificate.
sudo openssl genrsa -out admin-key-temp.pem 2048
Expand Down Expand Up @@ -337,7 +337,7 @@ TLS certificates provide additional security for your cluster by allowing client
Users are defined and authenticated by OpenSearch in a variety of ways. One method that does not require additional backend infrastructure is to manually configure users in `internal_users.yml`. See [YAML files]({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml/) for more information about configuring users. The following steps explain how to remove all demo users except for the `admin` user and how to replace the `admin` default password using a script.
1. Navigate to the security plugins tools directory.
1. Navigate to the Security plugins tools directory.
```bash
cd /usr/share/opensearch/plugins/opensearch-security/tools
```
Expand Down Expand Up @@ -462,4 +462,4 @@ sudo apt-get upgrade opensearch=<version>
- [OpenSearch configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuration/)
- [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/)
- [OpenSearch plugin installation]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/)
- [About the security plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/)
- [About the Security plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/)
Loading

0 comments on commit 8463c8f

Please sign in to comment.