使用外部 TCP 服务

描述基于 Istio 的 Bookinfo 示例的简单场景。

Feb 6, 2018 | By Vadim Eisenberg

在我之前的博客文章使用外部 Web 服务中,我描述了如何通过 HTTPS 在网格 Istio 应用程序中使用外部服务,在这篇文章中,我演示了通过 TCP 使用外部服务。你会用到 Istio Bookinfo 示例应用程序,这是将书籍评级数据保存在 MySQL 数据库中的版本。你会在集群外部署此数据库并配置 ratings 服务以使用它,你还会定义服务 Entry 以允许网格内应用程序访问外部数据库。

Bookinfo 示例应用程序与外部评级数据库

首先,在 Kubernetes 集群之外设置了一个 MySQL 数据库实例来保存 Bookinfo 评级数据,然后修改 Bookinfo 示例应用程序以使用这个数据库。

为评级数据设置数据库

为此,你设置了 MySQL 的实例,你可以使用任何 MySQL 实例; 我使用 Compose for MySQL,我使用 mysqlshMySQL Shell)作为 MySQL 客户端来提供评级数据。

  1. 设置 MYSQL_DB_HOSTMYSQL_DB_PORT 环境变量。

    $ export MYSQL_DB_HOST=<你的 MySQL host>
    $ export MYSQL_DB_PORT=<你的 MySQL port>
    

    如果你使用的是本地数据库,使用的是默认 MYSQL port,那 hostport 分别是 localhost3306

  2. 初始化数据库时,如果出现提示,执行下面的命令输入密码。这个命令通过 admin 数据库用户凭证来执行。这个 admin 用户是通过 Compose for Mysql 创建数据库时默认存在的。

    $ curl -s https://raw.githubusercontent.com/istio/istio/release-1.10/samples/bookinfo/src/mysql/mysqldb-init.sql | mysqlsh --sql --ssl-mode=REQUIRED -u admin -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT
    

    或者

    使用 mysql 客户端和本地 MySQL 数据库时,运行:

    $ curl -s https://raw.githubusercontent.com/istio/istio/release-1.10/samples/bookinfo/src/mysql/mysqldb-init.sql | mysql -u root -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT
    
  3. 创建一个名为 bookinfo 的用户,并在 test.ratings 表上授予它 SELECT 权限:

    $ mysqlsh --sql --ssl-mode=REQUIRED -u admin -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "CREATE USER 'bookinfo' IDENTIFIED BY '<password you choose>'; GRANT SELECT ON test.ratings to 'bookinfo';"
    

    或者

    对于 mysql 和本地数据库,命令是:

    $ mysql -u root -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "CREATE USER 'bookinfo' IDENTIFIED BY '<password you choose>'; GRANT SELECT ON test.ratings to 'bookinfo';"
    

    在这里,你会应用最小特权原则,这意味着不在 Bookinfo 应用程序中使用 admin 用户。相反,你为应用程序 Bookinfo 创建了一个最小权限的特殊用户 bookinfo,在这种情况下,bookinfo 用户只对单个表具有 SELECT 特权。

    在运行命令创建用户之后,你可能会想通过检查最后一个命令的编号并运行 history -d <创建用户的命令编号> 来清理我的 bash 历史记录。你可能不希望新用户的密码存储在 bash 历史记录中,如果你使用了 mysql 命令行工具,记得要删除 ~/.mysql_history 文件中的最后一个命令。在 MySQL 文档中阅读有关新创建用户的密码保护的更多信息。

  4. 检查创建的评级,看看一切都按预期工作:

    $ mysqlsh --sql --ssl-mode=REQUIRED -u bookinfo -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "select * from test.ratings;"
    Enter password:
    +----------+--------+
    | ReviewID | Rating |
    +----------+--------+
    |        1 |      5 |
    |        2 |      4 |
    +----------+--------+
    

    或者

    对于 mysql 和本地数据库:

    $ mysql -u bookinfo -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "select * from test.ratings;"
    Enter password:
    +----------+--------+
    | ReviewID | Rating |
    +----------+--------+
    |        1 |      5 |
    |        2 |      4 |
    +----------+--------+
    
  5. 暂时将评级设置为1,以便在 Bookinfo ratings 服务使用我们的数据库时提供可视线索:

    $ mysqlsh --sql --ssl-mode=REQUIRED -u admin -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "update test.ratings set rating=1; select * from test.ratings;"
    Enter password:
    
    Rows matched: 2  Changed: 2  Warnings: 0
    +----------+--------+
    | ReviewID | Rating |
    +----------+--------+
    |        1 |      1 |
    |        2 |      1 |
    +----------+--------+
    

    对于mysql和本地数据库:

    $ mysql -u root -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "update test.ratings set rating=1; select * from test.ratings;"
    Enter password:
    +----------+--------+
    | ReviewID | Rating |
    +----------+--------+
    |        1 |      1 |
    |        2 |      1 |
    +----------+--------+
    

    在最后一个命令中使用了 admin 用户(和 root 用于本地数据库),因为 bookinfo 用户在 test.ratings 表上没有 UPDATE 权限。

