SFTP Gateway Support

3.0

SFTP Gateway 2.0 Update Process

Note: This page applies to SFTP Gateway version 2.x. Visit Here for documentation on version 3.x.

BEFORE YOU BEGIN!

This article is for updating version 2.x instances only. If you are currently on version 1.x, please refer to one of the following articles:

There are a couple of things to consider before upgrading your existing SFTP Gateway instance(s).

  • Make a snap shot of your existing EC2 instance as a backup in the event that something should go wrong during the update process. For more information on creating a snapshot, see this AWS EC2 documentation.

  • If you have made any modifications to the server, such as the /usr/local/bin/movetos3.sh or the /etc/ssh/sshd_config, make a backup of these files. These backups can be used for reference should these files be modified during the update process.

  • We recommend that you perform the update process in a test environment to verify continued functionality before applying changes to production environments. This can be done using the snapshot image suggested above.

  • We recommend backing up your user configurations with the standard backup and recovery solution found on our Backup and Recovery page.

Update paths

SFTP Gateway 1.004.x

SFTP Gateway 1.004.x or SFTP Gateway Classic is on Amazon Linux, and is a basic version of our software. Upgrading to 2.x requires a migration.

1.004.0 > 1.004.1 > 1.004.2 > 1.004.3 > 1.004.4

SFTP Gateway 2.000.x

SFTP Gateway 2.000.x is also on Amazon Linux, but introduces a web admin UI, API, and supports multiple instances. Updating to 2.001.x requires a migration, because of the change in OS.

2.000.00 > 2.000.01 > 2.000.02 > 2.000.03 > 2.000.04

SFTP Gateway 2.001.x

SFTP Gateway 2.001.x is on Amazon Linux 2, and makes better use of the task spooler to handle more files.

2.001.00 > 2.001.03

Updating from 2.000 to 2.001

Due to the change to Amazon Linux 2 for SFTP Gateway version 2.001.00 on AWS, there is no direct upgrade available. You will have to create a new EC2 instance to get version 2.001.00, however, we do have a migration guide with automated scripts that can help transfer your existing users and system configurations over to the new instance. Please see AWS SFTP Gateway Migration Guide for more information.

Updating a single instance

For 2.000.04 and newer

To update a single instance stack of SFTP Gateway to version 2.000.04 or newer

  1. Connect to the server over SSH with the ec2-user
ssh -i /path/to/private/key ec2-user@ip_address
  1. Run the update command
# To update to the newest version of SFTP Gateway run 
sudo sftpgw update

# To update to a specific version of SFTP Gateway run
sudo UPDATE_TO_VERSION=<version_number> sftpgw update

The update package will download and install automatically

For 2.000.03 and earlier

If you are running a single instance stack of SFTP Gateway, you can update it by the conventional means.

  1. Log into the server over SSH with the ec2-user
ssh -i /path/to/private/key ec2-user@ip_address
  1. run the update command
sudo sftpgw update

The SFTP Gateway packages will be downloaded and installed automatically.

Updating a High Availability stack of SFTP Gateway

Modify CloudFormation Template Method

SFTP Gateway version 2.0 High Availability uses an auto scaling group to keep the desired number of instance running at all times. The auto scaling group uses a launch configuration generated by the CloudFormation stack as a base configuration for all new instances that are launched into that auto scaling group. For this reason, the conventional method of updating an instance in the manner of connecting over SSH and running the update command does not work. If an instance was to go down for some reason, the instance that is brought up to replace it would be at the state of the original launch configuration that is behind a version. So to update any existing instances and any new instances created in case of failure or termination, you must update the launch configurations by editing the CloudFormation template.

