
# 通过OpenSearch Dashboards访问集群
OpenSearch Dashboards是专为OpenSearch设计的可视化分析平台，适用于需要深度数据分析和交互式可视化的场景。CSS服务的OpenSearch集群默认集成开箱即用的OpenSearch Dashboards工具，无需安装部署即可一键启动。OpenSearch Dashboards不仅提供丰富的仪表盘构建能力和可视化工具，还深度整合了OpenSearch的统计分析功能，支持从数据探索到业务洞察的全流程分析。
CSS服务的OpenSearch Dashboards支持多种访问方式，不同访问方式登录OpenSearch集群的操作有差异，如[表1]所示。
 表1通过OpenSearch Dashboards登录OpenSearch集群的方式 
| OpenSearch Dashboards访问方式    | 使用约束                                                                                                                                                                                                                                                                                         | 参考文档                                                                                                                                                     |
|:---|:---|:---|
| 控制台一键访问OpenSearch Dashboards | 无。                                                                                                                                                                                                                                                                                           | [通过控制台访问OpenSearch Dashboards登录OpenSearch集群] |
| 公网地址访问OpenSearch Dashboards  | - 仅安全模式的集群支持通过Dashboards公网访问地址访问OpenSearch Dashboards。   | [通过公网地址访问OpenSearch Dashboards登录OpenSearch集群]                           |
| 内网地址访问OpenSearch Dashboards  | 访问OpenSearch Dashboards的客户端地址和OpenSearch Dashboards的内网地址之间的网络必须是互通的。                                                                                                                                                                                                                         | [通过内网地址访问OpenSearch Dashboards登录OpenSearch集群]                           |
   
#### OpenSearch Dashboards使用限制
OpenSearch Dashboards中可以自定义用户名、角色名、租户名等，不能包含中文字符。
 #### 通过控制台访问OpenSearch Dashboards登录OpenSearch集群
