示例:使用 Redis 部署 PHP Guestbook 应用

本教程将向你展示如何使用 Kubernetes 和 Docker 构建和部署一个简单的(非生产环境)多层 Web 应用。本示例包含以下组件

  • 用于存储留言本条目的单实例 Redis
  • 多个 Web 前端实例

目标

  • 启动一个 Redis leader。
  • 启动两个 Redis follower。
  • 启动留言本前端。
  • 暴露并查看前端 Service。
  • 清理。

开始之前

你需要拥有一个 Kubernetes 集群,并且 kubectl 命令行工具已配置为与你的集群通信。建议在至少有两个节点不充当控制平面主机的集群上运行本教程。如果你还没有集群,可以使用 minikube 创建一个,或者使用以下 Kubernetes 演练场之一

你的 Kubernetes 服务器版本必须是 v1.14 或更高。

要检查版本,输入 kubectl version

启动 Redis 数据库

留言本应用使用 Redis 存储数据。

创建 Redis Deployment

下面包含的清单文件指定了一个 Deployment 控制器,它运行一个单副本 Redis Pod。

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: apps/v1
kind: Deployment
metadata:
  name: redis-leader
  labels:
    app: redis
    role: leader
    tier: backend
spec:
  replicas: 1
  selector:
    matchLabels:
      app: redis
  template:
    metadata:
      labels:
        app: redis
        role: leader
        tier: backend
    spec:
      containers:
      - name: leader
        image: "docker.io/redis:6.0.5"
        resources:
          requests:
            cpu: 100m
            memory: 100Mi
        ports:
        - containerPort: 6379
  1. 在你下载清单文件的目录中启动一个终端窗口。

  2. 应用 redis-leader-deployment.yaml 文件中的 Redis Deployment

    kubectl apply -f https://k8s.io/examples/application/guestbook/redis-leader-deployment.yaml
    
  3. 查询 Pod 列表以验证 Redis Pod 正在运行

    kubectl get pods
    

    响应应类似于此

    NAME                           READY   STATUS    RESTARTS   AGE
    redis-leader-fb76b4755-xjr2n   1/1     Running   0          13s
    
  4. 运行以下命令查看 Redis leader Pod 的日志

    kubectl logs -f deployment/redis-leader
    

创建 Redis leader Service

留言本应用需要与 Redis 通信以写入数据。你需要应用一个 Service 将流量代理到 Redis Pod。Service 定义了访问 Pod 的策略。

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: v1
kind: Service
metadata:
  name: redis-leader
  labels:
    app: redis
    role: leader
    tier: backend
spec:
  ports:
  - port: 6379
    targetPort: 6379
  selector:
    app: redis
    role: leader
    tier: backend
  1. 应用以下 redis-leader-service.yaml 文件中的 Redis Service

    kubectl apply -f https://k8s.io/examples/application/guestbook/redis-leader-service.yaml
    
  2. 查询 Service 列表以验证 Redis Service 正在运行

    kubectl get service
    

    响应应类似于此

    NAME           TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)    AGE
    kubernetes     ClusterIP   10.0.0.1     <none>        443/TCP    1m
    redis-leader   ClusterIP   10.103.78.24 <none>        6379/TCP   16s
    

设置 Redis follower

尽管 Redis leader 是单个 Pod,但你可以通过添加一些 Redis follower 或副本使其高可用,并满足流量需求。

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: apps/v1
kind: Deployment
metadata:
  name: redis-follower
  labels:
    app: redis
    role: follower
    tier: backend
spec:
  replicas: 2
  selector:
    matchLabels:
      app: redis
  template:
    metadata:
      labels:
        app: redis
        role: follower
        tier: backend
    spec:
      containers:
      - name: follower
        image: us-docker.pkg.dev/google-samples/containers/gke/gb-redis-follower:v2
        resources:
          requests:
            cpu: 100m
            memory: 100Mi
        ports:
        - containerPort: 6379
  1. 应用以下 redis-follower-deployment.yaml 文件中的 Redis Deployment

    kubectl apply -f https://k8s.io/examples/application/guestbook/redis-follower-deployment.yaml
    
  2. 通过查询 Pod 列表验证两个 Redis follower 副本正在运行

    kubectl get pods
    

    响应应类似于此

    NAME                             READY   STATUS    RESTARTS   AGE
    redis-follower-dddfbdcc9-82sfr   1/1     Running   0          37s
    redis-follower-dddfbdcc9-qrt5k   1/1     Running   0          38s
    redis-leader-fb76b4755-xjr2n     1/1     Running   0          11m
    

