Mandatory Form-Data
Mandatory form-data contain the files necessary for the deployment.
- archiveFile
- Specifies your BusinessEvents archive file (.zip or .ear file) to upload to the Silver Fabric Broker, which then publishes the archive to the appropriate Silver Fabric engine. Multiple application archives can be deployed in a single archive .zip or EAR file. You can deploy and run them all (default behavior) or you can selectively run a list of archives in a by specifying the list with the Archives form-data field. You can upload the archives using the component wizard also.
- CDD
- Specify the Cluster Deployment Descriptor (CDD) file used to configure your project for deployment. Refer to the TIBCO ActiveMatrix BusinessEvents documentation on the use of CDD files for more information on which application project parameters can be set and how to generate the CDD file. Example syntax:
-F "CDD=YourCDD_FileName.cdd"
- PUID
- Specify the processing unit ID (PUID) for the engine. Specify the value of PUID as in the *.cdd file or as "default"
- -v
- Specifies the target of the cURL POST execution and asks for a verbose response. The cURL -v expression should specify the appropriate Silver Fabric directory. For the default installation that expression looks like the following:
-v "http://YourSilverFabricBrokerName.com:<port>/livecluster/rest/v1/sf/engines/archives"
Where the default http <port> is 8080 and optional form-data fields can specify other continuous deployment behavior.
- deploymentFile
- Specifies the properties file that defines endpoint selection criteria described as follows.
-F "deploymentFile=@YourDeploymentFileName.properties"
When deploying an archive by REST, you must include the deployment file, which specifies at least one selection criterion for determining which engine and component receives the deployed archive. The deployment file is a simple properties text file specified by a form-data field like the following for REST upload with the archive:
-F "deploymentFile=@YourDeploymentFileName.properties"
The deployment file contains one or more logical statements with a criterion, a comparator, and a value, delimited by spaces:
- criteria comparator value
- Some criteria require an argument to be specified in parentheses:
- criteria(argument) comparator value
- For example, the following is a simple statement to deploy an archive to an engine running a component with a component type that contains BusinessEvents as part of the name and which has a domain name,
YourDomain:
ComponentType contains BusinessEvents ImportedVariable(TIBCO_DOMAIN_NAME) = YourDomain
By default, all deployment file criteria statements must be satisfied for the deployment to occur. You can change how the properties file criteria are evaluated to make them logical or statements by using the optional cURL form-data switch: -F "LogicalAnd=false"
Supported Criteria Name Definition ComponentName The name of the component ComponentType The type of the component EnablerName The name of the Enabler running the component EnablerVersion The version of the Enabler running the component Account The name of the account running the component EngineProperty(name) The following named engine properties can be used: Engine Id Engine GUID Engine Instance IP Address Host Name Number of CPUs Total CPU Processing Power Total Memory (KB) Free Memory (KB) Free Disk Space (MB) OS Platform OS Version OS Username Location vimTemplate Group Description
ActivationInfoProperty(name) A named property, such as ClusterName, or HTTP_STATIC_ROUTE_PREFIX within the component’s ActivationInfo object. Archives that can be scaled elastically keep a list of ActivationInfo properties and their respective values for failover Broker ImportedVariable(name) A variable imported into a component ExportedVariable(name) A variable exported from a component Statistic(name) Supported BusinessEvents Enabler statistic such as: BE Process Count BE Memory Free Bytes BE Percentage of Memory Used BE Average Elapse Execution Time BE Total Number Error BE Last Number Error Total Memory Free Memory Free Disk CPU Utilization DS CPU Utilization Expected Engine Count Actual Engine Count Allocating Engine Count
ArchiveStatistic(statName, archiveName) A named statistic for a specified archive DependencyComponent A named dependency on a component DependencyEngine(componentName) A named dependency on an engine running the named component - Comparator
- Valid comparators include =, !=, >, <, <=, >=, matches, contains, !matches, and !contains.