{"componentChunkName":"component---src-templates-tutorial-js","path":"/zh/tutorial/ApplicationFile/","result":{"data":{"markdownRemark":{"html":"

定制文件制作

\n

制作镜像

\n

把自己的应用Docker容器化，推荐使用Dockerfile的形式把自己的应用制作成Docker镜像，具体的镜像制作方式方法可以参考Docker官网的文档。

\n

编写YAML文件

\n

您可以通过编写YAML文件创建应用，iManager支持创建的实例类型包括Service, Deployment, Statefulset, Job, PersistentVolumeClaim, ServiceAccount, ConfigMap。

\n

YAML编写规则可参考: https://kubernetes.io/docs/concepts/

\n

此外，您可通过配置Service、Deployment和StatefulSet的labels和annotation属性来控制应用的界面展示。支持配置的参数参见本页附录。

\n
\n

提示：
\n编写YAML文件时使用utf-8编码，否则会出现中文乱码。

\n
\n

附录

\n
    \n
  1. \n

    YAML中的属性配置。

    \n

    Service支持的annotation属性：

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    名称描述
    addressReg服务地址格式，默认展示为http://${SERVICE_IP}:${NODE_PORT}格式
    showPorts服务暴露多个端口时，服务地址对应的targetPort
    \n

    Service支持的labels属性：

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    名称描述
    entrance服务地址是否作为访问入口，默认为false，配置为true时该服务地址作为应用访问入口
    entrance-port服务暴露多个端口时，访问入口地址对应targetPort，仅在entrance为true时生效
    \n

    示例：

    \n
    apiVersion: v1\nkind: Service\nmetadata:\n name: mysql\n labels:\n   entrance: \"true\"\n   entrance-port: \"3306\"\n annotations:\n   addressReg: \"jdbc:mysql://mysql:3306\"\n   showPorts: \"[3306]\"\nspec:\n ports:\n - port: 3306\n selector:\n   app: mysql\n type: NodePort
    \n

    Deployment和StatefulSet支持的annotation属性：

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    名称描述
    scale是否支持伸缩，默认为支持，配置为unscalable时不展示伸缩按钮
    console是否支持命令行，默认为支持，配置为noconsole时不展示命令行按钮
    description服务列表中的描述信息
    accountInfo账户信息，支持html格式
    topoProperty\n拓扑图信息，json格式的字符串\n

    {
    \n  name: 该服务Deployment/StatefulSet名称
    \n  isPivot: 是否作为中心点
    \n  index: 排序编号，“1”为正北方向，按顺时针递增（不填时默认名称的字典序顺时针排列）
    \n  parents: [{
    \n    name: 该服务箭头所指服务的Deployment/StatefulSet名称
    \n     description: 两服务的关系描述
    \n    }]
    \n}

    \n
    \n

    示例：

    \n
    apiVersion: apps/v1\nkind: Deployment\nmetadata:\n labels:\n  app: mysql\n name: mysql\n annotations:\n  scale: unscalable\n  console: noconsole\n  description: MySQL数据库\n  accountInfo: \"<p>用户/密码:</p><p> root/supermap</p>\"\n  topoProperty: \"{'name':'mysql','isPivot':'false','index':1,'parents':[{'name':'phpmyadmin','description':'数据库管理UI'}]}\"\nspec:\n selector:\n  matchLabels:\n      app: mysql\n template:\n  metadata:\n      labels:\n        app: mysql\n  spec:\n      containers:\n      - env:\n        - name: MYSQL_ROOT_PASSWORD\n          value: supermap\n        image: registry.ispeco.com/supermap/mysql:5.7.12\n        name: mysql\n        imagePullPolicy: Always\n      restartPolicy: Always
    \n

    PersistentVolumeClaim中的属性:

    \n\n\n\n\n\n\n\n\n\n\n\n
    名称描述
    storageClassNamestorageClass名称，固定为appset-storage-class-${GROUP_TYPE}。
    \n

    示例：

    \n
    apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:\nlabels:\n   type: mysql\nname: pvc-nfs-mysql-data-${appsetId}\nspec:\nstorageClassName: appset-storage-class-${GROUP_TYPE}\naccessModes:\n  - ReadWriteMany\nresources:\n  requests:\n     storage: 1Gi
    \n
    2. \n
  2. \n

    占位符列表

    \n

    在YAML文件中使用以下占位符，在应用创建过程中会被真实值替换：

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    名称描述
    ${appsetId}\n

    应用的id

    \n

    示例：PersistentVolumeClaim名称

    \n

    name: pvc-nfs-mysql-data-${appsetId}

    \n
    ${SERVICE_IP}\n

    服务地址ip

    \n

    示例：为Service添加annotation：

    \n

    addressReg: “jdbc:mysql://${SERVICE_IP}:8080”

    \n
    ${SERVICE_NAME}\n

    服务名称

    \n

    示例：为Service添加annotation：

    \n

    addressReg: “jdbc:mysql://${SERVICE_NAME}:8080”

    \n
    ${NODE_PORT}\n

    服务的nodePort

    \n

    示例：为Service添加annotation：

    \n

    addressReg: “jdbc:mysql://127.0.0.1:${NODE_PORT}”

    \n
    ${TARGET_PORT}\n

    服务的targetPort

    \n

    示例：为Service添加annotation：

    \n

    addressReg: “jdbc:mysql://127.0.0.1:${TARGET_PORT}”

    \n
    ${IMAGE_PULL_POLICY}\n

    镜像拉取策略

    \n

    示例：imagePullPolicy: ${IMAGE_PULL_POLICY}

    \n
    ${IMAGE_PULL_SECRET}\n

    镜像拉取Secret

    \n

    示例：imagePullSecrets:
    \n           - name: ”${IMAGE_PULL_SECRET}”

    \n
    ${REGISTRY_URL}\n

    镜像仓库地址

    \n

    示例：image: ${REGISTRY_URL}supermap/mysql:5.7.12

    \n
    ${GIS_APP_LIMIT_CPU}\n

    CPU限制

    \n

    示例：cpu: ${GIS_APP_LIMIT_CPU}

    \n
    ${GROUP_TYPE}\n

    应用所属分组类型

    \n

    示例：storageClassName: appset-storage-class-${GROUP_TYPE}

    \n
    ${NAMESPACE}\n

    应用所属命名空间

    \n

    示例：namespace: ${NAMESPACE}

    \n
    ${custom_node_port_*}\n

    用户自定义的外部端口，配在Service的nodePort参数中，在创建该站点时，可在界面上自定义该外部端口。占位符中的*号根据端口不同需替换成不同的名称。

    \n

    示例：nodePort: ${custom_node_port_mysql}

    \n
    \n
    3. \n
\n
\n

注意：
\n在YAML文件中配置命名空间时，勿写入固定值，请使用上表中的占位符。

\n
\n

以下用MySQL服务作为一个完整示例：

\n
apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:\n    labels:\n       type: mysql\n    #pvc名称，${appsetId}在创建过程中会被替换\n    name: pvc-nfs-mysql-data-${appsetId}\nspec:\n   #storageClass名称，固定为appset-storage-class-${GROUP_TYPE}。${GROUP_TYPE}在创建过程中会被替换。\n   storageClassName: appset-storage-class-${GROUP_TYPE}\n   accessModes:\n      - ReadWriteMany\n   resources:\n      requests:\n         storage: 1Gi\n---\napiVersion: v1\nkind: Service\nmetadata:\n    labels:\n       type: mysql\n    name: mysql-server\n    annotations:\n       #服务地址,${SERVICE_IP}和${NODE_PORT}在创建过程中会被替换\n       addressReg: \"jdbc:mysql://${SERVICE_IP}:${NODE_PORT}\"\n       #服务地址对应的targetPort为3306\n       showPorts: \"[3306]\"\nspec:\n   ports:\n   - port: 3307\n     targetPort: 3306\n     nodePort: ${custom_node_port_mysql}\n   selector:\n      app: mysql-server\n   type: NodePort\n---\napiVersion: v1\nkind: Service\nmetadata:\n    labels:\n      type: mysql\n      #将phpMyAdmin服务地址作为访问入口\n      entrance: \"true\"\n      #访问入口地址对应的targetPort为80\n      entrance-port: \"80\"\n    name: phpmyadmin\nspec:\n   ports:\n   - port: 89\n     targetPort: 80\n   selector:\n      app: phpmyadmin\n   type: NodePort\n---\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n   labels:\n      app: mysql-server\n   name: mysql-server\n   annotations:\n      #不支持伸缩\n      scale: unscalable\n      #MySQL描述信息\n      description: MySQL数据库\n      #MySQL账户信息\n      accountInfo: \"<p>用户/密码:</p><p> supermap/supermap</p><p> root/supermap</p>\"\n      #拓扑图信息\n      topoProperty: \"{'name':'mysql-server','isPivot':'false','index':1,'parents':[{'name':'phpmyadmin','description':'数据库管理UI'}]}\"\nspec:\n   replicas: 1\n   selector:\n      matchLabels:\n          app: mysql-server\n   template:\n      metadata:\n          labels:\n            app: mysql-server\n      spec:\n         #镜像拉取Secret，${IMAGE_PULL_SECRET}在创建过程中会被替换\n         imagePullSecrets:\n          - name: \"${IMAGE_PULL_SECRET}\"\n         containers:\n          - env:\n            - name: MYSQL_DATABASE\n              value: supermap\n            - name: MYSQL_PASSWORD\n              value: supermap\n            - name: MYSQL_ROOT_PASSWORD\n              value: supermap\n            - name: MYSQL_USER\n              value: supermap\n            #${REGISTRY_URL}在创建过程中会被替换\n            image: ${REGISTRY_URL}supermap/mysql:5.7.12\n            name: mysql-server\n            #镜像拉取策略，${IMAGE_PULL_POLICY}在创建过程中会被替换\n            imagePullPolicy: ${IMAGE_PULL_POLICY}\n            #cpu资源限制，${GIS_APP_LIMIT_CPU}在创建过程中会被替换\n            resources:\n                limits:\n                   cpu: ${GIS_APP_LIMIT_CPU}\n                requests:\n                   cpu: 300m\n            volumeMounts:\n              - mountPath: /var/lib/mysql\n                name: mysql-volume\n         restartPolicy: Always\n         volumes:\n            - name: mysql-volume\n              persistentVolumeClaim:\n                 claimName: pvc-nfs-mysql-data-${appsetId}\n---\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n    labels:\n      app: phpmyadmin\n    name: phpmyadmin\n    annotations:\n       #不支持伸缩\n       scale: unscalable\n       #不显示命令行\n       console: noconsole\n       #phpMyAdmin描述信息\n       description: MySQL的WEB客户端\n       #拓扑图信息\n       topoProperty: \"{'name':'phpmyadmin','isPivot':'false','index':2,'parents':[]}\"\n       #初始账户信息\n       accountInfo: \"<p>用户/密码:</p><p> supermap/supermap</p><p> root/supermap</p>\"\nspec:\n   replicas: 1\n   selector:\n      matchLabels:\n          app: phpmyadmin\n   template:\n      metadata:\n          labels:\n            app: phpmyadmin\n      spec:\n         containers:\n         - env:\n           - name: PMA_HOST\n             value: mysql-server\n           - name: PMA_PORT\n             value: \"3307\"\n           image: ${REGISTRY_URL}supermap/phpmyadmin:4.6\n           name: phpmyadmin\n           imagePullPolicy: ${IMAGE_PULL_POLICY}\n           ports:\n             - containerPort: 80\n         restartPolicy: Always
\n

\n \n \n \n \n \n \n \n \n \n

\n

\n \n \n \n \n \n \n \n \n \n

","frontmatter":{"title":"教程","next":null,"prev":null},"fields":{"path":"content/tutorial/ApplicationFile.zh.md","slug":"/zh/tutorial/ApplicationFile/","langKey":"zh"}}},"pageContext":{"slug":"/zh/tutorial/ApplicationFile/"}}}