6.4. リファレンス設定の作成

手順

• ユースケースに合わせて metadata.yaml ファイルを作成します。例として次の構造を使用します。

  metadata.yaml ファイルの例

  apiVersion: v2
  parts:
    - name: Part1
      components:
        - name: Component1
          allOf: 

  1

  
            - path: RequiredTemplate1.yaml
            - path: RequiredTemplate2.yaml
        - name: Component2
          allOrNoneOf: 

  2

  
            - path: OptionalBlockTemplate1.yaml
            - path: OptionalBlockTemplate2.yaml
        - name: Component3
          anyOf: 

  3

  
            - path: OptionalTemplate1.yaml
            - path: OptionalTemplate2.yaml
        - name: Component4
          noneOf: 

  4

  
            - path: BannedTemplate1.yaml
            - path: BannedTemplate2.yaml
        - name: Component5
          oneOf: 

  5

  
            - path: RequiredExclusiveTemplate1.yaml
            - path: RequiredExclusiveTemplate2.yaml
        - name: Component6
          anyOneOf: 

  6

  
            - path: OptionalExclusiveTemplate1.yaml
            - path: OptionalExclusiveTemplate2.yaml
  #...

  1

  必要なテンプレートを指定します。

  2

  すべて必須またはすべて任意のテンプレートのグループを指定します。クラスター内に対応するカスタムリソース (CR) が 1 つ存在する場合、クラスター内に対応するすべての CR が存在する必要があります。

  3

  任意のテンプレートを指定します。

  4

  除外するテンプレートを指定します。対応する CR がクラスター内に存在する場合、プラグインが検証エラーを返します。

  5

  1 つだけ存在できるテンプレートを指定します。対応する CR がクラスター内に存在する場合、または 1 つ以上存在する場合、プラグインが検証エラーを返します。

  6

  クラスター内に 1 つだけ存在できるテンプレートを指定します。対応する CR がクラスター内に複数存在する場合、プラグインが検証エラーを返します。

手順

• ユースケースに合わせて metadata.yaml ファイルを作成します。例として次の構造を使用します。

  apiVersion: v2
  kind: Service
  metadata:
    name: frontend 

  1

  
    namespace: {{ .metadata.namespace }}  

  2

  
    labels:
      app: guestbook
      tier: frontend
  spec:
    {{- if and .spec.type (eq (.spec.type) "NodePort" "LoadBalancer") }}
    type: {{.spec.type }} 

  3

  
    {{- else }}
    type: should be NodePort or LoadBalancer
    {{- end }}
    ports:
    - port: 80
    selector:
      app: guestbook
      {{- if .spec.selector.tier }} 

  4

  
      tier: frontend
      {{- end }}

  1

  指定の値と一致する必要がある必須フィールドを設定します。

  2

  任意の値を持つことができる必須フィールドを設定します。

  3

  .spec.type フィールドの検証を設定します。

  4

  任意のフィールドを設定します。

• テンプレートで指定されていないカスタムリソース内のすべてのフィールドを除外する。

• pathToKey フィールドを使用して定義した特定のフィールドを除外する。

  注記

  pathToKey はドットで区切りのパスです。ピリオドを含むキー値をエスケープするには、引用符を使用してください。

• regex: 正規表現を使用してフィールドの内容を検証します。
• capturegroups: キャプチャーグループ以外のテキストを完全一致として処理し、名前付きキャプチャーグループ内でのみ正規表現マッチングを適用し、繰り返しキャプチャーグループの一貫性を確保することで、マルチラインテキストの比較を強化します。

手順

• ユースケースに合わせて metadata.yaml ファイルを作成します。例として次の構造を使用します。

  apiVersion: v2
  parts:
    - name: Part1
      description: |-
        General text for every template under this part, unless overridden.
      components:
        - name: Component1
          # With no description set, this inherits the description from the part above.
          OneOf:
            - path: Template1.yaml
              # This inherits the component description, if set.
            - path: Template2.yaml
            - path: Template3.yaml
              description: |-
                This template has special instructions that don't apply to the others.
        - name: Component2
          description: |-
            This overrides the part text with something more specific.
            Multi-line text is supported, at all levels.
          allOf:
            - path: RequiredTemplate1.yaml
            - path: RequiredTemplate2.yaml
              description: |-
                Required for important reasons.
            - path: RequiredTemplate3.yaml