GCS SFTP Server

SFTP Server designed to store data in Google Cloud Storage (GCS) Buckets

This is based upon mikeghen/kubernetes-gcs-sftp project.

Setup Instructions

Deployment

To deploy to GKE follow these steps:

1. Create Service Account JSON key file for your bucket

https://cloud.google.com/iam/docs/service-accounts-create#iam-service-accounts-create-gcloud https://cloud.google.com/iam/docs/creating-managing-service-account-keys

Example:

export GCS_ACCOUNT=my-gcs-account
export BUCKET=my-bucket
export BUCKET_LOCATION=us
export PROJECT_NAME=MY_PROJECT
export PROJECT_ID=my-project-id.iam.gserviceaccount.com

gcloud config set project ${PROJECT_NAME}
gcloud iam service-accounts create ${GCS_ACCOUNT}
gcloud storage buckets create gs://${BUCKET} --location=${BUCKET_LOCATION}
gcloud storage buckets add-iam-policy-binding gs://${BUCKET} --member=serviceAccount:${GCS_ACCOUNT}@${PROJECT_ID} --role=roles/storage.objectAdmin
gcloud iam service-accounts keys create gcloud-key.json --iam-account=${GCS_ACCOUNT}@${PROJECT_ID}

2. Generate SSH private key

ssh-keygen -t rsa -b 4096 -f ssh_host_rsa_key -N ''

3. Setup Secrets

You can run these commands to put these files on the cluster as secrets:

kubectl create secret generic sftp-gcloud-key --from-file=gcloud-key.json
kubectl create secret generic ssh-secret-key --from-file=ssh_host_rsa_key

4. Create users.yaml file:

for example:

users:
  - user: my-user-1
    password: my-password-1
    bucket: my_gcs_bucket
  - user: my-user-2
    password: my-password-2
    bucket: my_gcs_bucket
    onlyDir: dir-for-user2

5. Deploy the SFTP server to Kubernetes:

helm upgrade -i k8s-sftp-gcs ./k8s-sftp-gcs -f users.yaml

6. Get the IP address and port:

kubectl get svc k8s-sftp-gcs

This will give you EXTERNAL-IP and port.

7. Check you SFTP server:

$ sftp -P 2022 username@1.2.3.4
username@1.2.3.4's password:
sftp> pwd
Remote working directory: /ftp