Citrix Application Delivery Management 13.0

Parameters-Default-Sources-Konstrukt

Sie können dieses Konstrukt verwenden, um Parameterdefinitionen aus anderen StyleBooks wiederzuverwenden.

Betrachten Sie ein Szenario, in dem ein Parameter oder eine Gruppe von Parametern wiederholt in mehreren StyleBooks verwendet wird. Um diese Parameter nicht neu zu definieren, können Sie sie jedes Mal, wenn Sie ein neues StyleBook erstellen möchten, einmal definieren und dann ihre Definitionen in die StyleBooks importieren, die diese Parameter benötigen, indem Sie das Konstrukt parameters-default-sources verwenden.

Wenn beispielsweise viele Ihrer StyleBooks eine virtuelle IP konfigurieren müssen, müssen Sie möglicherweise dieselben Parameter für virtuelle IPs in jedem neuen StyleBook definieren, das Sie erstellen. Stattdessen können Sie ein separates StyleBook mit dem Namen vip-params erstellen, in dem Sie alle damit verbundenen Parameter definieren, wie im folgenden Beispiel gezeigt:

     -
     name: vip-params
     namespace: com.acme.commontypes
     version: "1.0"
     description: This StyleBook defines a typical virtual IP config.
     private: true
     schema-version: "1.0"
     parameters:
       -
           name: lb-appname
           label: Load Balanced Application Name
          description: Name of the Load Balanced application
           type: string
           required: true
       -
           name: lb-virtual-ip
           label: Load Balanced App Virtual IP address
           description: Virtual IP address representing the Load Balanced application
           type: ipaddress
           required: true
       -
           name: lb-virtual-port
           label: Load Balanced App Virtual Port
           description: TCP port representing the Load Balanced application
           type: tcp-port
           default: 80
       -
           name: lb-service-type
           label: Load Balanced App Protocol
           description: Protocol used for the Load Balanced application.
           type: string
           default: HTTP
           required: true
           allowed-values:
                - HTTP
                - SSL
                - TCP

Anschließend können Sie andere StyleBooks erstellen, die diese Parameter verwenden. Es folgt ein Beispiel für ein solches StyleBook.

     -
     name: acme-biz-app
     namespace: com.acme.stylebooks
     version: "1.0"
     description: This stylebook defines the Citrix ADC configuration for Biz App
     schema-version: "1.0"
     import-stylebooks:
       -
          namespace: com.acme.commontypes
          prefix: cmtypes
          version: "1.0"
     parameters-default-sources:
           - cmtypes::vip-params
     parameters:
         -
           name: monitorname
           label: Monitor Name
           description: Name of the monitor
           type: string
           required: true
         -
           name: type
           label: Monitor Type
           description: Type of the monitor
           type: string
           required: true
           allowed-values:
             - PING
             - TCP
             - HTTP
             - HTTP-ECV
             - TCP-ECV
             - HTTP-INLINE

Im StyleBook, acme-biz-app, werden zuerst der Namespace und die Version des vip-params StyleBook mithilfe des Abschnitts import-stylebooks importiert. Dann wird das parameters-default-sources-Konstrukt hinzugefügt, und der StyleBook-Name, dh vip-params wird angegeben. Dies hat den gleichen Effekt wie die Definition der Parameter des vip-params StyleBook direkt in diesem StyleBook.

Sie können Parameter aus mehreren StyleBooks einbeziehen, da es sich bei den parameters-default-sources um eine Liste handelt und bei jedem Element in der Liste erwartet wird, dass es sich um ein StyleBook handelt.

Neben der Einbeziehung von Parametern aus anderen StyleBooks können Sie auch eigene Parameter definieren, indem Sie den Parameterbereich verwenden. Die vollständige Liste der Parameter des StyleBook ist die Kombination von Parametern aus anderen StyleBooks und Parametern, die in diesem StyleBook definiert sind. Daher bezieht sich der Ausdruck $parameters auf diese Kombination von Parametern.

Wenn ein Parameter sowohl in einem importierten StyleBook als auch im aktuellen StyleBook definiert ist, überschreibt die Definition im aktuellen StyleBook die aus einem anderen StyleBook importierte Definition. Sie können dies effektiv verwenden, indem Sie bei Bedarf einige der importierten Parameter anpassen und gleichzeitig die restlichen importierten Parameter verwenden.

Das Konstrukt parameters-default-sources kann auch in verschachtelten Parametern verwendet werden, wie gezeigt:

parameters:
    -
      name: vip-details
      label: Virtual IP details
      description: Details of the Virtual IP
      type: object
      required: true
      parameters-default-sources:
              - cmtypes::vip-params

Dies ähnelt dem, dass die Parameter der StyleBook vip-Parameter direkt als untergeordnete Parameter des vip-details-Parameters in diesem StyleBook hinzugefügt werden.

Parameters-Default-Sources-Konstrukt