创建 Redis follower Service

留言本应用需要与 Redis follower 通信以读取数据。为了使 Redis follower 可被发现,你必须设置另一个 Service

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: v1
kind: Service
metadata:
  name: redis-follower
  labels:
    app: redis
    role: follower
    tier: backend
spec:
  ports:
    # the port that this service should serve on
  - port: 6379
  selector:
    app: redis
    role: follower
    tier: backend
  1. 应用以下 redis-follower-service.yaml 文件中的 Redis Service

    kubectl apply -f https://k8s.io/examples/application/guestbook/redis-follower-service.yaml
    
  2. 查询 Service 列表以验证 Redis Service 正在运行

    kubectl get service
    

    响应应类似于此

    NAME             TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
    kubernetes       ClusterIP   10.96.0.1       <none>        443/TCP    3d19h
    redis-follower   ClusterIP   10.110.162.42   <none>        6379/TCP   9s
    redis-leader     ClusterIP   10.103.78.24    <none>        6379/TCP   6m10s
    

设置和暴露留言本前端

现在你已经运行了留言本的 Redis 存储,可以启动留言本 Web 服务器了。与 Redis follower 一样,前端也是使用 Kubernetes Deployment 部署的。

留言本应用使用 PHP 前端。它配置为与 Redis follower 或 leader Service 通信,具体取决于请求是读取还是写入。前端暴露一个 JSON 接口,并提供一个基于 jQuery-Ajax 的用户体验 (UX)。

创建留言本前端 Deployment

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: apps/v1
kind: Deployment
metadata:
  name: frontend
spec:
  replicas: 3
  selector:
    matchLabels:
        app: guestbook
        tier: frontend
  template:
    metadata:
      labels:
        app: guestbook
        tier: frontend
    spec:
      containers:
      - name: php-redis
        image: us-docker.pkg.dev/google-samples/containers/gke/gb-frontend:v5
        env:
        - name: GET_HOSTS_FROM
          value: "dns"
        resources:
          requests:
            cpu: 100m
            memory: 100Mi
        ports:
        - containerPort: 80
  1. 应用 frontend-deployment.yaml 文件中的前端 Deployment

    kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-deployment.yaml
    
  2. 查询 Pod 列表以验证三个前端副本正在运行

    kubectl get pods -l app=guestbook -l tier=frontend
    

    响应应类似于此

    NAME                        READY   STATUS    RESTARTS   AGE
    frontend-85595f5bf9-5tqhb   1/1     Running   0          47s
    frontend-85595f5bf9-qbzwm   1/1     Running   0          47s
    frontend-85595f5bf9-zchwc   1/1     Running   0          47s
    

创建前端 Service

你应用的 Redis Service 只能在 Kubernetes 集群内部访问,因为 Service 的默认类型是 ClusterIPClusterIP 为 Service 指向的一组 Pod 提供一个单一的 IP 地址。此 IP 地址只能在集群内部访问。

如果你希望访客能够访问你的留言本,必须将前端 Service 配置为外部可见,以便客户端可以从 Kubernetes 集群外部请求该 Service。然而,Kubernetes 用户即使使用 ClusterIP 也可以通过 kubectl port-forward 访问该服务。

# SOURCE: https://cloud.google.com/kubernetes-engine/docs/tutorials/guestbook
apiVersion: v1
kind: Service
metadata:
  name: frontend
  labels:
    app: guestbook
    tier: frontend