现在你已经可以去部署使用外部数据库的 Bookinfo 应用程序版本了。

Bookinfo 应用程序的初始设置

为了演示使用外部数据库的场景,你首先使用安装了 Istio 的 Kubernetes 集群,然后部署 Istio Bookinfo 示例应用程序应用默认的 destination rule将 Istio 默认策略修改为禁止 Egress

此应用程序使用 ratings 微服务来获取书籍评级,评分在 1 到 5 之间。评级显示为每个评论的星号,有几个版本的 ratings 微服务。有些人使用 MongoDB,有些使用 MySQL 作为他们的数据库。

这篇博客例子里的命令是以 Istio 0.8 以上版本为基础的,无论启用或不启用双向 TLS

提醒一下,这是 Bookinfo 示例应用程序中应用程序的原始整体架构图。

原始的 Bookinfo 应用程序
原始的 Bookinfo 应用程序

将数据库用于 Bookinfo 应用程序中的评级数据

  1. 修改使用 MySQL 数据库的 ratings 服务版本的 deployment spec,以使用你的数据库实例。该 spec 位于 Istio 发行档案的 samples/bookinfo/platform/kube/bookinfo-ratings-v2-mysql.yaml 中。编辑以下几行:

    - name: MYSQL_DB_HOST
      value: mysqldb
    - name: MYSQL_DB_PORT
      value: "3306"
    - name: MYSQL_DB_USER
      value: root
    - name: MYSQL_DB_PASSWORD
      value: password
    

    替换上面代码段中的值,指定数据库主机,端口,用户和密码,请注意,在 Kubernetes 中使用容器环境变量中密码的正确方法是 使用 secret,仅对于此示例任务,你可能会在 deployment spec 中直接配置明文的密码,切记!不要在真实环境中这样做!我想你们应该也知道,"password" 这个值也不应该用作密码。

  2. 应用修改后的 spec 来部署使用外部数据库的 ratings 服务,v2-mysql 的版本。

    Zip
    $ kubectl apply -f @samples/bookinfo/platform/kube/bookinfo-ratings-v2-mysql.yaml@
    deployment "ratings-v2-mysql" created
    
  3. 将发往 reviews 服务的所有流量路由到 v3 版本,这样做是为了确保 reviews 服务始终调用 ratings 服务,此外,将发往 ratings 服务的所有流量路由到使用外部数据库的 _ratings v2-mysql_。

    通过添加两个虚拟服务(virtual service),可以为上述两种服务指定路由。这些虚拟服务在 Istio 发行档案的 samples/bookinfo/networking/virtual-service-ratings-mysql.yaml 中指定。 注意: 确保你在完成了添加默认目标路由才执行下面的命令。

    Zip
    $ kubectl apply -f @samples/bookinfo/networking/virtual-service-ratings-mysql.yaml@
    