To update your instances you must update the CloudFormation template then perform a scale out scale in process to maintain instance data:

  1. Update the CloudFormation stack:

    1. Go to the CloudFormation console

    2. Select your SFTP Gateway stack select-stack.png

    3. Click Actions -> Update Stack actions-update.png

    4. Click View/Edit template in Designer view-edit-template-in-designer.png

    5. In the text editor of Designer, find the userdata Property of LaunchConfiguration and add the update command sudo sftpgw update. add-update-command.png Note: The update command should be inserted before the cfn-init and cfn-signal commands. You can also specify which version number you would like to keep your instances at by supplying the UPDATE_TO_VERSION=<version_number> channel to the update command.

    6. Click the create stack icon at the top of the Designer create-stack-button.png

    7. Click Next through all of the configuration pages

    8. On the Review page, tick the IAM capabilities check box and click Update and click Update update-stack.png

    9. Once the stack says that the update is complete, proceed to the next step involving auto-scaling groups. update-complete.png

  2. Scale out/in your auto-scaling group:

    1. Go to the EC2 console -> Auto Scaling Groups

    2. Select your SFTP Gateway Auto Scaling Group select-auto-scaling-group.png

    3. Click Actions -> Edit actions-edit-asg.png

    4. In the Desired Capacity field, enter 4 (if your desired capacity is already at 4 you will have to drop it down to 2, let 2 instances terminate then go back to 4) and Save scale-out-instances.png

    5. Wait for the additional instances to enter "InService". service-status.png

      Note: that the instances without launch configurations are the older instances that will eventually be terminated. You should let the new instances run for a couple minutes to allow the older instances to transfer their existing data to the new instances.

    6. After a couple minutes of the new instances in the “InService” state, edit the auto scaling group again to set the desired capacity back to 2 and save. scale-in-instances.png

Using this upgrade technique, if a server happens to be terminated in the future, any new servers instantiated to replace it will update to the most recent compatible version automatically before going into service.

For 2.000.04

SFTP Gateway version 2.0 High Availability uses an auto-scaling group to keep the desired number of the instance running at all times. The auto-scaling group uses a launch configuration generated by the CloudFormation stack as a base configuration for all new instances that are launched into that auto-scaling group. For this reason, the conventional method of updating an instance in the manner of connecting over SSH and running the update command does not work. If an instance was to go down for some reason, the instance that is brought up to replace it would be at the state of the original launch configuration that is behind a version. So to update any existing instances and any new instances created in case of failure or termination, you must update the launch configurations by editing the CloudFormation template.

  1. Go to the CloudFormation console and select your SFTP Gateway stack sftpgw-2.0.4-update-select-stack

  2. Click Update sftpgw-2.0.4-update-actions-update

  3. Select replace current template sftpgw-2.0.4-update-replace-template

  4. Enter the 2.000.04 template S3 URL that matches your current setup

  5. Click Next until you get to the review page sftpgw-2.0.4-update-review-page

  6. At the bottom of the Review page, tick the IAM capabilities checkbox and click Update and click Update sftpgw-2.0.4-update-update-stack

  7. Once the stack status reads update complete, proceed to the next step involving auto-scaling groups. sftpgw-2.0.4-update-update-complete

  8. Go to the EC2 console -> Auto Scaling Groups

  9. Select your SFTP Gateway Auto Scaling Group sftpw-2.0-update-select-auto-scaling-group

  10. Click Actions -> Edit sftpw-2.0-update-actions-edit-asg

  11. In the Desired Capacity field, enter 4 (if your desired capacity is already at 4 you will have to drop it down to 2, let 2 instances terminate then go back to 4) and Save sftpw-2.0-update-scale-out-instances

  12. Wait for the additional instances to enter “InService” sftpgw-2.0-update-service-status Note: that the instances without launch configurations are the older instances that will eventually be terminated. You should let the new instances run for a couple of minutes to allow the older instances to transfer their existing data to the new instances (about 5 minutes to be on the safe side).

  13. SSH to one of the new server through the public IP address as the ec2-user

  14. Edit the /opt/sftpgw/application.properties file

    sudo nano /opt/sftpgw/application.properties

  15. Add the following line to the end of the file

    admin.connect.string=cn=admin

  16. Save the file with ctrl-o +

  17. Exit the nano text editor with ctrl-x

  18. Rename the SFTP Gateway Admin API configuration file

    sudo mv /opt/sftpgw/sftpgateway-admin-api-2.000.0X.conf /opt/sftpgw/sftpgateway-admin-api-2.000.04.conf

  19. Use SSM to send a restart SFTP Gateway Admin API command to all of the servers. (See SFTP Gateway 2.0 send SSM commands to multiple instances for instructions)

    sudo service sftpgw-admin-api restart

  20. After SFTP Gateway Admin API is restarted on the new servers, edit the auto-scaling group again to set the desired capacity back to 2 and save. sftpgw-2.0-update-scale-in-instances

Using this upgrade technique, if a server happens to be terminated in the future, any new servers instantiated to replace it will be of the 2.000.04 version.

← SFTP Gateway 2.0 Backup and RecoveryPassword Reset Issue →