1. 登录[云搜索服务管理控制台](https://console.huaweicloud.com/elasticsearch/)。
2. 在左侧导航栏，选择"集群管理 \> OpenSearch"。
3. 在集群列表，选择目标集群，单击操作列的"Dashboards"，登录OpenSearch Dashboards。
   - 非安全模式的集群：将直接进入OpenSearch Dashboards操作页面。
   
   - 安全模式的集群：需要在登录页面输入用户名和密码，单击"Log In"进入OpenSearch Dashboards操作页面。用户名默认为**admin**，密码为创建集群时设置的管理员密码。
    
4. 登录成功后，可在OpenSearch Dashboards页面进行相关操作访问集群。
 
 #### 通过公网地址访问OpenSearch Dashboards登录OpenSearch集群
![](https://support.huaweicloud.com/usermanual-css/public_sys-resources/warning_3.0-zh-cn.png)
- 仅安全模式的集群支持通过Dashboards公网访问地址访问OpenSearch Dashboards。

- Dashboards公网访问配置的白名单依赖ELB的白名单能力。更新白名单后，白名单对新建的连接是实时生效的，但对于已存在的长连接，可能会出现去掉的白名单IP地址还能访问OpenSearch Dashboards的场景，这是因为要等长连接断开后才生效，预计1分钟左右。
- 当关闭Dashboards公网访问后再重新打开，Dashboards的公网地址可能会发生变化，请谨慎操作。
 
1. 登录[云搜索服务管理控制台](https://console.huaweicloud.com/elasticsearch/)。
2. 在左侧导航栏，选择"集群管理 \> OpenSearch"。
3. 在集群列表，单击目标集群名称，进入集群详情页。
4. 选择"访问配置 \> Dashboards公网访问"，查看集群是否开启Dashboards公网访问。
   - 是，执行[6]。
   
   - 否，执行下一步。
    
5. 开启OpenSearch集群的Dashboards公网访问。
   1. 在"Dashboards公网访问"页面，单击右侧开关，打开Dashboards公网访问功能。
   
   2. 在"开启Dashboards公网访问"页面，配置相关参数。
      表2配置Dashboards公网访问 
      | 参数      | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
      |:---|:---|
      | 带宽      | 设置OpenSearch Dashboards公网访问的带宽。 取值范围：1Mbit/s\~200Mbit/s                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
      | 设置访问白名单 | 通过设置访问白名单实现Dashboards公网访问控制。 - 设置访问白名单，则表示只允许白名单列表中的IP地址或网段通过公网访问集群OpenSearch Dashboards。 单击"添加"，输入允许公网访问集群OpenSearch Dashboards的IP地址或网段（CIDR格式），以英文逗号分隔，不可重复。例如输入"192.168.1.1,10.0.0.0/24"，不支持"0.0.0.0"、"xx.xx.xx.xx/0"、"172.16.0.0-172.16.255.255"、非标准格式（如"192.168.1"）或重复项。   - 不设置访问白名单，则表示所有公网IP地址都可以访问集群OpenSearch Dashboards。此时会有安全风险，不推荐。   |
         
      
   
   3. 配置完成后，单击"确定"，开启Dashboards公网访问。
   
   
   如果集群已配置Dashboards公网访问，也支持修改相关配置。
   
6. 开启Dashboards公网访问后，在Dashboards公网访问页面获取"Dashboards公网访问地址"。
   图1获取Dashboards公网访问地址   
   ![](https://support.huaweicloud.com/usermanual-css/figure/zh-cn_image_0000001956059228.png "点击放大") 
7. 在浏览器中，输入"Dashboards公网访问地址"即可进入OpenSearch Dashboards登录页面。 在登录页面输入用户名和密码，单击"Log In"进入OpenSearch Dashboards操作页面。用户名默认为**admin**，密码为创建集群时设置的管理员密码。
   
8. 登录成功后，可在OpenSearch Dashboards页面进行相关操作访问OpenSearch集群。
 
 #### 通过内网地址访问OpenSearch Dashboards登录OpenSearch集群
![](https://support.huaweicloud.com/usermanual-css/public_sys-resources/caution_3.0-zh-cn.png)
访问OpenSearch Dashboards的客户端地址和OpenSearch Dashboards的内网地址之间的网络必须是互通的。
1. 登录[云搜索服务管理控制台](https://console.huaweicloud.com/elasticsearch/)。
2. 在左侧导航栏，选择"集群管理 \> OpenSearch"。
3. 在集群列表，单击目标集群名称，进入集群详情页。
4. 选择"概览"页签，在"网络信息"下方，获取并记录"内网访问IPv4地址"。
5. 获取OpenSearch Dashboards的内网地址。 将集群的内网访问地址的端口号从"9200"改为"5601"，即为OpenSearch Dashboards的内网地址。例如，集群的"内网访问IPv4地址"是"xx.xx.xx.xx:9200"，则OpenSearch Dashboards的内网地址为"xx.xx.xx.xx:5601"。
   
6. （可选）配置回程路由。当客户端访问OpenSearch Dashboards时，如果客户端的地址和OpenSearch Dashboards的内网地址位于不同VPC网络，需要配置OpenSearch集群路由打通网络。
   1. 通过专线或对等连接打通客户端和OpenSearch Dashboards内网之间的网络。
   
   2. 在OpenSearch集群中添加客户端的路由信息。 在集群概览页面，单击"集群路由"的"添加路由"。输入客户端的子网地址和子网掩码。
      
   
   
   详细操作指导请参见[配置集群路由](https://support.huaweicloud.com/usermanual-css/css_01_0280.html)。
   
7. 访问OpenSearch Dashboards。
   - OpenSearch开启安全模式，OpenSearch Dashboards访问地址是"https://{Dashboards内网地址}"，如"https://xx.xx.xx.xx:5601"。
   
   - OpenSearch未开启安全模式，OpenSearch Dashboards访问地址是"http://{Dashboards内网地址}"，如"http://xx.xx.xx.xx:5601"。
    
 
#### 更多功能：支持自定义OpenSearch Dashboards的Base Path
在多集群管理场景中，OpenSearch Dashboards默认的根路径访问方式可能无法满足安全鉴权和请求校验需求。CSS服务支持在控制台自定义OpenSearch Dashboards Base Path配置，使您能够为不同集群设置专属访问路径，实现细粒度的访问控制，简化多集群管理流程，提升整体系统安全性。
1. 登录[云搜索服务管理控制台](https://console.huaweicloud.com/elasticsearch/)。
2. 在左侧导航栏，选择"集群管理 \> OpenSearch"。
3. 在集群列表，单击目标集群名称，进入集群详情页。
4. 选择"集群配置 \> 参数配置 \> Dashboards配置"。
5. 单击"编辑"，配置参数值。
   表3配置Base Path 
   | 参数                     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   |:---|:---|
   | server.basePath        | 自定义Base Path的参数值。 当需要通过反向代理（如Nginx）访问OpenSearch Dashboards时，此参数值将会作为一个子路径跟在代理地址后面。例如反向代理的地址是"http://example.com"，"server.basePath"是"/test"，则通过地址"http://example.com/test"即可访问OpenSearch Dashboards。 取值范围： - 必须以"/"开头。  - 不能有连续的斜杠（如"//"）。  - 只能包含字母、数字、短横线"-"、下划线"_"、点"."和"/"。  - 允许多层路径，但长度不能超过254字符。  - 不能以"/"结尾。   |
   | server.rewriteBasePath | 指定由OpenSearch Dashboards还是反向代理移除请求路径中server.basePath前缀。 可选配置，如果没有使用反向代理访问OpenSearch Dashboards的需求，则忽略此参数。 取值范围： - true，表示OpenSearch Dashboards会自动移除请求路径中的server.basePath前缀。  - false（默认值），表示需要由反向代理（如Nginx）来移除请求路径中的server.basePath前缀。此时只能通过反向代理访问OpenSearch Dashboards。                                                                                                                                                                                                                                                                                                                                                          |
      
   
6. 修改完成后，单击"保存"，在弹窗中确认参数无误后勾选"修改Dashboards配置会自动重启Dashboards进程，期间可能短暂影响Dashboards访问。请稍后重试。"，单击"确定"。 当下方的参数配置任务列表显示"作业状态"为"成功"时，表示参数修改成功。系统最多显示1000条修改记录。
   
7. 访问OpenSearch Dashboards。
   - 通过**Dashboards内网地址** 访问OpenSearch Dashboards
     - OpenSearch开启安全模式，"server.rewriteBasePath"为"true"，OpenSearch Dashboards内外网访问地址是"https://{Dashboards内网地址}{server.basePath}"，如"https://xx.xx.xx.xx:5601/test"。
     
     - OpenSearch开启安全模式，"server.rewriteBasePath"为"false"，只能通过反向代理访问OpenSearch Dashboards。
     
     - OpenSearch未开启安全模式，"server.rewriteBasePath"为"true"，OpenSearch Dashboards只支持内网访问，地址是"http://{Dashboards内网地址}{server.basePath}"，如"http://xx.xx.xx.xx:5601/test"。
     
     - OpenSearch未开启安全模式，"server.rewriteBasePath"为"false"，只能通过反向代理访问OpenSearch Dashboards。
      
   
   - 通过**Dashboards公网访问地址** 访问OpenSearch Dashboards（依赖集群开启Dashboards公网访问）
     - "server.rewriteBasePath"为"true"，OpenSearch Dashboards公网访问地址是"https://{Dashboards公网访问地址}{server.basePath}"，如"https://xx.xx.xx.xx:5601/test"。
     
     - "server.rewriteBasePath"为"false"，只能通过反向代理访问OpenSearch Dashboards。
      
   
   - 通过**反向代理服务器地址** 访问OpenSearch Dashboards
     OpenSearch Dashboards访问地址是"http://{反向代理服务器地址}{server.basePath}"，如"http://xx.xx.xx.xx:port/test"。是否支持公网访问取决于反向代理服务器地址是否为公网IP。此方案依赖反向代理服务器配置，详细配置指导请参见[使用Nginx统一管理多集群的Kibana和Dashboards](https://support.huaweicloud.com/bestpractice-css/css_07_0005.html)。
     
    
 
#### 相关文档
- 如果需要使用自建OpenSearch Dashboards访问CSS服务的OpenSearch集群，请参见[自建OpenSearch Dashboards如何对接CSS服务的OpenSearch集群？](https://support.huaweicloud.com/css_faq/css_02_0152.html)
- 对于日常运维场景（如分片调整、索引管理、性能监控等），推荐使用Cerebro登录集群，请参见[通过Cerebro访问集群](https://support.huaweicloud.com/usermanual-css/css_01_0029.html)。
 
