制作应用模板

学习如何编写应用模板，定义元信息、输入项、工作负载、服务暴露与在线调试流程。

模板文件通常长什么样

Sealos 应用模板通常用一个 template.yaml 文件描述，它既包含模板元信息，也包含实际部署所需的 Kubernetes 资源。

一个常见模板会包含这些部分：

Template：定义模板名称、图标、描述、分类和输入项
StatefulSet 或其他工作负载资源：定义应用实例如何运行
Service：定义集群内访问方式
Ingress：定义对外访问入口
App：定义 Sealos 控制台里的应用展示信息

先看一个完整示例

下面这份 template.yaml 适合作为起点。你不需要一开始理解每一行，但应该先建立“模板由哪些资源组成”的整体认知。

template.yaml

# Sealos Application Template Reference
#
# This file serves as a template reference for creating Sealos application templates.
# Copy this file and customize it for your application.
#
# Required fields are marked with [REQUIRED]
# Fill in the placeholders with your application-specific information.

---
apiVersion: app.sealos.io/v1
kind: Template
metadata:
  name: myapp-template
spec:
  # Application metadata
  title: ""                               # [REQUIRED] Application display name
  url: ""                                 # [REQUIRED] Your app's official website
  gitRepo: ""                             # [REQUIRED] Your app's GitHub repository URL
  author: ""                              # [REQUIRED] Your name or organization
  description: ""                         # [REQUIRED] Brief description of your app
  readme: 'https://raw.githubusercontent.com/labring-actions/templates/main/template/<app-name>/README.md'  # Update <app-name> with actual app name
  icon: ""                                # [REQUIRED] URL to your app's icon
  templateType: inline                    # Template type: inline (all resources in one file)
  locale: en
  i18n:
    zh:
      title: '应用标题'                     # Chinese title for your app
      description: '应用描述'                # Chinese description for your app
  categories:
    - tool                                # [REQUIRED] Choose from: ai, database, tool, low-code, blog, storage, frontend, backend, dev-ops, monitor, game

  # Default values for template variables
  defaults:
    app_host:
      type: string
      value: myapp-${{ random(8) }}      # Replace "myapp" with your app's name prefix
    app_name:
      type: string
      value: myapp-${{ random(8) }}      # Replace "myapp" with your app's name prefix

  # User-configurable inputs (will be rendered as form fields)
  inputs:
    volume_size:
      description: "Persistent storage size (GiB)"
      type: string
      default: "1"
      required: false
    # Add more inputs as needed, e.g.:
    # - app_password:
    #     description: "Admin password"
    #     type: string
    #     required: true

---
# StatefulSet - Manages your application pods
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: ${{ defaults.app_name }}
  annotations:
    originImageName: ""                   # [REQUIRED] Your app's Docker image URL
    deploy.cloud.sealos.io/minReplicas: "1"
    deploy.cloud.sealos.io/maxReplicas: "1"
  labels:
    cloud.sealos.io/app-deploy-manager: ${{ defaults.app_name }}
    app: ${{ defaults.app_name }}
spec:
  replicas: 1
  revisionHistoryLimit: 1
  minReadySeconds: 10
  serviceName: ${{ defaults.app_name }}
  selector:
    matchLabels:
      app: ${{ defaults.app_name }}
  template:
    metadata:
      labels:
        app: ${{ defaults.app_name }}
    spec:
      terminationGracePeriodSeconds: 10
      automountServiceAccountToken: false  # Security: disable service account token mounting
      containers:
        - name: ${{ defaults.app_name }}
          image: ""                       # [REQUIRED] Your app's Docker image URL
          env: []                         # Environment variables (add as needed)
          resources:
            requests:
              cpu: 100m
              memory: 128Mi
            limits:
              cpu: 1000m
              memory: 1024Mi
          command: []                     # Override entrypoint if needed
          args: []                        # Command arguments
          ports:
            - containerPort: 80           # [REQUIRED] Your app's internal port
          imagePullPolicy: IfNotPresent
          volumeMounts:
            - name: data-volume
              mountPath: /app/data        # Path where your app stores data
      volumes: []                         # Additional volumes (if any)
  volumeClaimTemplates:
    - metadata:
        annotations:
          path: /app/data                 # Path to store persistent data
          value: "1"
        name: data-volume
      spec:
        accessModes:
          - ReadWriteOnce
        resources:
          requests:
            storage: ${{ inputs.volume_size }}Gi

---
# Service - Exposes your application within the cluster
apiVersion: v1
kind: Service
metadata:
  name: ${{ defaults.app_name }}
  labels:
    cloud.sealos.io/app-deploy-manager: ${{ defaults.app_name }}
spec:
  ports:
    - port: 80                           # Service port (usually same as containerPort)
  selector:
    app: ${{ defaults.app_name }}

---
# Ingress - Exposes your application to the internet
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ${{ defaults.app_name }}
  labels:
    cloud.sealos.io/app-deploy-manager: ${{ defaults.app_name }}
    cloud.sealos.io/app-deploy-manager-domain: ${{ defaults.app_host }}
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/proxy-body-size: 32m
    nginx.ingress.kubernetes.io/server-snippet: |
      client_header_buffer_size 64k;
      large_client_header_buffers 4 128k;
    nginx.ingress.kubernetes.io/ssl-redirect: "false"
    nginx.ingress.kubernetes.io/backend-protocol: HTTP
    nginx.ingress.kubernetes.io/rewrite-target: /$2
    nginx.ingress.kubernetes.io/client-body-buffer-size: 64k
    nginx.ingress.kubernetes.io/proxy-buffer-size: 64k
    nginx.ingress.kubernetes.io/configuration-snippet: |
      if ($request_uri ~* \.(js|css|gif|jpe?g|png)) {
        expires 30d;
        add_header Cache-Control "public";
      }
spec:
  rules:
    - host: ${{ defaults.app_host }}.${{ SEALOS_CLOUD_DOMAIN }}
      http:
        paths:
          - pathType: Prefix
            path: /()(.*)
            backend:
              service:
                name: ${{ defaults.app_name }}
                port:
                  number: 80
  tls:
    - hosts:
        - ${{ defaults.app_host }}.${{ SEALOS_CLOUD_DOMAIN }}
      secretName: ${{ SEALOS_CERT_SECRET_NAME }}

---
# App - Application metadata for Sealos UI (must be the last resource)
apiVersion: app.sealos.io/v1
kind: App
metadata:
  name: ${{ defaults.app_name }}
  labels:
    cloud.sealos.io/app-deploy-manager: ${{ defaults.app_name }}
spec:
  data:
    url: https://${{ defaults.app_host }}.${{ SEALOS_CLOUD_DOMAIN }}
  displayType: normal
  icon: ""                                # [REQUIRED] URL to your app's icon
  name: ""                                # [REQUIRED] Application display name
  type: link