openstack
/
freezer
Code Issues Proposed changes

Add ftp support document modification 

The patch add ftp document modification

Change-Id: Ia99af6051f40b1d2f77c6504676ba5e6a6e04350
This commit is contained in:
gecong1973 2018-11-20 23:34:01 -08:00
parent 1b502f2b2b
commit 750c4e7d12
1 changed files with 86 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
doc/source/user/freezer-agent.rst
View File

@ -19,7 +19,8 @@ Backup Options
Freezer Agent can be used as standalone backup tool from command line.
In it is most simple form, you can run commands to backup your data to
OpenStack Swift, local directory, remote SSH or S3 compatible storage.
OpenStack Swift, local directory, remote SSH or S3 compatible storage
or remote FTP or FTPS storage.
Basic File System Backup
------------------------
@ -266,7 +267,7 @@ Restore example:
SSH Storage Backup/Restore
--------------------------
Freezer can use ssh to backup the data in fould on remote server. This option
Freezer can use ssh to backup the data to remote server. This option
will turn any Linux server to backup storage.
To use ssh storage specify "--storage ssh" And use "--container %path-to-folder-with-backups-on-remote-machine%"
@ -299,6 +300,89 @@ Restore example:
--storage ssh --ssh-username ubuntu --ssh-key ~/.ssh/id_rsa \
--ssh-host 8.8.8.8
FTP Storage Backup/Restore
--------------------------
Freezer can use FTP to backup the data to remote server. This option
will turn any FTP server to backup storage.
To use FTP storage specify "--storage ftp" And use "--container %path-to-folder-with-backups-on-remote-machine%"
Also you should specify ftp-username, ftp-password and ftp-host parameters. ftp-port is optional parameter, default is 21.
In order to use FTP to backup, "--storage ftp" and
"--container %path-to-folder-with-backups-on-remote-machine%" options must be
specified. Also ftp-username, ftp-password, ftp-host parameters must be supplied.
ftp-port parameter is optional and Freezer use default
ssh port 21 if not specified.
Backup example:
.. code:: bash
sudo freezer-agent --path-to-backup [/data/dir/to/backup] \
--container /remote-machine-path/ \
--backup-name my-backup-name \
--storage ftp --ftp-username [ftp-user-name] \
--ftp-password [ftp-user-password] \
--ftp-host 8.8.8.8 \
--ftp-port 21
Restore example:
.. code:: bash
sudo freezer-agent --action restore \
--restore-abs-pat [/data/dir/to/backup] \
--container /remote-machine-path/ \
--backup-name my-backup-name \
--storage ftp \
--ftp-username [ftp-user-name] \
--ftp-password [ftp-user-password] \
--ftp-host 8.8.8.8
--ftp-port 21
FTPS Storage Backup/Restore
---------------------------
Freezer can use FTPS to backup the data to remote server. This option
will turn any FTPS server to backup storage.
To use FTPS storage specify "--storage ftps" And use "--container %path-to-folder-with-backups-on-remote-machine%"
Also you should specify ftp-username, ftp-password and ftp-host parameters. ftp-port is optional parameter, default is 21.
In order to use FTPS to backup, "--storage ftps" and
"--container %path-to-folder-with-backups-on-remote-machine%" options must be
specified. Also ftp-username, ftp-password, ftp-host parameters must be supplied.
ftp-port parameter is optional and Freezer use default
ssh port 21 if not specified.
Backup example:
.. code:: bash
sudo freezer-agent --path-to-backup [/data/dir/to/backup] \
--container /remote-machine-path/ \
--backup-name my-backup-name \
--storage ftps \
--ftp-username [ftp-user-name] \
--ftp-password [ftp-user-password] \
--ftp-host 8.8.8.8 \
--ftp-port 21
Restore example:
.. code:: bash
sudo freezer-agent --action restore \
--restore-abs-pat [/data/dir/to/backup] \
--container /remote-machine-path/ \
--backup-name my-backup-name \
--storage ftps \
--ftp-username [ftp-user-name] \
--ftp-password [ftp-user-password] \
--ftp-host 8.8.8.8
--ftp-port 21
Restore
=======