Construct Parameters-default-sources
Vous pouvez utiliser ce construct pour réutiliser les définitions de paramètres d'autres StyleBooks.
Imaginez un scénario où un paramètre ou un groupe de paramètres est utilisé de manière répétée dans plusieurs StyleBooks. Pour éviter de redéfinir ces paramètres chaque fois que vous souhaitez créer un nouveau StyleBook, vous pouvez les définir une seule fois, puis importer leurs définitions dans les StyleBooks qui ont besoin de ces paramètres en utilisant le construct parameters-default-sources.
Par exemple, si plusieurs de vos StyleBooks doivent configurer une IP virtuelle, vous pourriez avoir à définir les mêmes paramètres liés aux IP virtuelles dans chaque nouveau StyleBook que vous créez. Au lieu de cela, vous pouvez créer un StyleBook distinct appelé, par exemple, « vip-params » où vous définissez tous les paramètres qui lui sont liés, comme indiqué dans l'exemple suivant :
-
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
Ensuite, vous pouvez créer d'autres StyleBooks qui utilisent ces paramètres. Voici un exemple d'un tel StyleBook.
-
name: acme-biz-app
namespace: com.acme.stylebooks
version: "1.0"
description: This stylebook defines the NetScaler 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
Dans le StyleBook, acme-biz-app, le namespace et la version du StyleBook vip-params sont d'abord importés à l'aide de la section « import-stylebooks ». Ensuite, le construct parameters-default-sources est ajouté et le nom du StyleBook, c'est-à-dire vip-params, est spécifié. Cela a le même effet que de définir les paramètres du StyleBook vip-params directement dans ce StyleBook.
Vous pouvez inclure des paramètres de plusieurs StyleBooks car le parameters-default-sources est une liste, et chaque élément de la liste est censé être un StyleBook.
En plus d'inclure des paramètres d'autres StyleBooks, vous pouvez également définir vos propres paramètres en utilisant la section des paramètres. La liste complète des paramètres du StyleBook est la combinaison des paramètres inclus d'autres StyleBooks et des paramètres définis dans ce StyleBook. Par conséquent, l'expression $parameters fait référence à cette combinaison de paramètres.
Notez que si un paramètre est défini à la fois dans un StyleBook importé et dans le StyleBook actuel, la définition dans le StyleBook actuel remplace la définition importée d'un autre StyleBook. Vous pouvez l'utiliser efficacement en personnalisant quelques-uns des paramètres importés si nécessaire, tout en utilisant le reste des paramètres importés tels quels.
Le construct parameters-default-sources peut également être utilisé dans les paramètres imbriqués, comme illustré :
parameters:
-
name: vip-details
label: Virtual IP details
description: Details of the Virtual IP
type: object
required: true
parameters-default-sources:
- cmtypes::vip-params
C'est similaire à l'ajout direct des paramètres du StyleBook vip-params en tant que paramètres enfants du paramètre vip-details dans ce StyleBook.