3.2. 安装模板概述

您可以自定义模板字段。SiteConfig 操作符支持Sprig 库中的所有函数。

另外，ClusterInstance API 提供了在创建自定义清单时可以使用以下功能：

{{ if .Spec.Proxy }}
  proxy:
{{ .Spec.Proxy | toYaml | indent 4 }}
{{ end }}

SiteConfig operator 在安装 Operator 的同一命名空间中提供以下默认、验证和不可变模板集合：

有关ClusterInstance API 的更多信息，请参阅ClusterInstance API 。

SiteConfig operator 提供了一组可在模板中使用的特殊模板变量。请参见以下列表：

在文本模板中使用字段名称来创建自定义模板字段。

例如，ClusterInstance spec 字段使用 .Spec 前缀引用。但是，您必须使用 .SpecialVars 前缀引用特殊变量字段。

重要： 对于 spec.nodes 字段使用 .Spec.Nodes 前缀，您必须使用 .SpecialVars.CurrentNode 特殊模板变量引用它。

例如，如果要使用 CurrentNode 特殊模板变量为当前节点指定 名称和命名空间，请使用以下格式的字段名称：

name: "{{ .SpecialVars.CurrentNode.HostName }}"
namespace: "{{ .Spec.ClusterName }}"

您可以使用 siteconfig.open-cluster-management.io/sync-wave 注解来控制创建、更新和删除清单的顺序。该注解使用一个整数作为值，该整数则作为 wave 组成。

您可以将一个或多个清单添加到单个 wave 中。如果没有指定值，注解将使用默认值 0。

SiteConfig operator 在创建或更新资源时以升序协调清单，并以降序删除资源。

在以下示例中，如果 SiteConfig 操作员创建或更新清单，则AgentClusterInstall和ClusterDeployment自定义资源将在第一波中进行协调，而KlusterletAddonConfig和ManagedCluster自定义资源将在第三波中进行协调：

apiVersion: v1
data:
  AgentClusterInstall: |-
    ...
        siteconfig.open-cluster-management.io/sync-wave: "1"
    ...
  ClusterDeployment: |-
    ...
        siteconfig.open-cluster-management.io/sync-wave: "1"
    ...
  InfraEnv: |-
    ...
        siteconfig.open-cluster-management.io/sync-wave: "2"
    ...
  KlusterletAddonConfig: |-
    ...
        siteconfig.open-cluster-management.io/sync-wave: "3"
    ...
  ManagedCluster: |-
    ...
        siteconfig.open-cluster-management.io/sync-wave: "3"
    ...
kind: ConfigMap
metadata:
  name: assisted-installer-templates
  namespace: example-namespace

如果 SiteConfig operator 删除资源，KlusterletAddonConfig 和 ManagedCluster 自定义资源是第一个被删除，而 AgentClusterInstall 和 ClusterDeployment 自定义资源是最后一个。

您可以使用 ClusterInstance API 中的 extraAnnotations 和 extraLabels 字段为集群级别和节点级别的安装清单配置额外的注解和标签。SiteConfig Operator 将额外注解和标签应用到您在 ClusterInstance 资源中指定的清单。

在创建额外的注解和标签时，您必须指定清单类型，以允许 SiteConfig 操作器将它们应用到所有匹配的清单。但是，注解和标签是任意的，您可以设置对应用程序有意义的任何键值对。

注： 附加注解和标签只适用于通过引用模板呈现的资源。

查看以下 extraAnnotations 和 extraLabels 应用程序示例：

apiVersion: siteconfig.open-cluster-management.io/v1alpha1
kind: ClusterInstance
metadata:
  name: "example-sno"
  namespace: "example-sno"
spec:
  [...]
  clusterName: "example-sno"
  extraAnnotations: 

    ClusterDeployment:
      myClusterAnnotation: success
  extraLabels: 

    ManagedCluster:
      common: "true"
      group-du: ""
  nodes:
    - hostName: "example-sno.example.redhat.com"
      role: "master"
      extraAnnotations: 

        BareMetalHost:
          myNodeAnnotation: success
      extraLabels: 

        BareMetalHost:
          "testExtraLabel": "success"

您可以运行以下命令来验证您的附加标签是否已应用：

oc get managedclusters example-sno -ojsonpath='{.metadata.labels}' | jq

查看以下应用标签示例：

{
  "common": "true",
  "group-du": "",
  ...
}

您可以运行以下命令来验证您的附加注解是否已应用：

oc get bmh example-sno.example.redhat.com -n example-sno -ojsonpath='{.metadata.annotations}' | jq

查看以下应用的注解示例：

{
  "myNodeAnnotation": "success",
  ...
}

您可能想要更改集群配置，但在配置期间不允许对集群进行更改。但是，集群配置完成后，您可以修改以下字段：

注意： <node-id>代表更新后的NodeSpec对象。