change-flow-version¶
- subtitle
Change flow version of a running deployment.
- version
0.9.121
Description¶
Change flow version of a running deployment.
Synopsis¶
change-flow-version
--environment-crn <value>
--deployment-crn <value>
[--parameter-groups <value>]
[--kpis <value>]
[--strategy <value>]
[--wait-for-flow-to-stop-in-minutes <value>]
[--deployment-request-crn <value>]
[--asset-update-request-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--environment-crn
(string)
The CRN of an environment to execute the command.
--deployment-crn
(string)
The crn of the deployment being updated.
--parameter-groups
(array)
The list of flow parameter groups.
JSON Syntax:
[
{
"name": "string",
"parameters": [
{
"name": "string",
"description": "string",
"value": "string",
"sensitive": true|false,
"type": "TEXT"|"FILE"|"FILES",
"assetReferences": [
{ ... recursive ... }
...
],
"valueSet": true|false
}
...
]
}
...
]
--kpis
(array)
The list of configured KPIs.
JSON Syntax:
[
{
"metricId": "string",
"id": "string",
"metricComponentType": "SYSTEM"|"NIFI_FLOW"|"NIFI_PROCESSOR"|"NIFI_PROCESS_GROUP"|"NIFI_CONNECTION",
"alert": {
"thresholdMoreThan": {
"unitId": "string",
"value": double
},
"thresholdLessThan": {
"unitId": "string",
"value": double
},
"frequencyTolerance": {
"unit": {
"id": "SECONDS"|"MINUTES"|"HOURS"|"DAYS",
"label": "string",
"abbreviation": "string"
},
"value": double
}
},
"componentId": "string"
}
...
]
--strategy
(string)
The strategy to use during change flow version.
Possible values:
STOP_AND_PROCESS_DATA
STOP_AND_EMPTY_QUEUES
ONLY_RESTART_AFFECTED_COMPONENTS
--wait-for-flow-to-stop-in-minutes
(integer)
The max time in minutes to wait for the flow to process data.
--deployment-request-crn
(string)
The CRN of the deployment request.
--asset-update-request-crn
(string)
The CRN of the asset update request. Required when updating assets of an existing deployment.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
deploymentConfiguration -> (object)
Provides all of the configuration that dictates how a flow should be deployed.
configurationVersion -> (integer)
The version of this configuration.
parameterGroups -> (array)
The list of flow parameter groups.
item -> (object)
A flow parameter group
name -> (string)
The name of the parameter group
parameters -> (array)
The parameters in the group
item -> (object)
A flow parameter
name -> (string)
The name of the parameter
description -> (string)
The description of the param
value -> (string)
The value of the parameter
sensitive -> (boolean)
Whether or not the parameter value is sensitive
type -> (string)
The type of parameter. Possibly TEXT, FILE, FILES, DIRECTORY
assetReferences -> (array)
The list of referenced assets.
( … recursive … )
valueSet -> (boolean)
Indicates if the value of this parameter is set (i.e. not null)
autoScalingEnabled -> (boolean)
Specifies that auto-scaling should be enabled.
flowMetricsScalingEnabled -> (boolean)
Specifies that Flow metrics should be enabled for scaling.
autoScaleMinNodes -> (integer)
The minimum number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is true.
autoScaleMaxNodes -> (integer)
The maximum number of nodes that the cluster should scale to. May only be specified when autoScalingEnabled is true.
staticNodeCount -> (integer)
The static number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is false.
kpis -> (array)
The list of configured KPIs.
item -> (object)
An instantiated KPI specifying a metric on which to alert
metricId -> (string)
The id of the associated metric
id -> (string)
The id of the KPI; used only when viewing and editing existing KPIs
metricComponentType -> (string)
The component type of the associated metric
alert -> (object)
An alert configuration that specifies a configured frequency with lower and/or upper thresholds
thresholdMoreThan -> (object)
A configured alert threshold to pair together a statistical unit and value
unitId -> (string)
The identifier of the alert threshold unit to associate with the given threshold value
value -> (double)
The threshold value whose triggering causes an alert
thresholdLessThan -> (object)
A configured alert threshold to pair together a statistical unit and value
unitId -> (string)
The identifier of the alert threshold unit to associate with the given threshold value
value -> (double)
The threshold value whose triggering causes an alert
frequencyTolerance -> (object)
An alert configuration frequency tolerance for measuring an amount of time and unit for alert triggering
unit -> (object)
The alert frequency unit to use in KPI tolerances and metrics
id -> (string)
The id of the frequency unit
label -> (string)
The user-friendly label of the frequency unit
abbreviation -> (string)
The abbreviation for frequency unit
value -> (double)
The amount of time, associated with the given unit, a metric value can persist outside its boundaries before an alert is generated
componentId -> (string)
The optional process group ID, processor ID, or connection ID. This is a composite ID containing a chain of process group IDs representing the component’s full ancestry
deploymentId -> (string)
The id of the deployment.
deploymentCrn -> (string)
The CRN of the deployment.
name -> (string)
The name of the deployment
cfmNifiVersion -> (string)
The CFM NiFi version associated with the deployment.
autoStartFlow -> (boolean)
Indicates whether or not the flow should be started during deployment creation.
clusterSize -> (object)
Cluster scaling parameters.
name -> (string)
The name of this Cluster Size.
coresPerNode -> (double)
The number of CPU Cores per node (will be truncated to the nearest integer).
memoryLimit -> (double)
The memory limit (will be truncated to the nearest integer).
nodeStorageProfileName -> (string)
Node storage profile name.
parametersDirty -> (boolean)
Indicates whether or not all current parameter values have successfully been applied to NiFi.
kpisDirty -> (boolean)
Indicates whether or not the current KPIs have successfully been deployed as alert rules.
sizingAndScalingDirty -> (boolean)
Indicates whether or not the current sizing and scaling configuration has been successfully applied in Kubernetes.
lastUpdatedByUsername -> (string)
The username of the last person to update the deployment configuration.
inboundHostname -> (string)
The inbound hostname.
listenComponents -> (array)
Listen components port and protocol data.
item -> (object)
Provides subset of metadata of a Listen* component
protocol -> (string)
Inbound protocol
listenComponentType -> (string)
Listen component type
port -> (string)
Inbound port
projectCrn -> (string)
The crn of the project this deployment belongs to, or null if does not belong to a project.
assetConfigurationAvailable -> (boolean)
Indicates whether the cluster is configured to accept FILE/FILES type parameters.
Form Factors¶
public