spec:
  # if your cluster supports it, uncomment the following to automatically create
  # an external load-balanced IP for the frontend service.
  # type: LoadBalancer
  #type: LoadBalancer
  ports:
    # the port that this service should serve on
  - port: 80
  selector:
    app: guestbook
    tier: frontend
  1. 应用 frontend-service.yaml 文件中的前端 Service

    kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-service.yaml
    
  2. 查询 Service 列表以验证前端 Service 正在运行

    kubectl get services
    

    响应应类似于此

    NAME             TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
    frontend         ClusterIP   10.97.28.230    <none>        80/TCP     19s
    kubernetes       ClusterIP   10.96.0.1       <none>        443/TCP    3d19h
    redis-follower   ClusterIP   10.110.162.42   <none>        6379/TCP   5m48s
    redis-leader     ClusterIP   10.103.78.24    <none>        6379/TCP   11m
    

通过 kubectl port-forward 查看前端 Service

  1. 运行以下命令将你本地机器上的端口 8080 转发到 Service 上的端口 80

    kubectl port-forward svc/frontend 8080:80
    

    响应应类似于此

    Forwarding from 127.0.0.1:8080 -> 80
    Forwarding from [::1]:8080 -> 80
    
  2. 在浏览器中加载页面 http://localhost:8080 以查看你的留言本。

通过 LoadBalancer 查看前端 Service

如果你部署的 frontend-service.yaml 清单中指定了 type: LoadBalancer,你需要找到 IP 地址来查看你的留言本。

  1. 运行以下命令获取前端 Service 的 IP 地址。

    kubectl get service frontend
    

    响应应类似于此

    NAME       TYPE           CLUSTER-IP      EXTERNAL-IP        PORT(S)        AGE
    frontend   LoadBalancer   10.51.242.136   109.197.92.229     80:32372/TCP   1m
    
  2. 复制外部 IP 地址,然后在浏览器中加载页面以查看你的留言本。

扩缩 Web 前端

你可以根据需要向上或向下扩缩,因为你的服务器被定义为一个使用 Deployment 控制器的 Service。

  1. 运行以下命令向上扩缩前端 Pod 的数量

    kubectl scale deployment frontend --replicas=5
    
  2. 查询 Pod 列表以验证正在运行的前端 Pod 数量

    kubectl get pods
    

    响应应类似于此

    NAME                             READY   STATUS    RESTARTS   AGE
    frontend-85595f5bf9-5df5m        1/1     Running   0          83s
    frontend-85595f5bf9-7zmg5        1/1     Running   0          83s
    frontend-85595f5bf9-cpskg        1/1     Running   0          15m
    frontend-85595f5bf9-l2l54        1/1     Running   0          14m
    frontend-85595f5bf9-l9c8z        1/1     Running   0          14m
    redis-follower-dddfbdcc9-82sfr   1/1     Running   0          97m
    redis-follower-dddfbdcc9-qrt5k   1/1     Running   0          97m
    redis-leader-fb76b4755-xjr2n     1/1     Running   0          108m
    
  3. 运行以下命令向下扩缩前端 Pod 的数量

    kubectl scale deployment frontend --replicas=2
    
  4. 查询 Pod 列表以验证正在运行的前端 Pod 数量

    kubectl get pods
    

    响应应类似于此

    NAME                             READY   STATUS    RESTARTS   AGE
    frontend-85595f5bf9-cpskg        1/1     Running   0          16m
    frontend-85595f5bf9-l9c8z        1/1     Running   0          15m
    redis-follower-dddfbdcc9-82sfr   1/1     Running   0          98m
    redis-follower-dddfbdcc9-qrt5k   1/1     Running   0          98m
    redis-leader-fb76b4755-xjr2n     1/1     Running   0          109m
    

清理

删除 Deployment 和 Service 也会删除所有正在运行的 Pod。使用标签可以通过一个命令删除多个资源。

  1. 运行以下命令删除所有 Pod、Deployment 和 Service。

    kubectl delete deployment -l app=redis
    kubectl delete service -l app=redis
    kubectl delete deployment frontend
    kubectl delete service frontend
    

    响应应类似于此

    deployment.apps "redis-follower" deleted
    deployment.apps "redis-leader" deleted
    deployment.apps "frontend" deleted
    service "frontend" deleted
    
  2. 查询 Pod 列表以验证没有 Pod 正在运行

    kubectl get pods
    

    响应应类似于此

    No resources found in default namespace.
    

下一步

最后修改于 2023 年 8 月 24 日太平洋标准时间下午 6:38:使用 code_sample shortcode 替代 code shortcode (e8b136c3b3)