chaffelson/NiFi Flow CI/CD
CI/CD actions for Apache NiFi flows using nipyapi CLI
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | Command: ensure-registry, deploy-flow, start-flow, stop-flow, cleanup, configure-params, get-status, change-version, revert-flow, purge-flowfiles, export-flow-definition, import-flow-definition, list-registry-flows, get-versions, get-diff | yes | — |
| nifi-api-endpoint | NiFi API endpoint URL | yes | — |
| nifi-username | NiFi username | no | "" |
| nifi-password | NiFi password | no | "" |
| nifi-bearer-token | NiFi bearer token (alternative to username/password) | no | "" |
| nifi-verify-ssl | Verify SSL certificates | no | true |
| registry-token | PAT for Git repository access (GitHub or GitLab) | no | "" |
| registry-repo | Repository in owner/repo format | no | "" |
| registry-client-name | Name for the registry client | no | "" |
| registry-client-id | ID of the registry client | no | "" |
| repository-path | Path within repository | no | "" |
| bucket | Bucket containing the flow | no | "" |
| flow | Flow name | no | "" |
| branch | Branch to deploy from | no | "" |
| version | Version to deploy | no | "" |
| process-group-id | ID of the Process Group | no | "" |
| parameters | JSON object of parameters | no | "" |
| log-level | Log level: ERROR, WARNING (default), INFO, DEBUG | no | WARNING |
| file-path | File path for export/import operations | no | "" |
| parent-id | Parent process group ID for import operations | no | "" |
| export-mode | Export format: json or yaml | no | json |
| detailed | Include full details in list-registry-flows output | no | false |
| disable-controllers | Disable controller services (for stop-flow, needed before deletion) | no | false |
| delete-parameter-context | Delete parameter context during cleanup (for CI/CD full cleanup) | no | false |
| force | Force deletion even with queued FlowFiles | no | false |
Outputs
| name | description |
|---|---|
| registry-client-id | ID of the registry client |
| registry-client-name | Name of the registry client |
| process-group-id | ID of the deployed Process Group |
| process-group-name | Name of the deployed Process Group |
| deployed-version | Version deployed |
| started | Whether the flow was started |
| stopped | Whether the flow was stopped |
| state | Current state of the process group |
| running-processors | Number of running processors |
| enabled-controllers | Number of enabled controller services |
| version-state | Version control state (UP_TO_DATE, LOCALLY_MODIFIED, etc) |
| parameters-updated | Whether parameters were updated |
| previous-version | Previous version before change |
| new-version | New version after change |
| reverted | Whether the flow was reverted |
| purged | Whether flowfiles were purged |
| connections-purged | Number of connections purged |
| deleted | Whether the process group was deleted |
| deleted-name | Name of the deleted process group |
| file-path | Path to exported file |
| format | Export format (json/yaml) |
| source | Source of import (file/string) |
| parent-id | Parent process group ID |
| flow-count | Number of flows found in bucket |
| flows | JSON array of flow information |
| current-version | Currently deployed version |
| version-count | Number of versions available |
| versions | JSON array of version metadata |
| modification-count | Number of modified components |
| modifications | JSON array of modification details |
| success | Whether the command succeeded |