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

Make Application Files

\n

Make Images

\n

The traditional industry application need to be made into a Docker image first. We reconmended to make the application into Docker image by Dockerfile, please refer Docker Documentation to make an image.

\n

Make YAML Files

\n

After making the application into Docker image, the next step is to make YAML files. The types of instance in YAML files that iManager supports to create are including Service, Deployment, Statefulset, Job, PersistentVolumeClaim, ServiceAccount, and ConfigMap.

\n

The rules of YAML please see: https://kubernetes.io/docs/concepts/

\n

Users can control the display of application by configuring the attributes ‘StatefullSet’ and ‘annotation’ in ‘Service’ instance and ‘Deployment’ instance. The supported parameters are lisetd in the Appendix.

\n
\n

Notes:
\nSelect UTF-8 encoding when making YAML files.

\n
\n

Appendix

\n
    \n
  1. \n

    The attribute configuration in YAML.

    \n

    The annotation attribute in Service:

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription
    addressRegThe format of service address, the default format is 'http://${SERVICE_IP}:${NODE_PORT}'
    showPortsThe targetPort of the service address when a service has multiple ports
    \n

    The labels attribute in Service:

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription
    entranceWhether to use service address as the access entrance. The service address is the access entrance when the value is true, the value is 'false' by default.
    entrance-portThe targetPort of the access entrance when a service has multiple ports. Only works when the value of entrance is true.
    \n

    Example:

    \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

    The annotation attribute in Deployment and StatefulSet:

    \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
    NameDescription
    scaleWhether to support scaling, the value is 'yes' by default. Configure the value to 'unscalable' to hide the scaling button.
    consoleWhether to support command pad, the value is 'yes' by default. Configure the value to 'noconsole' to hide the command pad.
    descriptionThe description in the service list.
    accountInfoThe account information, supports html format.
    topoProperty\nThe style of topological diagram, string with json format.\n

    {
    \n  name: the Deployment/StatefulSet name of the service.
    \n  isPivot: whether to be the center point.
    \n  index: sort number, ‘1’ is north side, sort by clockwise(the default is sorting by the lexicographic order of the name).
    \n  parents: [{
    \n    name: the Deployment/StatefulSet name of the directed service.
    \n     description: the description of the association between services.
    \n    }]
    \n}

    \n
    \n

    Example:

    \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 Database\n  accountInfo: \"<p>Username/Password:</p><p> root/supermap</p>\"\n  topoProperty: \"{'name':'mysql','isPivot':'false','index':1,'parents':[{'name':'phpmyadmin','description':'The UI of Database management}]}\"\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

    The attribute in PersistentVolumeClaim:

    \n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription
    storageClassNameThe name of storageClass, the format is 'appset-storage-class-${GROUP_TYPE}'.
    \n

    Example:

    \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

    Placeholder list

    \n

    Use the following placeholders in YAML file, the placeholders will be replaced automatically when creating applications.

    \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
    NameDescription
    ${appsetId}\n

    The ID of the application

    \n

    Example: the name of PersistentVolumeClaim

    \n

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

    \n
    ${SERVICE_IP}\n

    The IP of service address

    \n

    Example: add annotation in Service

    \n

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

    \n
    ${SERVICE_NAME}\n

    The name of the service

    \n

    Example: add annotation in Service

    \n

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

    \n
    ${NODE_PORT}\n

    The nodePort of the service

    \n

    Example: add annotation in Service

    \n

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

    \n
    ${TARGET_PORT}\n

    The targetPort of the service

    \n

    Example: add annotation in Service

    \n

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

    \n
    ${IMAGE_PULL_POLICY}\n

    The policy of pulling images

    \n

    Example: imagePullPolicy: ${IMAGE_PULL_POLICY}

    \n
    ${IMAGE_PULL_SECRET}\n

    The image pull secret

    \n

    Example: imagePullSecrets:
    \n               - name: ”${IMAGE_PULL_SECRET}”

    \n
    ${REGISTRY_URL}\n

    The registry address

    \n

    Example: image: ${REGISTRY_URL}supermap/mysql:5.7.12

    \n
    ${GIS_APP_LIMIT_CPU}\n

    CPU limit

    \n

    Example: cpu: ${GIS_APP_LIMIT_CPU}

    \n
    ${GROUP_TYPE}\n

    The group type of the application

    \n

    Example: storageClassName: appset-storage-class-${GROUP_TYPE}

    \n
    ${NAMESPACE}\n

    The namespace of the application

    \n

    Example: namespace: ${NAMESPACE}

    \n
    ${custom_node_port_*}\n

    The external port which is defined by the user, configures in nodePort in Service. After configuring the port, the user can specify the port on UI. The symbol * in the palceholder should be replaced to different names according to the different services.

    \n\n\n

    Example: nodePort: ${custom_node_port_mysql}

    \n
    \n
    \n

    Notes:
    \nIf you configure namespace in YAML file, do not write in a fixed value, please use the placeholder in the table above.

    \n
    \n

    The content below is the YAML of MySQL service:

    \n
    apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:\n    labels:\n       type: mysql\n    # the name of pvc, ${appsetId} will be replaced when creating the application\n    name: pvc-nfs-mysql-data-${appsetId}\nspec:\n   # the name of storageClass, the format is appset-storage-class-${GROUP_TYPE}. ${GROUP_TYPE} will be replaced when creating the application\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       # The service address, ${SERVICE_IP} and ${NODE_PORT} will be replaced when creating the application\n       addressReg: \"jdbc:mysql://${SERVICE_IP}:${NODE_PORT}\"\n       # The targetPort of service address is 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      # Use phpMyAdmin service address as the access entrance\n      entrance: \"true\"\n      # The targetPort of access entrance is 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      # Not support scaling\n      scale: unscalable\n      # The description of MySQL\n      description: MySQL Database\n      # The account information of MySQL\n      accountInfo: \"<p>Username/Password:</p><p> supermap/supermap</p><p> root/supermap</p>\"\n      # The topological diagram information\n      topoProperty: \"{'name':'mysql-server','isPivot':'false','index':1,'parents':[{'name':'phpmyadmin','description':'The UI of database management'}]}\"\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         #The image pull secret, ${IMAGE_PULL_SECRET} will be replaced when creating the application\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} will be replaced when creating the application\n            image: ${REGISTRY_URL}supermap/mysql:5.7.12\n            name: mysql-server\n            # The policy of pulling images, ${IMAGE_PULL_POLICY} will be replaced when creating the application\n            imagePullPolicy: ${IMAGE_PULL_POLICY}\n            # CPU resource limit, ${GIS_APP_LIMIT_CPU} will be replaced when creating the application\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       # Not support scaling\n       scale: unscalable\n       # Not support command pad\n       console: noconsole\n       # The description of phpMyAdmin\n       description: The Web client of MySQL\n       # Topological diagram information\n       topoProperty: \"{'name':'phpmyadmin','isPivot':'false','index':2,'parents':[]}\"\n       # Account information\n       accountInfo: \"<p>Username/Password:</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

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