应用开发入门

OpenPitrix 支持将应用以 Helm Chart 的形式上传部署到平台中，而 Nginx 是大家熟知的代理和负载均衡软件，比起 Traefik 来说功能更加强大，本篇文档就以 Nginx 的 Helm Chart 文件为例，介绍 Chart 的基本规则，演示如何通过 Helm Chart 应用开发规范准备一个应用并上传部署到 OpenPitrix 平台。

准备 Helm 客户端工具

执行以下命令，将自动下载安装最新版本的 Helm 客户端，支持在 Linux 上安装 ：

  1. $ curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get > get_helm.sh
  2. $ chmod 700 get_helm.sh
  3. $ ./get_helm.sh

更多安装方式请参考 helm 安装文档。

准备本地仓库

执行下列命令，在本地创建目录作为本地仓库。

  1. $ mkdir helm-repo
  2. $ cd helm-repo

创建应用

执行 helm create 创建一个名为 nginx 的文件夹且默认生成一个 nginx 基本的 yaml 文件模板和目录，通常情况下不建议修改生成的一级目录下文件和目录的命名。

  1. $ helm create nginx
  2. $ tree nginx/
  3. nginx/
  4. ├── charts
  5. ├── Chart.yaml
  6. ├── templates
  7. │   ├── deployment.yaml
  8. │   ├── _helpers.tpl
  9. │   ├── ingress.yaml
  10. │   ├── NOTES.txt
  11. │   └── service.yaml
  12. └── values.yaml
  14. 2 directories, 7 files

Chart.yaml 是用于描述 Chart 的基本信息，包括名称、API 和应用版本等，其中 appVersion 字段与 version 字段无关。这是一种指定应用程序版本的方法详见 Chart.yaml 文件。

Chart.yaml 文件示例：

  1. apiVersion: v1
  2. appVersion: "1.0"
  3. description: A Helm chart for Kubernetes
  4. name: nginx
  5. version: 0.1.0

包含在 chart 内的默认 values 文件必须命名 values.yaml，可以为 chart 及其任何依赖项提供值。通过 values.yaml 文件提供的值可以从.Values模板中的对象访问。在部署 Helm Chart 类型的应用到 Kuberntes 运行环境时，支持在 UI 界面可以对 values.yaml 进行编辑配置。

values.yaml：

  1. # Default values for test.
  2. # This is a YAML-formatted file.
  3. # Declare variables to be passed into your templates.
  5. replicaCount: 1
  7. image:
  8.   repository: nginx
  9.   tag: stable
  10.   pullPolicy: IfNotPresent
  12. nameOverride: ""
  13. fullnameOverride: ""
  15. service:
  16.   type: ClusterIP
  17.   port: 80
  19. ingress:
  20.   enabled: false
  21.   annotations: {}
  22.     # kubernetes.io/ingress.class: nginx
  23.     # kubernetes.io/tls-acme: "true"
  24.   path: /
  25.   hosts:
  26.     - chart-example.local
  27.   tls: []
  28.   #  - secretName: chart-example-tls
  29.   #    hosts:
  30.   #      - chart-example.local
  32. resources: {}
  33.   # We usually recommend not to specify default resources and to leave this as a conscious
  34.   # choice for the user. This also increases chances charts run on environments with little
  35.   # resources, such as Minikube. If you do want to specify resources, uncomment the following
  36.   # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
  37.   # limits:
  38.   #  cpu: 100m
  39.   #  memory: 128Mi
  40.   # requests:
  41.   #  cpu: 100m
  42.   #  memory: 128Mi
  44. nodeSelector: {}
  46. tolerations: []
  48. affinity: {}

可根据 Helm 应用开发规范 编辑 nginx 目录下文件，编辑好后保存。

生成索引文件（可选）

在 OpenPitrix 中，若添加 HTTP 或 HTTPS 协议的仓库，则需要预先在对象存储中上传索引文件 index.yaml，该文件由 Helm 客户端工具生成。若添加 S3 协议的仓库，在上传应用到仓库时将自动在对象存储中生成索引文件。在 nginx 上一级目录执行以下命令生成索引文件：

  1. $ helm repo index .
  2. $ ls
  3. index.yaml  nginx

打包应用

回到 nginx 上级目录，执行打包命令，将生成一个 tgz 格式的压缩文件，即 nginx 应用配置包：

  1. $ helm package nginx
  2. $ ls
  3. nginx  nginx-0.1.0.tgz

至此，应用配置包就已经准备完毕。

上传应用

接下来就可以通过开发者来上传应用到平台进一步测试和部署应用到 Kubernetes 运行环境中，可参考 开发者 - 上传应用。

部署应用

部署 Helm Chart 类型的应用（如本篇提到的 nginx）到 Kubernetes 运行环境，参考 应用审核与发布 - 部署应用到 Kubernetes 运行环境。