Help Center/ Cloud Search Service/ FAQs/ Accessing CSS Clusters/ How Do I Connect In-house Developed OpenSearch Dashboards to an OpenSearch Cluster in CSS?
Updated on 2025-09-04 GMT+08:00

How Do I Connect In-house Developed OpenSearch Dashboards to an OpenSearch Cluster in CSS?

Constraints

Only OpenSearch Dashboards images of the OSS version can be connected to OpenSearch clusters in CSS.

Procedure

  1. Create an ECS.
    • The ECS must be within the same VPC as the CSS cluster.
    • Port 5601 must be allowed by the security group associated with the ECS.
    • An EIP must be allocated to the ECS.

    For details, see Purchasing an ECS.

  2. Obtain the address for accessing the OpenSearch cluster of CSS.
    1. Log in to the CSS management console.
    2. In the navigation pane on the left, choose Clusters > OpenSearch.
    3. In the cluster list, obtain the target cluster's private IP address from the Private IP Address column. Generally, the IP address format is <host>:<port> or <host>:<port>,<host>:<port>.

      If the cluster has only one node, the IP address and port number of this one node are displayed, for example, 10.62.179.32:9200. If the cluster has multiple nodes, the IP addresses and port numbers of all nodes are displayed, for example, 10.62.179.32:9200,10.62.179.33:9200.

  3. Install OpenSearch Dashboards on the ECS and modify the configuration file.
    • The following is an example of the configuration file for a security-mode cluster:
      opensearch.username: "***" //Username of the security cluster
      opensearch.password: "***" //Password of the security cluster
      opensearch.ssl.verificationMode: none
      server.ssl.enabled: false
      server.rewriteBasePath: false
      server.port: 5601
      logging.dest: /home/Ruby/log/kibana.log
      pid.file: /home/Ruby/run/kibana.pid
      server.host: 192.168.xxx.xxx  //IP address or DNS name of the OpenSearch Dashboards server. localhost is recommended.
      opensearch.hosts: http://10.0.0.xxx:9200   //Address for accessing the OpenSearch cluster
      opensearch.requestHeadersWhitelist: ["securitytenant","Authorization"]
      opensearch_security.multitenancy.enabled: true
      opensearch_security.multitenancy.tenants.enable_global: true
      opensearch_security.multitenancy.tenants.enable_private: true
      opensearch_security.multitenancy.tenants.preferred: ["Private", "Global"]
      opensearch_security.multitenancy.enable_filter: false

      To access a security-mode cluster, the opendistro_security_kibana plug-in must be installed. For details, see security-kibana-plugin. The plug-in version must be the same as that of the cluster. To check the plug-in version, run the GET _cat/plugins command.

    • The following is an example of the configuration file for a non-security mode cluster:
      server.port: 5601
      logging.dest: /home/Ruby/log/opensearch-dashboards.log
      pid.file: /home/Ruby/run/opensearch-dashboards.pid
      server.host: 192.168.xxx.xxx  //IP address or DNS name of the OpenSearch Dashboards server. localhost is recommended.
      opensearch.hosts: http://10.0.0.xxx:9200   //Address for accessing the OpenSearch cluster
  4. Use a browser on your local PC to connect to the EIP associated with the ECS. The URL is http://EIP:5601. Log in to OpenSearch Dashboards to access the OpenSearch cluster.