From ae9fe9fe435b296522f7f359a43c379ab155c5e4 Mon Sep 17 00:00:00 2001 From: Dharmendra Date: Tue, 15 Dec 2020 11:08:06 +0530 Subject: [PATCH] adding sftpgo chart for nextcloud stack --- sftpgo/.helmignore | 23 ++++++++ sftpgo/Chart.yaml | 29 +++++++++ sftpgo/LICENSE | 19 ++++++ sftpgo/README.md | 45 ++++++++++++++ sftpgo/templates/NOTES.txt | 16 +++++ sftpgo/templates/_helpers.tpl | 62 ++++++++++++++++++++ sftpgo/templates/deployment.yaml | 88 ++++++++++++++++++++++++++++ sftpgo/templates/hpa.yaml | 28 +++++++++ sftpgo/templates/service.yaml | 26 ++++++++ sftpgo/templates/serviceaccount.yaml | 12 ++++ sftpgo/values.yaml | 78 ++++++++++++++++++++++++ 11 files changed, 426 insertions(+) create mode 100644 sftpgo/.helmignore create mode 100644 sftpgo/Chart.yaml create mode 100644 sftpgo/LICENSE create mode 100644 sftpgo/README.md create mode 100644 sftpgo/templates/NOTES.txt create mode 100644 sftpgo/templates/_helpers.tpl create mode 100644 sftpgo/templates/deployment.yaml create mode 100644 sftpgo/templates/hpa.yaml create mode 100644 sftpgo/templates/service.yaml create mode 100644 sftpgo/templates/serviceaccount.yaml create mode 100644 sftpgo/values.yaml diff --git a/sftpgo/.helmignore b/sftpgo/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/sftpgo/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/sftpgo/Chart.yaml b/sftpgo/Chart.yaml new file mode 100644 index 0000000..d75f98d --- /dev/null +++ b/sftpgo/Chart.yaml @@ -0,0 +1,29 @@ +apiVersion: v2 +type: application +name: sftpgo +version: 0.0.8 +appVersion: 1.2.2 +description: Fully featured and highly configurable SFTP server with optional FTP/S and WebDAV support. +keywords: + - sftp + - ftp + - webdav +home: https://github.com/drakkan/sftpgo +sources: + - https://github.com/drakkan/sftpgo + - https://github.com/sagikazarmark/helm-charts/tree/master/charts/sftpgo +maintainers: + - name: sagikazarmark + email: mark.sagikazar@gmail.com + url: https://sagikazarmark.hu +annotations: + artifacthub.io/changes: | + - Updated SFTPGo to 1.2.2 + artifacthub.io/images: | + - name: sftpgo + image: ghcr.io/drakkan/sftpgo:v1.2.2 + - name: sftpgo-alpine + image: ghcr.io/drakkan/sftpgo:v1.2.2-alpine + artifacthub.io/maintainers: | + - name: sagikazarmark + email: mark.sagikazar@gmail.com diff --git a/sftpgo/LICENSE b/sftpgo/LICENSE new file mode 100644 index 0000000..c08055e --- /dev/null +++ b/sftpgo/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2020 Márk Sági-Kazár + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/sftpgo/README.md b/sftpgo/README.md new file mode 100644 index 0000000..69cc89b --- /dev/null +++ b/sftpgo/README.md @@ -0,0 +1,45 @@ +# SFTPGo + +[SFTPGo](https://github.com/drakkan/sftpgo) is a fully featured and highly configurable SFTP server with optional FTP/S and WebDAV support, written in Go. It can serve local filesystem, S3 (compatible) Object Storage, Google Cloud Storage and Azure Blob Storage. + + +## TL;DR; + +```bash +helm repo add skm https://charts.sagikazarmark.dev +helm install --name sftpgo skm/sftpgo +``` + + +## Introduction + +This chart bootstraps an [SFTPGo](https://github.com/drakkan/sftpgo) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. + + +## Prerequisites + +- Kubernetes 1.18+ +- Helm 3.4+ +- SFTPGo 1.2.0+ + + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```bash +helm install --name my-release skm/sftpgo +``` + +> **Tip**: List all releases using `helm list` + + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```bash +helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. diff --git a/sftpgo/templates/NOTES.txt b/sftpgo/templates/NOTES.txt new file mode 100644 index 0000000..e3c3908 --- /dev/null +++ b/sftpgo/templates/NOTES.txt @@ -0,0 +1,16 @@ +1. Get the application URL by running these commands: +{{- if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "sftpgo.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "sftpgo.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "sftpgo.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "sftpgo.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/sftpgo/templates/_helpers.tpl b/sftpgo/templates/_helpers.tpl new file mode 100644 index 0000000..194a8b4 --- /dev/null +++ b/sftpgo/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "sftpgo.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "sftpgo.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "sftpgo.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "sftpgo.labels" -}} +helm.sh/chart: {{ include "sftpgo.chart" . }} +{{ include "sftpgo.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "sftpgo.selectorLabels" -}} +app.kubernetes.io/name: {{ include "sftpgo.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "sftpgo.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "sftpgo.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/sftpgo/templates/deployment.yaml b/sftpgo/templates/deployment.yaml new file mode 100644 index 0000000..5d30720 --- /dev/null +++ b/sftpgo/templates/deployment.yaml @@ -0,0 +1,88 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "sftpgo.fullname" . }} + labels: + {{- include "sftpgo.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "sftpgo.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "sftpgo.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "sftpgo.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default (printf "v%s" .Chart.AppVersion) }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + args: + - sftpgo + - serve + env: + - name: SFTPGO_SFTPD__BIND_PORT + value: "2022" + - name: SFTPGO_SFTPD__BIND_ADDRESS + value: "0.0.0.0" + - name: SFTPGO_HTTPD__BIND_PORT + value: "8080" + - name: SFTPGO_HTTPD__BIND_ADDRESS + value: "0.0.0.0" + {{- with .Values.envFrom }} + envFrom: + {{- toYaml . | nindent 12 }} + {{- end }} + ports: + - name: sftp + containerPort: 2022 + protocol: TCP + - name: http + containerPort: 8080 + protocol: TCP + livenessProbe: + httpGet: + path: /api/v1/version + port: http + readinessProbe: + httpGet: + path: /api/v1/version + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/sftpgo/templates/hpa.yaml b/sftpgo/templates/hpa.yaml new file mode 100644 index 0000000..9d34c9e --- /dev/null +++ b/sftpgo/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "sftpgo.fullname" . }} + labels: + {{- include "sftpgo.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "sftpgo.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/sftpgo/templates/service.yaml b/sftpgo/templates/service.yaml new file mode 100644 index 0000000..e43824a --- /dev/null +++ b/sftpgo/templates/service.yaml @@ -0,0 +1,26 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "sftpgo.fullname" . }} + labels: + {{- include "sftpgo.labels" . | nindent 4 }} + {{- with .Values.service.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + type: {{ .Values.service.type }} + {{- with .Values.service.externalTrafficPolicy }} + externalTrafficPolicy: {{ . }} + {{- end }} + ports: + - port: {{ .Values.service.sshport }} + targetPort: sftp + protocol: TCP + name: sftp + - port: {{ .Values.service.httpport }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "sftpgo.selectorLabels" . | nindent 4 }} diff --git a/sftpgo/templates/serviceaccount.yaml b/sftpgo/templates/serviceaccount.yaml new file mode 100644 index 0000000..6ce24ce --- /dev/null +++ b/sftpgo/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "sftpgo.serviceAccountName" . }} + labels: + {{- include "sftpgo.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/sftpgo/values.yaml b/sftpgo/values.yaml new file mode 100644 index 0000000..1af3e79 --- /dev/null +++ b/sftpgo/values.yaml @@ -0,0 +1,78 @@ +# Default values for sftpgo. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: ghcr.io/drakkan/sftpgo + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + annotations: {} + type: ClusterIP + sshport: 22 + httpport: 8080 + + # Route external traffic to node-local or cluster-wide endoints. + # https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip + # externalTrafficPolicy: Cluster + +volumes: [] + +volumeMounts: [] + +envFrom: [] + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {}