[
https://issues.apache.org/jira/browse/NIFI-3696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16041459#comment-16041459
]
ASF GitHub Bot commented on NIFI-3696:
--------------------------------------
Github user brosander commented on a diff in the pull request:
https://github.com/apache/nifi/pull/1889#discussion_r120720022
--- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -1317,6 +1318,82 @@ cluster if restarted and the flow for the cluster
has not changed. If the flow w
the removed node should be deleted before restarting the node to allow it
to obtain the cluster flow (otherwise
an uninheritable flow file exception may occur).
+=== File Manager
+
+The File Manager utility allows system administrators to take a backup of
an existing NiFi installation, install a new version of NiFi
+in a designated location (while migrating any previous configuration
settings) or restore an installation from a previous backup.
+File Manager supports NiFi version 1.0.0 and higher and is available in
'file-manager.bat' file for use on Windows machines.
+
+To show help:
+
+ file-manager.sh -h
+
+The following are available options:
+
+* `-o,--operation <arg>` File operation (install | backup | restore)
+* `-b,--backupDir <arg>` Backup NiFi Directory (used with backup or
restore operation)
+* `-c,--nifiCurrentDir <arg>` Current NiFi Installation Directory (used
optionally with install or restore operation)
+* `-d,--nifiInstallDir <arg>` NiFi Installation Directory (used with
install or restore operation)
+* `-i,--installFile <arg>` NiFi Install File (used with install operation)
+* `-r,--nifiRollbackDir <arg>` NiFi Installation Directory (used with
install or restore operation)
+* `-t,--bootstrapConf <arg>` Current NiFi Bootstrap Configuration File
(used optionally)
+* `-m,--moveRepositories` Allow repositories to be moved to new/restored
nifi directory from existing installation, if available (used optionally with
install or restore operation)
+* `-x,--overwriteConfigs` Overwrite existing configuration directory with
upgrade changes (used optionally with install or restore operation)
+* `-v,--verbose` Verbose messaging (optional)
+* `-h,--help` Print help info (optional)
+
+Example usage on Linux:
+
+ # backup NiFi installation
+ # option -t may be provided to ensure backup of external boostrap.conf
file
+ ./file-manager.sh
+ -o backup
+ –b /tmp/nifi_bak
+ –c /usr/nifi_old
+ -v
+
+ # install NiFi using compressed tar file into /usr/nifi directory (should
install as /usr/nifi/nifi-1.3.0).
--- End diff --
We should notify the user that if they upgrade with -m to also move
repositories, start nifi, then try to downgrade, it's likely that the older
implementation will not be able to read the newer repos.
> Create File Manager & Config Migration Utilities
> ------------------------------------------------
>
> Key: NIFI-3696
> URL: https://issues.apache.org/jira/browse/NIFI-3696
> Project: Apache NiFi
> Issue Type: Sub-task
> Components: Tools and Build
> Reporter: Yolanda M. Davis
> Assignee: Yolanda M. Davis
>
> The File Manager utility should allow administrators to automate the backup a
> nifi installation, install a new nifi instance or restore from a previous
> backup on the command line. The File Manager should support both tar.gz and
> unzip files and should support both linux and windows environments.
> The Config Migration tool should support the File Manager utility in
> migrating configurations from one version of nifi to the next. This could
> include adding or removing properties or changing formats of files depending
> on the rules for a given version.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
