使用 a9s Elasticsearch¶
本部分介绍了开发者应该如何使用 a9s Elasticsearch。
在应用中使用 a9s Elasticsearch¶
要在应用中使用 a9s Elasticsearch,请创建服务实例并将服务实例绑定到应用中。有关管理服务实例的详细信息,请参见使用 cf CLI 管理服务实例。
查看 a9s Elasticsearch 服务¶
服务安装完成后,elasticsearch5
及其服务计划会显示在 CF marketplace 中。运行 cf marketplace
查看服务列表:
$ cf marketplace
Getting services from marketplace in org test / space test as admin...
OK
service plans description
elasticsearch5 elasticsearch-xs, elasticsearch-m, This is the anynines Elasticsearch 5 service.
创建服务实例¶
要配置 Elasticsearch 数据库,请运行 cf create-service
。例如:
cf create-service elasticsearch5 elasticsearch-xs my-elasticsearch-service
创建服务实例可能需要几分钟的时间,具体取决于您的基础架构和服务代理使用情况。
运行 cf services
命令可以查看创建状态。此命令将显示所有服务实例的列表。要查看特定服务实例的状态,请运行 cf service NAME-OF-YOUR-SERVICE
。
将应用绑定到服务实例¶
创建数据库后,运行 cf bind-service
将服务绑定到应用:
cf bind-service elasticsearch-app my-elasticsearch5-service
重新载入或重新启动应用¶
要使应用能够访问服务实例,请运行 cf restage
或 cf restart
来重新载入或重新启动应用。
获取服务实例访问凭证¶
将服务实例绑定到应用后,Elasticsearch 数据库的凭证将存储在应用的环境变量中。运行 cf env APP-NAME
显示环境变量。
可以从 VCAP_SERVICES 密钥中获取凭证。
cf env elasticsearch-app
Getting env variables for app elasticsearch-app in org test / space test as admin...
OK
System-Provided:
{
"VCAP_SERVICES": {
"elasticsearch5": [
{
"credentials": {
"host": [
"EXAMPLE_HOST"
],
"password":"EXAMPLE_USER",
"username":"EXAMPLE_PASSWORD"
},
"label": "elasticsearch5",
"name": "my-elasticsearch-service",
"plan": "elasticsearch-xs",
"tags": [
"searchengine"
]
}
]
}
}
...
您可以在 Elasticsearch 客户端使用 host、用户名和密码连接到数据库。
删除 Elasticsearch 服务实例¶
警告
在删除服务实例之前,必须对数据库中存储的数据进行备份。服务实例删除操作无法撤消,一旦服务删除,所有数据都将丢失。
必须先解除服务实例与所有应用之间的绑定,然后才能删除服务实例。
列出可用服务¶
运行 cf services
列出可用服务。
$ cf services
Getting services in org test / space test as admin...
OK
name service plan bound apps last operation
my-elasticsearch-service elasticsearch5 elasticsearch-xs elasticsearch-app create succeeded
在此示例中,将 my-elasticsearch-service
绑定到 elasticsearch-app
应用上。
解绑服务实例¶
运行 cf unbind-service
可以解除应用与服务间的绑定关系。
cf unbind-service elasticsearch-app my-elasticsearch-service
删除服务实例¶
解除绑定后,服务不再绑定在应用上。运行 cf delete-service
删除服务:
cf delete-service my-elasticsearch-service
删除服务可能需要几分钟的时间。删除服务会删除相应的基础架构资源。 运行 cf services
命令可以查看删除状态。
将服务实例升级到其它服务计划¶
服务实例创建后,您可以将其升级到其它较大的服务计划。较大的服务计划提供更多的 CPU、RAM 和存储资源。有关详细信息,请参见更新服务实例。
cf update-service my-elasticsearch-service -p a-bigger-plan
您可以根据当前使用的计划选择升级计划 :
- 如果您当前正在使用
elasticsearch-xs
计划,则可以升级到elasticsearch-m
计划。
添加 Graphite 端点¶
如果要使用 Graphite 来监控服务,您可以设置一个端点, 使用 cf update-service
命令可以向该端点发送信息。此命令需要提供 -c flag 和包含 graphite
与 metrics_prefix
键的 JSON 字符串。 metrics_prefix
可能会要求每个指标名称必须以 API 密钥开头,具体取决于您的 graphite 供应商。您还可以更改向端点发送数据的间隔。interval
默认为 10 秒。
cf update-service my-elasticsearch-service -c '{ "graphite": ["yourspace.your-graphite-endpoint.com:12345"], "metrics_prefix": "your-api-key.my-cluster-elasticsearch", "interval":"5"}'
添加 Syslog 端点¶
使用 cf update-service
命令与 -c flag 可以将 syslog 流式传输到第三方服务。在这种情况下,该命令需要一个包含 syslog
键的 JSON 字符串。您还可以使用用于指定 graphite interval
的键来更改 syslog 的间隔。
cf update-service my-elasticsearch-service -c '{ "syslog": ["logs4.your-syslog-endpoint.com:54321"], "interval":"5" }'
Cloud Foundry 应用安全组¶
本部分介绍了判断安全组是否已创建的方法。
每个 a9s 数据服务都将自动创建并更新 Cloud Foundry 安全组,以防止未在同一个 Cloud Foundry 应用空间中运行的应用访问该实例。 有关安全组的详细信息,请参见 了解应用安全组。
获取服务实例 GUID¶
运行 cf service INSTANCE_NAME --guid
获取服务实例的 GUID。
$ cf service my-elasticsearch --guid
ca16f111-5073-40b7-973a-156c75dd3028
检查可用的安全组¶
要查看所有可用的安全组,请使用 cf security-groups
。
$ cf security-groups
Getting security groups as demo@anynines.com
OK
Name Organization Space
#0 public_networks
#1 dns
#2 tcp_open
#3 guard_432fb752-876d-443b-a311-a075f4df2237 demonstrations demo
#4 guard_ca16f111-5073-40b7-973a-156c75dd3028 demonstrations demo
在此您可以看到一个名为 guard_ca16f111-5073-40b7-973a-156c75dd3028
的安全组已经创建成功。
说明
如果无法建立应用与服务实例之间的连接,请检查是否已创建安全组。
备份和恢复服务实例,下载备份¶
a9s Elasticsearch 可以轻松地创建和恢复备份。
获取仪表盘地址、登录和授权¶
- 使用
cf service SERVICE-NAME
获取仪表盘 URL:
$ cf service my-elasticsearch
Service instance:my-elasticsearch
Service:elasticsearch
Bound apps:
Tags:
Plan:elasticsearch-xs
description: This is a service creating and managing dedicated Elasticsearch service instances and clusters, powered by the anynines Service Framework
Documentation url:
Dashboard:https://elasticsearch-dashboard.aws.ie.apps.eu1.mindsphere.io/service-instances/ca16f111-5073-40b7-973a-156c75dd3028
Last Operation
Status:update succeeded
Message:
Started:2017-10-26T08:28:38Z
Updated:2017-10-26T08:28:38Z
- 在浏览器中输入仪表盘 URL,然后通过“使用 WebKey 登录”方法在重定向的页面上进行身份验证:
- 单击 **授权**以批准授权请求:
执行备份¶
如上所示,您可以单击仪表盘上的 **触发备份**来进行备份。
随后,备份将进行排队。很快就可以开始备份。
说明
备份所需时间取决于数据的大小。
还原备份¶
再次打开仪表盘并选择要还原的备份。 单击备份的 **还原**按钮。随后将触发还原。
说明
备份还原的所需时间取决于数据的大小。
下载备份¶
要下载已执行的备份,首先必须设置个人加密密钥。否则,执行的备份无法下载。
要设置个人加密密钥,请打开相应服务实例的服务仪表盘,如上图所示。单击 编辑 按钮。
设置加密秘钥并单击**保存** 按钮。加密密钥的最小长度为8个字符。
新创建的备份现在将显示一个**下载** 按钮。 单击此按钮下载备份。
Note
如果更改了个人加密密钥,将无法再下载使用旧的个人加密密钥加密的已执行备份。
使服务实例在本地可用¶
任何 a9s 数据服务都可以在本地访问。也就是说您可以将本地客户端连接到服务,实施调试等多种操作。 CF 提供了一种创建 SSH 正向通道的智能方法,即通过推送应用来实现。 有关此功能的详细信息,请参见使用 SSH 访问应用。
首先,您必须将应用绑定到服务。请参见将应用绑定到服务实例了解具体绑定方法。
说明
必须在平台中启用 cf ssh
支持。如果不确定,请咨询管理员。
获取服务 URL 和凭证¶
请参照获取服务实例访问凭证中的说明获取服务的 hostname 和用户凭证。
$ cf env elasticsearch-app
Getting env variables for app elasticsearch-app in org test / space test as admin...
OK
System-Provided:
{
"VCAP_SERVICES": {
"elasticsearch5": [
{
"credentials": {
"host": [
"d67901c.service.dc1.a9svs"
],
"password": "brk-usr",
"username": "password"
},
"label": "elasticsearch5",
"name": "my-elasticsearch-service",
"plan": "elasticsearch-xs"
}
]
}
}
...
请记住 host 是 d67901c.service.dc1.a9svs
,用户名是 brk-usr
,密码是 password
。在下一步骤中将用到这些信息。
创建连接服务的通道¶
使用前面提到的 cf ssh
可以创建一个连接管理仪表盘的 ssh 正向通道。 使用端口 9200 连接 a9s Elasticsearch 实例。
$ cf ssh elasticsearch-app -L 9200:d67901c.service.dc1.a9svs:9200
vcap@956aaf4e-6da9-4f69-4b1d-8e631a403312:~$
当 ssh 通道打开时,您可以通过地址 localhost:9200
访问该实例。
说明
不要忘记用 exit
关闭会话。