10.7. 编写模板

您可以定义新模板，以便轻松重新创建应用程序的所有对象。该模板将定义由其创建的对象以及一些元数据，以指导创建这些对象。

例 10.2. 简单模板对象定义(YAML)

apiVersion: v1
kind: Template
metadata:
  name: redis-template
  annotations:
    description: "Description"
    iconClass: "icon-redis"
    tags: "database,nosql"
objects:
- apiVersion: v1
  kind: Pod
  metadata:
    name: redis-master
  spec:
    containers:
    - env:
      - name: REDIS_PASSWORD
        value: ${REDIS_PASSWORD}
      image: dockerfile/redis
      name: master
      ports:
      - containerPort: 6379
        protocol: TCP
parameters:
- description: Password used for Redis authentication
  from: '[A-Z0-9]{8}'
  generate: expression
  name: REDIS_PASSWORD
labels:
  redis: master

apiVersion: v1
kind: Template
metadata:
  name: redis-template
  annotations:
    description: "Description"
    iconClass: "icon-redis"
    tags: "database,nosql"
objects:
- apiVersion: v1
  kind: Pod
  metadata:
    name: redis-master
  spec:
    containers:
    - env:
      - name: REDIS_PASSWORD
        value: ${REDIS_PASSWORD}
      image: dockerfile/redis
      name: master
      ports:
      - containerPort: 6379
        protocol: TCP
parameters:
- description: Password used for Redis authentication
  from: '[A-Z0-9]{8}'
  generate: expression
  name: REDIS_PASSWORD
labels:
  redis: master

Copy to Clipboard

Toggle word wrap

10.7.1. 描述
复制链接

模板描述向用户介绍模板的作用，有助于用户在 web 控制台中搜索查找模板。除模板名称以外的其他元数据均为可选，但若有则会非常有用。除常规描述性信息外，元数据还应包含一组标签。实用标签包括与模板相关的语言名称（如 java、php、ruby 等）。

例 10.3. 模板描述元数据

kind: Template
apiVersion: v1
metadata:
  name: cakephp-mysql-example 
  annotations:
    openshift.io/display-name: "CakePHP MySQL Example (Ephemeral)" 
    description: >-
      An example CakePHP application with a MySQL database. For more information
      about using this template, including OpenShift considerations, see
      https://github.com/sclorg/cakephp-ex/blob/master/README.md.


      WARNING: Any data stored will be lost upon pod destruction. Only use this
      template for testing." 
    openshift.io/long-description: >-
      This template defines resources needed to develop a CakePHP application,
      including a build configuration, application deployment configuration, and
      database deployment configuration.  The database is stored in
      non-persistent storage, so this configuration should be used for
      experimental purposes only. 
    tags: "quickstart,php,cakephp" 
    iconClass: icon-php 
    openshift.io/provider-display-name: "Red Hat, Inc." 
    openshift.io/documentation-url: "https://github.com/sclorg/cakephp-ex" 
    openshift.io/support-url: "https://access.redhat.com" 
message: "Your admin credentials are ${ADMIN_USERNAME}:${ADMIN_PASSWORD}"

kind: Template
apiVersion: v1
metadata:
  name: cakephp-mysql-example


  annotations:
    openshift.io/display-name: "CakePHP MySQL Example (Ephemeral)"


    description: >-
      An example CakePHP application with a MySQL database. For more information
      about using this template, including OpenShift considerations, see
      https://github.com/sclorg/cakephp-ex/blob/master/README.md.


      WARNING: Any data stored will be lost upon pod destruction. Only use this
      template for testing."


    openshift.io/long-description: >-
      This template defines resources needed to develop a CakePHP application,
      including a build configuration, application deployment configuration, and
      database deployment configuration.  The database is stored in
      non-persistent storage, so this configuration should be used for
      experimental purposes only.


    tags: "quickstart,php,cakephp"


    iconClass: icon-php


    openshift.io/provider-display-name: "Red Hat, Inc."


    openshift.io/documentation-url: "https://github.com/sclorg/cakephp-ex"


    openshift.io/support-url: "https://access.redhat.com"


message: "Your admin credentials are ${ADMIN_USERNAME}:${ADMIN_PASSWORD}"

Copy to Clipboard

Toggle word wrap

1: 模板的唯一名称。
2: 可由用户界面使用的简单、用户友好型名称。
3: 模板的描述。包含充足的详细信息，供用户了解所部署的内容以及部署前须知的注意事项。此外，还应提供其他信息链接，如 README 文件。可包括换行符来创建段落。
4: 其他模板描述。例如，这可按照服务目录显示。
5: 要与模板关联的标签，用于搜索和分组。添加将包含在其中一个提供的目录类别中的标签。请参见控制台常量文件的 CATALOG_CATEGORIES 中的 id 和 categoryAliases。此外，还可为整个集群自定义类别。
6: 在 web 控制台中与模板一同显示的图标。尽可能从现有徽标图标中进行选择。也可使用 FontAwesome 和 PatternFly 中的图标。另外，也可通过 CSS 自定义提供图标，它们可添加到使用模板的 OpenShift Container Platform 集群中。您必须指定一个存在的图标类，否则它将阻止回退到通用图标。
7: 提供模板的个人或组织的名称。
8: 用于参考更多模板文档的 URL。
9: 用于获取模板支持的 URL。
10: 模板实例化时显示的说明消息。该字段应向用户介绍如何使用新建资源。显示消息前，对消息进行参数替换，以便输出中包含所生成的凭据和其他参数。其中包括用户应遵守的所有后续步骤文档链接。

返回顶部

10.7. 编写模板

10.7.1. 描述
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

10.7. 编写模板

10.7.1. 描述复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

10.7.1. 描述
复制链接