更新的架构如下所示,请注意,网格内的蓝色箭头标记根据我们添加的虚拟服务配置的流量,根据虚拟服务的定义,流量将发送到 reviews v3ratings v2-mysql

Bookinfo 应用程序,其评级为 v2-mysql,外部为 MySQL 数据库
Bookinfo 应用程序,其评级为 v2-mysql,外部为 MySQL 数据库

请注意,MySQL 数据库位于 Istio 服务网格之外,或者更准确地说是在 Kubernetes 集群之外,服务网格的边界由虚线标记。

访问网页

确定入口 IP 和端口之后,访问应用程序的网页。

你会发现问题,在每次审核下方都会显示消息 “Ratings service is currently unavailable” 而不是评级星标。

Ratings 服务的错误信息
Ratings 服务的错误信息

使用外部 Web 服务一样,你会体验到优雅的服务降级,这很好,虽然 ratings 服务中有错误,但是应用程序并没有因此而崩溃,应用程序的网页正确显示了书籍信息,详细信息和评论,只是没有评级星。

你遇到的问题与使用外部 Web 服务中的问题相同,即 Kubernetes 集群外的所有流量(TCP 和 HTTP)都被 sidecar 代理默认阻止,要为 TCP 启用此类流量,必须定义 TCP 的网格外部服务入口。

外部 MySQL 实例的网格外部服务入口

“TCP 网格外部服务入口”功能可以解决上面的问题。

  1. 获取你的 MySQL 数据库事例的 IP 地址,作为参考,你可以通过 host 命令实现:

    $ export MYSQL_DB_IP=$(host $MYSQL_DB_HOST | grep " has address " | cut -d" " -f4)
    

    如果是本地数据库,设置 MYSQL_DB_IP 环境变量为你的本机 IP,保证这个环境变量能被集群访问到。

  2. 定义一个网格外部服务入口:

    $ kubectl apply -f - <<EOF
    apiVersion: networking.istio.io/v1alpha3
    kind: ServiceEntry
    metadata:
      name: mysql-external
    spec:
      hosts:
      - $MYSQL_DB_HOST
      addresses:
      - $MYSQL_DB_IP/32
      ports:
      - name: tcp
        number: $MYSQL_DB_PORT
        protocol: tcp
      location: MESH_EXTERNAL
    EOF
    
  3. 检查你刚刚新增的服务入口,确保它的值是正确的

    $ kubectl get serviceentry mysql-external -o yaml
    apiVersion: networking.istio.io/v1alpha3
    kind: ServiceEntry
    metadata:
    ...
    

请注意,对于 TCP 服务入口,将 tcp 指定为入口 “port” 的 “protocol” 的值,另请注意,要在 “addresses” 列表里面指定外部服务的 IP 地址,作为一个 32 为后缀的 CIDR 块。

下面我将详细讨论 TCP 服务入口。现在先来验证我们添加的出口规则是否解决了问题。访问网页看看评星是否回来了。

有效!访问应用程序的网页会显示评级而不会出现错误:

Book Ratings 显示正常
Book Ratings 显示正常

请注意,正如预期的那样,你会看到两个显示评论的一星评级。将评级更改为一颗星,为我们提供了一个视觉线索,确实使用了我们的外部数据库。

与 HTTP/HTTPS 的服务入口一样,你可以动态地使用 kubectl 删除和创建 TCP 的服务入口。

出口 TCP 流量控制的动机

一些网内 Istio 应用程序必须访问外部服务,例如遗留系统,在许多情况下,不通过 HTTP 或 HTTPS 协议执行访问,使用其他 TCP 协议,例如 MongoDB Wire 协议MySQL 客户端/服务器协议等特定于数据库的协议,与外部数据库通信。

