Help Center/ Cloud Search Service/ User Guide/ Using OpenSearch for Data Search/ Accessing an OpenSearch Cluster/ Logging In to an OpenSearch Cluster Using OpenSearch Dashboards
Updated on 2024-09-14 GMT+08:00

Logging In to an OpenSearch Cluster Using OpenSearch Dashboards

With CSS, OpenSearch clusters provide OpenSearch Dashboards by default. Users can access OpenSearch Dashboards in one click without installing anything. Additionally, OpenSearch clusters in CSS support the visualization and OpenSearch statistics analysis capabilities of the native OpenSearch Dashboards.

OpenSearch Dashboards supports multiple access methods. Steps needed to log in to an OpenSearch cluster vary depending on the access method you choose. For details, see Table 1.

Table 1 Methods for logging In to an OpenSearch cluster through OpenSearch Dashboards

Kibana 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 public IP address

  • Only clusters in security mode support OpenSearch Dashboards access through a public IP address.

Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Using a Public IP Address

Accessing OpenSearch Dashboards using a private network address

Only servers in the same VPC as an OpenSearch cluster can access OpenSearch Dashboards using a private network address.

Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Using a Private Network Address

Constraints Concerning the Use of OpenSearch Dashboards

You can customize the username, role name, and tenant name in OpenSearch Dashboards. Chinese characters are not allowed.

Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Through the Console

  1. Log in to the CSS management console.
  2. On the Clusters page, locate the target cluster and click Access Kibana in the Operation column to go to the OpenSearch Dashboards login page.
    • 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 administrator password you specified during cluster creation.
  3. After logging in, you can perform operations on the OpenSearch Dashboards page to access the cluster.

Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Using a Public IP Address

  • Only clusters in security mode support OpenSearch Dashboards access through a public IP address.
  1. Log in to the CSS management console.
  2. Enable Kibana public network access for the OpenSearch cluster. You can do that either when creating an Elasticsearch cluster or afterwards.
    • For how to enable Kibana public network access when creating an Elasticsearch cluster, see Creating an OpenSearch Cluster.
    • To enable public network access for Kibana for an existing cluster, perform the following steps:
      1. Choose Clusters in the navigation pane. On the Clusters page, click the name of the target cluster.
      2. Click the Kibana Public Access tab, and enable Kibana Public Access.
      3. On the displayed page, set parameters. If Kibana public network access is already enabled, you can modify relevant settings.
        Table 2 Configuring public network access for Kibana

        Parameter

        Description

        Bandwidth

        Bandwidth for accessing Kibana through a public IP address

        Value range: 1 to 100.

        Unit: Mbit/s

        Access Control

        If you disable this function, all IP addresses can access Kibana through the public IP address. If you enable this function, only IP addresses or IP address ranges in the whitelist can access Kibana through the public IP address.

        Whitelist

        IP addresses or IP address ranges allowed to access the cluster. Use commas (,) to separate multiple IP addresses or ranges. This parameter can be configured only when Access Control is enabled.

        You are advised to enable the whitelist.

        NOTE:

        The whitelist that controls Kibana public network access depends on whitelist support by the ELB service. After you update the whitelist, the new settings take effect immediately for new connections. For existing persistent connections using the IP addresses that have been removed from the whitelist, the new settings take effect in approximately 1 minute after these connections are disconnected.

      4. Click OK.
  3. After Kibana public network access is enabled, obtain the Kibana public IP address on the Kibana Public Access page.
    Figure 1 Obtaining the Kibana public IP address
  4. Enter the Kibana public IP address in the browser address box to go to the OpenSearch Dashboards login page.

    Enter the username and password on the login page and click Log In to log in to the OpenSearch Dashboards console. The default username is admin and the password is the administrator password you specified during cluster creation.

  5. After the login is successful, you can access the OpenSearch cluster through OpenSearch Dashboards.

Logging In to an OpenSearch Cluster by Accessing OpenSearch Dashboards Using a Private Network Address

Only servers in the same VPC as an OpenSearch cluster can access OpenSearch Dashboards using a private network address.

  1. Log in to the CSS management console.
  2. On the OpenSearch Clusters page, click the name of a cluster. The Cluster Information page is displayed.
  3. On the Cluster Information page, obtain the cluster's private network address.
    Figure 2 Obtaining the private IP address
  4. Change the port number in the cluster's private network address from 9200 to 5601, which becomes the private network address of OpenSearch Dashboards. For example, if the cluster's private network IPv4 address is 192.168.0.***:9200, the private network address of OpenSearch Dashboards is 192.168.0.***:5601.
  5. On the server, enter the private network address of OpenSearch Dashboards to go to the OpenSearch Dashboards login page.
    • 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 administrator password you specified during cluster creation.
  6. After the login is successful, you can access the OpenSearch cluster through OpenSearch Dashboards.