Backup and Restore for MySQL-8.0.14 (#3)

Author: shudipta

.gitignore

@@ -29,3 +29,4 @@ _testmain.go
 /bin
 /coverage.txt
 /dist
+.env*

Dockerfile.dbg

@@ -19,6 +19,14 @@ RUN set -x
 
 FROM {ARG_FROM}
 
+ENV DEBIAN_FRONTEND noninteractive
+ENV DEBCONF_NONINTERACTIVE_SEEN true
+
+RUN set -x \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends ca-certificates \
+  && rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man /tmp/*
+
 COPY --from=0 restic_{NEW_RESTIC_VER} /bin/restic_{NEW_RESTIC_VER}
 COPY bin/{ARG_OS}_{ARG_ARCH}/{ARG_BIN} /{ARG_BIN}
 

Dockerfile.in

@@ -19,6 +19,14 @@ RUN set -x
 
 FROM {ARG_FROM}
 
+ENV DEBIAN_FRONTEND noninteractive
+ENV DEBCONF_NONINTERACTIVE_SEEN true
+
+RUN set -x \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends ca-certificates \
+  && rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man /tmp/*
+
 COPY --from=0 /restic_{NEW_RESTIC_VER} /bin/restic_{NEW_RESTIC_VER}
 COPY bin/{ARG_OS}_{ARG_ARCH}/{ARG_BIN} /{ARG_BIN}
 

Makefile

@@ -16,11 +16,11 @@
 SHELL=/bin/bash -o pipefail
 
 # The binary to build (just the basename).
-BIN      := mysql-stash
+BIN      := stash-mysql
 COMPRESS ?= no
 
 # Where to push the docker image.
-REGISTRY ?= appscode
+REGISTRY ?= stashed
 
 # This version-strategy uses git tags to set the version string
 git_branch       := $(shell git rev-parse --abbrev-ref HEAD)

README.md

@@ -1,19 +1,35 @@
 [![Go Report Card](https://goreportcard.com/badge/stash.appscode.dev/mysql)](https://goreportcard.com/report/stash.appscode.dev/mysql)
 [![Build Status](https://travis-ci.org/stashed/mysql.svg?branch=master)](https://travis-ci.org/stashed/mysql)
-[![Docker Pulls](https://img.shields.io/docker/pulls/appscode/mysql-stash.svg)](https://hub.docker.com/r/appscode/mysql-stash/)
+[![Docker Pulls](https://img.shields.io/docker/pulls/stashed/stash-mysql.svg)](https://hub.docker.com/r/stashed/stash-mysql/)
 [![Slack](https://slack.appscode.com/badge.svg)](https://slack.appscode.com)
 [![Twitter](https://img.shields.io/twitter/follow/appscodehq.svg?style=social&logo=twitter&label=Follow)](https://twitter.com/intent/follow?screen_name=AppsCodeHQ)
 
 # MySQL
+
 MySQL backup and restore plugin for [Stash by AppsCode](https://appscode.com/products/stash).
 
----
+## Install
+
+Install MySQL 8.0.14 backup or restore plugin for Stash as below.
+
+```console
+helm repo add appscode https://charts.appscode.com/stable/
+helm repo update
+helm install appscode/stash-mysql --name=stash-mysql-8.0.14 --version=8.0.14
+```
 
-**Stash binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`.
+To install catalog for all supported MySQL versions, please visit [here](https://github.com/stashed/catalog).
 
----
+## Uninstall
+
+Uninstall MySQL 8.0.14 backup or restore plugin for Stash as below.
+
+```console
+helm delete stash-mysql-8.0.14
+```
 
 ## Support
+
 We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. To sign up, use our [Slack inviter](https://slack.appscode.com/).
 
 If you have found a bug with Stash or want to request for new features, please [file an issue](https://github.com/stashed/stash/issues/new).

chart/stash-mysql/.helmignore

@@ -0,0 +1,22 @@
+# 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
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

chart/stash-mysql/Chart.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+description: 'stash-mysql - MySQL database backup and restore plugin for Stash by AppsCode'
+name: stash-mysql
+version: 8.0.14
+appVersion: 8.0.14
+home: https://github.com/stashed/mysql
+icon: https://cdn.appscode.com/images/icon/stash.png
+sources:
+  - https://github.com/stashed/mysql
+maintainers:
+  - name: appscode
+    email: support@appscode.com

chart/stash-mysql/README.md

@@ -0,0 +1,79 @@
+# stash-mysql
+
+[stash-mysql](https://github.com/stashed/mysql) - MySQL database backup/restore plugin for [Stash by AppsCode](https://appscode.com/products/stash/).
+
+## TL;DR;
+
+```console
+$ helm repo add appscode https://charts.appscode.com/stable/
+$ helm repo update
+$ helm install appscode/stash-mysql --name=stash-mysql-8.0.14 --version=8.0.14
+```
+
+## Introduction
+
+This chart installs necessary `Functions` and `Tasks` definitions to take backup of MySQL-8.0.14 databases and restore them using Stash.
+
+## Prerequisites
+
+- Kubernetes 1.11+
+
+## Installing the Chart
+
+- Add AppsCode chart repository to your helm repository list,
+
+```console
+$ helm repo add appscode https://charts.appscode.com/stable/
+```
+
+- Update helm repositories to fetch latest charts from the remove repository,
+
+```console
+$ helm repo update
+```
+
+- Install the chart with the release name `stash-mysql-8.0.14` run the following command,
+
+```console
+$ helm install appscode/stash-mysql --name=stash-mysql-8.0.14 --version=8.0.14
+```
+
+The above commands installs `Functions` and `Task` CRDs that are necessary to take backup of MySQL-8.0.14 databases and restore them using Stash.
+
+## Uninstalling the Chart
+
+To uninstall/delete the `stash-mysql-8.0.14` run the following command,
+
+```console
+helm delete stash-mysql-8.0.14 --purge
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+
+The following table lists the configurable parameters of the `stash-mysql` chart and their default values.
+
+|     Parameter     |                                                                    Description                                                                     |      Default      |
+| :---------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------: |
+| `docker.registry` | Docker registry used to pull respective images                                                                                                     |     `stashed`     |
+| `docker.image`    | Docker image used to take backup of MySQL databases and restore them                                                                               |   `stash-mysql`   |
+| `docker.tag`      | Tag of the image that is used to take backup of MySQL databases and restore them. This is usually same as the database version it can take backup. |       `8.0.14`       |
+| `backup.myArgs`   | Optional arguments to pass to `mysqldump` command  during bakcup process                                                                           | `--all-databases` |
+| `restore.myArgs`  | Optional arguments to pass to `mysql` command during restore process                                                                               |        ""         |
+| `metrics.enabled` | Specifies whether to send Prometheus metrics                                                                                                       |      `true`       |
+| `metrics.labels`  | Optional comma separated labels to add to the Prometheus metrics                                                                                   |        []         |
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+For example:
+
+```console
+helm install --name stash-mysql-8.0.14 --set metrics.enabled=false appscode/stash-mysql
+```
+
+**Tips:** Use escape character (`\`) while providing multiple comma-separated labels for `metrics.labels`.
+
+```console
+ helm install chart/stash-mysql --set metrics.labels="k1=v1\,k2=v2"
+```

chart/stash-mysql/templates/NOTES.txt

@@ -0,0 +1,7 @@
+To verify that all Functions are installed successfully, run:
+
+  kubectl get function.stash.appscode.com
+
+To verify that all Tasks are installed successfully, run:
+
+  kubectl get task.stash.appscode.com

chart/stash-mysql/templates/_helpers.tpl

@@ -0,0 +1,45 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "stash-mysql.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 "stash-mysql.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 "stash-mysql.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "stash-mysql.labels" -}}
+app.kubernetes.io/name: {{ include "stash-mysql.name" . }}
+helm.sh/chart: {{ include "stash-mysql.chart" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}