Connecting to Cluster Through OpenSearch Dashboards
OpenSearch Dashboards is the data visualization and exploration platform for OpenSearch. It enables in-depth data analysis and interactive visualization. In CSS, OpenSearch Dashboards is pre-built for each OpenSearch cluster. You can start OpenSearch Dashboards with one click, without installing anything. OpenSearch Dashboards offers a comprehensive suite of dashboard features and visualization tools. It seamlessly integrates OpenSearch's analytical capabilities, supporting the full analytics process from data exploration to actionable business insights.
OpenSearch Dashboards supports multiple access methods. Steps needed to log in to an OpenSearch cluster vary depending on the access method you choose. See Table 1.
| OpenSearch Dashboards Access Method | Constraints | Details |
|---|---|---|
| One-click access to OpenSearch Dashboards from the service console | N/A | Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Through the Console |
| Accessing OpenSearch Dashboards using a private IP address | The client that accesses OpenSearch Dashboards must be able to reach the private IP address of OpenSearch Dashboards. |
Constraints Concerning the Use of OpenSearch Dashboards
You can customize the username, role name, and tenant name in OpenSearch Dashboards.
Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Through the Console
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters > OpenSearch.
- In the cluster list, find the target cluster, and click Dashboards in the Operation column to log in to OpenSearch Dashboards.
- Non-security mode cluster: The OpenSearch Dashboards console is displayed.
- Security-mode cluster: Enter the username and password on the login page and click Log In to go to the OpenSearch Dashboards console. The default username is admin and the password is the one specified during cluster creation.
- After logging in, you can use OpenSearch Dashboards to manage the cluster.
Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Using a Private Network Address
The client that accesses OpenSearch Dashboards must be able to reach the private IP address of OpenSearch Dashboards.
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters > OpenSearch.
- In the cluster list, click the name of the target cluster. The cluster information page is displayed.
- Click the Overview tab. In the Network Information area, record Private IPv4 Address.
- Obtain the private IP address of OpenSearch Dashboards.
By changing the port number in the cluster's private IP address from 9200 to 5601, you get the private IP address of OpenSearch Dashboards. For example, if the cluster's private IPv4 address is xx.xx.xx.xx:9200, the private IP address of OpenSearch Dashboards is xx.xx.xx.xx:5601.
- (Optional) Configure a return route. To enable a client to access the cluster's OpenSearch Dashboards console across different VPCs, configure a route for the OpenSearch cluster.
- Connect the client and OpenSearch Dashboards through a Direct Connect or VPC peering connection.
- Configure the route connecting the OpenSearch cluster and the client.
On the Overview tab, find Cluster Route in the Network Information area, and click Add Route under it. In the displayed dialog box, set IP Address and Subnet Mask.
- Access OpenSearch Dashboards.
- If the security mode is enabled for an OpenSearch cluster, the OpenSearch Dashboards access address is https://{Dashboards private network address}, for example, https://xx.xx.xx.xx:5601.
- If the security mode is disabled, the OpenSearch Dashboards access address is http://{Dashboards private network address}, for example, http://xx.xx.xx.xx:5601.
Related Documents
- For how to use in-house developed OpenSearch Dashboards to access OpenSearch clusters in CSS, see How Do I Connect In-house Developed OpenSearch Dashboards to an OpenSearch Cluster in CSS?.
- For routine O&M tasks (such as shard adjustment, index management, and performance monitoring), you are advised to use Cerebro for cluster login. For details, see Connecting to a Cluster Through Cerebro.
