Merge pull request #73 from jkaninda/docs

docs: update Kubernetes deployment

README.md

@@ -107,8 +107,12 @@ spec:
           # for a list of available releases.
           image: jkaninda/mysql-bkup
           command:
+            - /bin/sh
+            - -c
             - bkup
             - backup
+            - --storage
+            - s3
           resources:
             limits:
               memory: "128Mi"
@@ -125,6 +129,18 @@ spec:
             # Please use secret!
             - name: DB_PASSWORD
               value: ""
+            - name: AWS_S3_ENDPOINT
+              value: "https://s3.amazonaws.com"
+            - name: AWS_S3_BUCKET_NAME
+              value: "xxx"
+            - name: AWS_REGION
+              value: "us-west-2"
+            - name: AWS_ACCESS_KEY
+              value: "xxxx"
+            - name: AWS_SECRET_KEY
+              value: "xxxx"
+            - name: AWS_DISABLE_SSL
+              value: "false"
       restartPolicy: Never
 ```
 ## Available image registries

docs/_config.yml

@@ -13,10 +13,11 @@
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
-title: MySQL database backup
+title: MySQL Backup Docker container image
 email: hi@jonaskaninda.com
 description: >- # this means to ignore newlines until "baseurl:"
-  MySQL Backup and Restore Docker container image. Backup database to AWS S3 storage or SSH remote server.
+  MySQL Backup is a Docker container image that can be used to backup and restore MySQL database. 
+  It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
 
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "jkaninda.github.io/mysql-bkup/" # the base hostname & protocol for your site, e.g. http://example.com

docs/how-tos/deploy-on-kubernetes.md

@@ -28,6 +28,8 @@ spec:
           # for a list of available releases.
           image: jkaninda/mysql-bkup
           command:
+            - /bin/sh
+            - -c
             - bkup
             - backup
             - --storage
@@ -82,6 +84,8 @@ spec:
         # for a list of available releases.
         image: jkaninda/mysql-bkup
         command:
+        - /bin/sh
+        - -c
         - bkup
         - backup
         - --storage
@@ -138,6 +142,8 @@ spec:
         # for a list of available releases.
         image: jkaninda/mysql-bkup
         command:
+        - /bin/sh
+        - -c
         - bkup
         - restore
         - --storage
@@ -192,6 +198,8 @@ spec:
           - name: mysql-bkup
             image: jkaninda/mysql-bkup
             command:
+            - /bin/sh
+            - -c
             - bkup
             - backup
             - --storage
@@ -258,6 +266,8 @@ spec:
             - name: mysql-bkup
               image: jkaninda/mysql-bkup
               command:
+                - /bin/sh
+                - -c
                 - bkup
                 - backup
                 - --storage

examples/k8s-job.yaml

@@ -1,34 +1,40 @@
 apiVersion: batch/v1
-kind: CronJob
+kind: Job
 metadata:
-  name: bkup-job
+  name: backup
 spec:
-  schedule: "0 1 * * *"
-  jobTemplate:
-    spec:
   template:
     spec:
       containers:
         - name: mysql-bkup
+          # In production, it is advised to lock your image tag to a proper
+          # release version instead of using `latest`.
+          # Check https://github.com/jkaninda/mysql-bkup/releases
+          # for a list of available releases.
           image: jkaninda/mysql-bkup
           command:
             - /bin/sh
             - -c
-                - mysql-bkup backup -s s3 --path /custom_path
+            - bkup
+            - backup
+            - --storage
+            - s3
+          resources:
+            limits:
+              memory: "128Mi"
+              cpu: "500m"
           env:
             - name: DB_PORT
               value: "3306"
             - name: DB_HOST
               value: ""
             - name: DB_NAME
-                  value: ""
+              value: "dbname"
             - name: DB_USERNAME
-                  value: ""
+              value: "username"
             # Please use secret!
             - name: DB_PASSWORD
               value: ""
-                - name: ACCESS_KEY
-                  value: ""
             - name: AWS_S3_ENDPOINT
               value: "https://s3.amazonaws.com"
             - name: AWS_S3_BUCKET_NAME
@@ -41,4 +47,4 @@ spec:
               value: "xxxx"
             - name: AWS_DISABLE_SSL
               value: "false"
-          restartPolicy: OnFailure
+      restartPolicy: Never