接下来我会再说说 TCP 流量的服务入口。

TCP 流量的服务入口

启用到特定端口的 TCP 流量的服务入口必须指定 TCP 作为端口的协议,此外,对于 MongoDB Wire 协议,协议可以指定为 MONGO,而不是 TCP

对于服务入口配置的 addresses 字段,必须使用 CIDR 表示法中的 IP 块。注意在 TCP 服务入口配置中,host 字段会被忽略。

要通过其主机名启用到外部服务的 TCP 流量,必须指定主机名的所有 IP,每个 IP 必须由 CIDR 块指定。

请注意,外部服务的所有 IP 并不总是已知。要往外发送 TCP 流量,只能配置为被应用程序使用的 IP。

另请注意,外部服务的 IP 并不总是静态的,例如在 CDN 的情况下,有时 IP 在大多数情况下是静态的,但可以不时地更改,例如由于基础设施的变化。在这些情况下,如果已知可能 IP 的范围,则应通过 CIDR 块指定范围。如果不知道可能的 IP 的范围,则不能使用 TCP 服务入口,并且必须直接调用外部服务,绕过 sidecar 代理。

与网格扩展的关系

请注意,本文中描述的场景与集成虚拟机示例中描述的网格扩展场景不同。在这种情况下,MySQL 实例在与 Istio 服务网格集成的外部(集群外)机器(裸机或 VM)上运行 ,MySQL 服务成为网格的一等公民,具有 Istio 的所有有益功能,除此之外,服务可以通过本地集群域名寻址,例如通过 mysqldb.vm.svc.cluster.local,并且可以通过双向 TLS 身份验证保护与它的通信,无需创建服务入口来访问此服务; 但是,该服务必须在 Istio 注侧,要启用此类集成,必须在计算机上安装 Istio 组件(Envoy proxynode-agent_istio-agent_ ),并且必须可以从中访问 Istio 控制平面(PilotMixerCitadel )。有关详细信息,请参阅 Istio VM 相关

在这个的示例中,MySQL 实例可以在任何计算机上运行,也可以由云提供商作为服务进行配置,无需集成机器 与 Istio ,无需从机器访问 Istio 控制平面,在使用 MySQL 作为服务的情况下,运行 MySQL 的计算机可能无法访问,并且可能无法在其上安装必需的组件。在这个的例子中,MySQL 实例可以通过其全局域名进行寻址,如果消费应用程序希望使用该域名,这可能是有益的,当在消费应用程序的部署配置中无法更改预期的域名时,这尤其重要。

清理

  1. 删除 test 数据库和 bookinfo 用户:

    $ mysqlsh --sql --ssl-mode=REQUIRED -u admin -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "drop database test; drop user bookinfo;"
    

    或者

    对于mysql和本地数据库:

    $ mysql -u root -p --host $MYSQL_DB_HOST --port $MYSQL_DB_PORT -e "drop database test; drop user bookinfo;"
    
  2. 删除虚拟服务:

    Zip
    $ kubectl delete -f @samples/bookinfo/networking/virtual-service-ratings-mysql.yaml@
    Deleted config: virtual-service/default/reviews
    Deleted config: virtual-service/default/ratings
    
  3. 取消部署 ratings v2-mysql

    Zip
    $ kubectl delete -f @samples/bookinfo/platform/kube/bookinfo-ratings-v2-mysql.yaml@
    deployment "ratings-v2-mysql" deleted
    
  4. 删除服务入口:

    $ kubectl delete serviceentry mysql-external -n default
    Deleted config: serviceentry mysql-external
    

结论

在这篇博文中,我演示了 Istio 服务网格中的微服务如何通过 TCP 使用外部服务,默认情况下,Istio 会阻止所有流量(TCP 和 HTTP)到集群外的主机,要为 TCP 启用此类流量,必须为服务网格创建 TCP 网格外部服务入口。