https://github.com/artefactory/sftp-gateway
This repository contains a docker image configured to use the SSH File Transfer Protocol (SFTP) to transfer all its files to Cloud Blob Storage Services. This image can be deployed on a Kubernetes cluster with Helm.
https://github.com/artefactory/sftp-gateway
docker gcs helm inotify kubernetes python3 s3 sftp
Last synced: 6 months ago
JSON representation
This repository contains a docker image configured to use the SSH File Transfer Protocol (SFTP) to transfer all its files to Cloud Blob Storage Services. This image can be deployed on a Kubernetes cluster with Helm.
- Host: GitHub
- URL: https://github.com/artefactory/sftp-gateway
- Owner: artefactory
- License: lgpl-3.0
- Created: 2018-09-17T09:16:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T15:21:54.000Z (almost 3 years ago)
- Last Synced: 2023-05-29T14:32:23.908Z (over 2 years ago)
- Topics: docker, gcs, helm, inotify, kubernetes, python3, s3, sftp
- Language: Python
- Homepage:
- Size: 550 KB
- Stars: 20
- Watchers: 5
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# sftp-gateway
## Architecture
A Docker image containing a SSH server and an INotify daemon allows to create a SFTP gateway server. Once deployed, you can connect to the SFTP server and read/write files that are immediately synchronised to GCS, S3, Azure Blob Storage (in development) and/or other cloud storage services.
The repository contains the appropriate files to deploy the container to Kubernetes.
## Maintainer
- Cédric Magnan (@Cedric-Magnan or cedric.magnan@artefact.com)
## Overview
When you run a container based on this image, it creates a SFTP server that can only be accessed by specific users, and moves to uploaded data to one or more specific buckets.
The users and the buckets are provided at runtime via container Environment variables. When the container starts, it uses the Environment variables to generate the appropriate configuration files and start the services. The container does not persist any data by default.
The docker image does not contain any credentials, they must be provided during the container deployment via a mounted secrets volume on Kubernetes, or a mounted volume for vanilla Docker. See below for more information.
## Quick setup
- 1/ Setup your environment by running `export ENV=dev` (here `dev` for example). Also run the following command : `export PYTHONPATH=$PYTHONPATH:.`
- 2/ Fill in your configuration by copying the `./config/example.yaml` into a new `./config/${ENV}.yaml` file and replace the values by the ones you need for your project.
- 3/ Add your secrets into the `./credentials/${ENV}` folder or let the project generate them for you.
- 4/ Test your configuration by running the following command : `make docker_run`
- 5/ Generate or copy an existing external IPv4 address that can be used by your Kubernetes cluster in your configuration file under APP -> SERVICE_IP.
- 6/ Deploy the SFTP on Kubernetes by running the following command : `make helm_install`
## Table of contents
- [0 - Installation](./docs/0-Installation.md)
- [1 - Environment configuration](./docs/1-EnvironmentConfiguration.md)
- [2 - Keys generation](./docs/2-KeysGeneration.md)
- [3 - Cloud configuration](./docs/3-CloudConfiguration.md)
- [4 - Docker configuration](./docs/4-DockerConfiguration.md)
- [5 - Cluster configuration](./docs/5-ClusterConfiguration.md)
- [6 - SFTP connection](./docs/6-SFTPConnection.md)