[{"_1":2,"_189":-5,"_190":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_164":165},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_107":108,"_157":-5,"_158":11,"_159":17,"_160":11,"_161":-5,"_162":163},"canonicalUrl","https://hub.docker.com/r/caesarteam/aws-database-backup/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","caesarteam","reponame","aws-database-backup","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-08-19T12:16:26.341767Z","description","","is_private","last_updated","2020-12-08T12:00:33.464802Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",12865,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# aws-database-backup\n\naws-database-backup is a container image based on Alpine Linux. This container is designed to run in Kubernetes as a cronjob to perform automatic backups of MySQL/PostgreSQL databases to Amazon S3. It was created to meet my requirements for regular and automatic database backups. Having started with a relatively basic feature set, it is gradually growing to add more and more features.\n\nCurrently, aws-database-backup supports the backing up of MySQL/PostgreSQL Databases. It can perform backups of multiple MySQL/PostgreSQL databases from a single database host. When triggered, a full database dump is performed using the `mysqldump` or `pg_dump` command for each configured database. The backup(s) are then uploaded to an Amazon S3 Bucket. aws-database-backup features Slack Integration, and can post messages into a channel detailing if the backup(s) were successful or not.\n\nOver time, aws-database-backup will be updated to support more features and functionality. I currently use this container as part of my Kubernetes Architecture which you can read about [here](https://benjamin.maynard.io/this-blog-now-runs-on-kubernetes-heres-the-architecture/).\n\nAll changes are captured in the [changelog](CHANGELOG.md), which adheres to [Semantic Versioning](https://semver.org/spec/vadheres2.0.0.html).\n\n\n## Environment Variables\n\nThe below table lists all of the Environment Variables that are configurable for aws-database-backup.\n\n| Environment Variable | Purpose |\n| --------------------------- |------------------------------------------------------------------------------------------------------------------|\n| AWS_ACCESS_KEY_ID | **(Required)** AWS IAM Access Key ID. |\n| AWS_SECRET_ACCESS_KEY | **(Required)** AWS IAM Secret Access Key. Should have very limited IAM permissions (see below for example) and should be configured using a Secret in Kubernetes. |\n| AWS_DEFAULT_REGION | **(Required)** Region of the S3 Bucket (e.g. eu-west-2). |\n| AWS_BUCKET_NAME | **(Required)** The name of the S3 bucket. |\n| AWS_BUCKET_BACKUP_PATH | **(Required)** Path the backup file should be saved to in S3. E.g. `/database/myblog/backups`. **Do not put a trailing / or specify the filename.** |\n| DB_HOST | **(Required)** Hostname or IP address of the database Host. |\n| DB_PORT | **(Optional)** Port of the database is listening on (Default: 3306 (mysql) and 5432 (pgsql)). |\n| TARGET_DATABASE_NAMES | **(Required)** Name of the databases to dump. This should be comma seperated (e.g. `database1,database2`). |\n| DB_USER | **(Required)** Username to authenticate to the database with. |\n| DB_PASSWORD | **(Required)** Password to authenticate to the database with. Should be configured using a Secret in Kubernetes. |\n| ENCRYPT | **(Optional)** The backup will encrypt with the command `openssl enc -aes-256-cbc -salt`. Should be configured using a config in Kubernetes. |\n| ENCRYPT_PASS | **(Optional)** The password for encryption the database. Should be configured using a Secret in Kubernetes. |\n| SLACK_ENABLED | **(Optional)** (true/false) Enable or disable the Slack Integration (Default False). |\n| SLACK_USERNAME | **(Optional)** (true/false) Username to use for the Slack Integration (Default: aws-database-backup). |\n| SLACK_CHANNEL | **(Required if Slack enabled)** Slack Channel the WebHook is configured for. |\n| SLACK_WEBHOOK_URL | **(Required if Slack enabled)** What is the Slack WebHook URL to post to? Should be configured using a Secret in Kubernetes. |\n\n\n## Slack Integration\n\naws-database-backup supports posting into Slack after each backup job completes. The message posted into the Slack Channel varies as detailed below:\n\n* If the backup job is **SUCCESSFUL**: A generic message will be posted into the Slack Channel detailing that all database backups successfully completed.\n* If the backup job is **UNSUCCESSFUL**: A message will be posted into the Slack Channel with a detailed error message for each database that failed.\n\nIn order to configure aws-database-backup to post messages into Slack, you need to create an [Incoming WebHook](https://api.slack.com/incoming-webhooks). Once generated, you can configure aws-database-backup using the environment variables detailed above.\n\n## Configuring the S3 Bucket & AWS IAM User\n\naws-database-backup performs a backup to the same path, with the same filename each time it runs. It therefore assumes that you have Versioning enabled on your S3 Bucket. A typical setup would involve S3 Versioning, with a Lifecycle Policy.\n\nAn IAM Users should be created, with API Credentials. An example Policy to attach to the IAM User (for a minimal permissions set) is as follows:\n\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": \"s3:ListBucket\",\n \"Resource\": \"arn:aws:s3:::\"\n },\n {\n \"Sid\": \"VisualEditor1\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"s3:PutObject\"\n ],\n \"Resource\": \"arn:aws:s3:::/*\"\n }\n ]\n}\n```\n\n\n## Example Kubernetes Cronjob\n\nAn example of how to schedule this container in Kubernetes as a cronjob is below. This would configure a database backup to run each day at 01:00am. The AWS Secret Access Key, and Target Database Password are stored in secrets.\n\n```\napiVersion: v1\nkind: Secret\nmetadata:\n name: AWS_SECRET_ACCESS_KEY\ntype: Opaque\ndata:\n aws_secret_access_key: \n--\napiVersion: v1\nkind: Secret\nmetadata:\n name: TARGET_DATABASE_PASSWORD\ntype: Opaque\ndata:\n database_password: \n--\napiVersion: v1\nkind: Secret\nmetadata:\n name: SLACK_WEBHOOK_URL\ntype: Opaque\ndata:\n slack_webhook_url: \n--\napiVersion: batch/v1beta1\nkind: CronJob\nmetadata:\n name: my-database-backup\nspec:\n schedule: \"0 01 * * *\"\n jobTemplate:\n spec:\n template:\n spec:\n containers:\n - name: my-database-backup\n image: benjaminmaynard/aws-database-backup\n imagePullPolicy: Always\n env:\n - name: AWS_ACCESS_KEY_ID\n value: \"\"\n - name: AWS_SECRET_ACCESS_KEY\n valueFrom:\n secretKeyRef:\n name: AWS_SECRET_ACCESS_KEY\n key: aws_secret_access_key\n - name: AWS_DEFAULT_REGION\n value: \"\"\n - name: AWS_BUCKET_NAME\n value: \"\"\n - name: AWS_BUCKET_BACKUP_PATH\n value: \"\"\n - name: DB_HOST\n value: \"\"\n - name: DB_PORT\n value: \"\"\n - name: TARGET_DATABASE_NAMES\n value: \"\"\n - name: DB_USER\n value: \"\"\n - name: DB_PASSWORD\n valueFrom:\n secretKeyRef:\n name: DB_PASSWORD\n key: database_password\n - name: SLACK_ENABLED\n value: \"\"\n - name: SLACK_CHANNEL\n value: \"#chatops\"\n - name: SLACK_WEBHOOK_URL\n valueFrom:\n secretKeyRef:\n name: SLACK_WEBHOOK_URL\n key: slack_webhook_url\n restartPolicy: Never\n```\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",341717681,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":96,"_97":98,"_99":44,"_100":101,"_102":103,"_104":44,"_105":44,"_106":17},"id","ed73e8d944d449419aef780bc6d0bd00","uuid","ed73e8d9-44d4-4941-9aef-780bc6d0bd00","type","organization","orgname","full_name","Caesar.Team","location","London, UK","company","Caesar","profile_url","date_joined","2018-10-28T12:44:40.971931Z","gravatar_url","https://www.gravatar.com/avatar/02ff10dee0143ddf5b7769c2e5b10e20?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[109,146],{"_110":40,"_111":112,"_113":114,"_86":115,"_116":117,"_46":134,"_135":136,"_137":29,"_138":52,"_53":139,"_140":141,"_142":125,"_143":134,"_144":62,"_145":17},"content_type","creator",259659,"full_size",53942741,65880331,"images",[118],{"_119":120,"_121":122,"_123":44,"_124":125,"_126":127,"_128":129,"_130":44,"_131":-5,"_132":114,"_59":62,"_133":-5},"architecture","amd64","digest","sha256:9c4465a04da792f7df5050aee21d6bdb96b16ec3e9f38c206240503df19fef27","features","last_pulled","2026-09-15T14:19:03.184481394Z","last_pushed","2020-12-08T12:00:33Z","os","linux","os_features","os_version","size","variant","2020-12-08T12:00:32.426697Z","last_updater",4441177,"last_updater_username","media_type","latest","repository",7572020,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_110":40,"_111":112,"_113":147,"_86":148,"_116":149,"_46":154,"_135":112,"_137":155,"_138":52,"_53":156,"_140":141,"_142":152,"_143":154,"_144":62,"_145":17},53942801,79974731,[150],{"_119":120,"_121":151,"_123":44,"_124":152,"_126":153,"_128":129,"_130":44,"_131":-5,"_132":147,"_59":62,"_133":-5},"sha256:ff0d8301d7e1baedfdd4656df3885d732522d315c6573563772676b927311deb","2026-09-15T14:18:43.951064254Z","2019-12-16T15:04:13Z","2019-12-16T15:22:25.454626Z","beshkenadze","mariadb","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":166,"_173":174,"_162":187,"_188":11},{"_36":167,"_38":168,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":169,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":170,"_75":11,"_76":172,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":171},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_175":176,"_177":-5,"_178":-5,"_179":180},"count",2,"next","previous","results",[181,184],{"_110":40,"_111":112,"_113":114,"_86":115,"_116":182,"_46":134,"_135":136,"_137":29,"_138":52,"_53":139,"_140":141,"_142":125,"_143":134,"_144":62,"_145":17},[183],{"_119":120,"_121":122,"_123":44,"_124":125,"_126":127,"_128":129,"_130":44,"_131":-5,"_132":114,"_59":62,"_133":-5},{"_110":40,"_111":112,"_113":147,"_86":148,"_116":185,"_46":154,"_135":112,"_137":155,"_138":52,"_53":156,"_140":141,"_142":152,"_143":154,"_144":62,"_145":17},[186],{"_119":120,"_121":151,"_123":44,"_124":152,"_126":153,"_128":129,"_130":44,"_131":-5,"_132":147,"_59":62,"_133":-5},[],"canDeleteTags","actionData","errors"]

caesarteam/aws-database-backup

Tags for caesarteam/aws-database-backup