mimas-postgresql 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082013adafb7795ab1e364ae00e5c092f4b75c1485745fe1e2cd74e0c5ab2768'
-  data.tar.gz: '0922ae80ccfb5863bf8bbfcf8f2f61a5b67ae46591490c9feb17d89299f1b7e2'
+  metadata.gz: bea84cbe83f0285815a8130ea675f80f09fe7583042b2004cff51af4828e7c1e
+  data.tar.gz: 29e4cc1be23d3c7c8134698ecd8a85671149123307316c83617eff019627ef7e
 SHA512:
-  metadata.gz: 81f3a5e2ef7ae98132a7d2cb9c915d5b1de0ee59951bf8b07c0dba2f1516084b642d524fcacdd61e9b7be8f43a8a11dae00400950d6c9eee70d01a788d9d3a3e
-  data.tar.gz: 7edc8d7066a4ac96ebe2b5dca9838aca15944b3e9d30c1a7941dcf0a60f6bc003277e16f9f1d369fd8b9dba12d98f3f7fcafb14b6874bffd1dc77783c00ccdde
+  metadata.gz: 8e9ed7a73b5ed61091c19e2cde5d3069afa5adcaf744f6d96791c669f5626c17ff3e3c775cbc4969c52e92738ac9d4d92e8ce6f6cf0aeee30d784340a816811a
+  data.tar.gz: b7712ba747f15a45a0ba30ba9e56062b343072a41d58e8b47ec01be6aa67c2412ac217a167118d38b93713c9f74a54a7d481895c523b742b37453008146d7b18

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-present Ayush Newatia
+
+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.

data/lib/mimas/plugins/postgresql/commands/configure.rb

@@ -5,7 +5,7 @@ module Mimas
         class Configure < Mimas::CLI::Commands::BaseCommand
           desc "Install configuration files for PostgreSQL."
 
-          argument :server_name,  required: true,   desc: "The name of the server to install PostgreSQL on"
+          argument :server_name,  required: true,   desc: "The name of the server to configure PostgreSQL on"
 
           option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
 

data/lib/mimas/plugins/postgresql/commands/console.rb

@@ -5,7 +5,7 @@ module Mimas
         class Console < Mimas::CLI::Commands::BaseCommand
           desc "Start the PostgreSQL console."
 
-          argument :server_name,  required: true,   desc: "The name of the server to install PostgreSQL on"
+          argument :server_name,  required: true,   desc: "The name of the server"
 
           option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
 

data/lib/mimas/plugins/postgresql/commands/create_db.rb

@@ -6,7 +6,7 @@ module Mimas
           desc "Create a new database on the server."
 
           argument :db_name,      required: true,   desc: "The name of the database to create"
-          argument :server_name,  required: true,   desc: "The name of the server to install PostgreSQL on"
+          argument :server_name,  required: true,   desc: "The name of the server"
 
           option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
           option :owner,  aliases: ["-o"], desc: "The owner of the database. Omit to create a new role named after the database"
@@ -24,8 +24,9 @@ module Mimas
                 say "Created a new role #{db_name.dup.bold.magenta} with password: #{password.bold.white}"
                 say "Ensure you save this password as it cannot be displayed again."
               end
+              owner = options[:owner] || db_name
 
-              session.run "sudo -u postgres psql -c \"CREATE DATABASE #{db_name} OWNER #{db_name};\"", capture: true
+              session.run "sudo -u postgres psql -c \"CREATE DATABASE #{db_name} OWNER #{owner};\"", capture: true
 
               say ""
               say "Created database named #{db_name.dup.bold.magenta}"

data/lib/mimas/plugins/postgresql/commands/create_role.rb

@@ -6,7 +6,7 @@ module Mimas
           desc "Create a new PostgreSQL role."
 
           argument :role_name,    required: true,   desc: "The name of the role to create"
-          argument :server_name,  required: true,   desc: "The name of the server to install PostgreSQL on"
+          argument :server_name,  required: true,   desc: "The name of the server"
 
           option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
           option :password,   aliases: ["-p"], desc: "The password for the role. Leave blank to autogenerate a secure password"

data/lib/mimas/plugins/postgresql/commands/prepare_backups.rb

@@ -0,0 +1,25 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        class PrepareBackups < Mimas::CLI::Commands::BaseCommand
+          desc "Install a backup script to trigger via cron"
+
+          argument :server_name,  required: true,   desc: "The name of the server to configure PostgreSQL on"
+
+          option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
+
+          def call(server_name:, **options)
+            server = Config.current.servers[server_name.to_sym]
+            sudo_user = options[:user]
+
+            server.install_backup_script(sudo_user: sudo_user)
+
+            say ""
+            say "PostgreSQL backups can now be scheduled via cron."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mimas/plugins/postgresql/commands/setup.rb

@@ -5,7 +5,7 @@ module Mimas
         class Setup < Mimas::CLI::Commands::BaseCommand
           desc "Install and configure PostgreSQL on the server."
 
-          argument :server_name,  required: true,   desc: "The name of the server to install PostgreSQL on"
+          argument :server_name,  required: true,   desc: "The name of the server to setup PostgreSQL on"
 
           option :user, default: "admin", aliases: ["-u"], desc: "A user with sudo access"
 
@@ -15,6 +15,7 @@ module Mimas
 
             server.install_postgresql(sudo_user: sudo_user)
             server.configure_postgresql(sudo_user: sudo_user)
+            server.install_backup_script(sudo_user: sudo_user)
 
             say ""
             say "PostgreSQL has been installed and configured! 🎉"

data/lib/mimas/plugins/postgresql/version.rb

@@ -1,7 +1,7 @@
 module Mimas
   module Plugins
     module PostgreSQL
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/mimas/plugins/postgresql.rb

@@ -5,12 +5,13 @@ module Mimas
 
       def register_commands(cli)
         cli.register "postgresql" do |pg|
-          pg.register "install",      Commands::Install
-          pg.register "console",      Commands::Console
-          pg.register "configure",    Commands::Configure
-          pg.register "setup",        Commands::Setup
-          pg.register "create_db",    Commands::CreateDB
-          pg.register "create_role",  Commands::CreateRole
+          pg.register "install",          Commands::Install
+          pg.register "console",          Commands::Console
+          pg.register "configure",        Commands::Configure
+          pg.register "setup",            Commands::Setup
+          pg.register "create_db",        Commands::CreateDB
+          pg.register "create_role",      Commands::CreateRole
+          pg.register "prepare_backups",  Commands::PrepareBackups
         end
       end
 

data/lib/mimas/plugins/server/postgresql.rb

@@ -32,6 +32,33 @@ module Mimas
             session.run "sudo systemctl restart postgresql"
           end
         end
+
+        def install_backup_script(sudo_user:)
+          ssh(self, user: sudo_user) do |session|
+            pg_home = Pathname.new("/").join("var", "lib", "postgresql")
+            private_key_file_name = "pg_dump_private_key.pem"
+
+            # Create certificate and private key for backups
+            session.run "sudo -u postgres bash -c \"cd ~; openssl req -x509 -newkey rsa:4096 -keyout #{private_key_file_name} -out pg_dump_certificate.pem -days 36500 -nodes -subj '/CN=PostgreSQL Backup Certificate'\""
+            session.run "sudo mv #{pg_home.join(private_key_file_name)} /tmp/"
+            session.run "sudo chmod 666 #{Pathname.new("/tmp").join(private_key_file_name)}"
+
+            session.download Pathname.new("/tmp").join(private_key_file_name).to_s, Pathname.new(".").join("tmp", private_key_file_name).to_s
+
+            session.run "sudo rm #{Pathname.new("/tmp").join(private_key_file_name)}"
+            session.run "sudo -u postgres bash -c 'mkdir -p #{pg_home.join("bin")}'"
+
+            backup_script = find_files("mimas_pg_backup.sh").first
+            session.upload backup_script, Pathname.new("/tmp").join("mimas_pg_backup").to_s
+
+            session.run "sudo mv #{Pathname.new("/tmp").join("mimas_pg_backup")} #{pg_home.join("bin/")}"
+            session.run "sudo chown postgres:postgres #{pg_home.join("bin", "mimas_pg_backup")}"
+            session.run "sudo chmod 700 #{pg_home.join("bin", "mimas_pg_backup")}"
+
+            say "The private key to decrypt backups has been downloaded to your project's `tmp/` folder. Please store this safely, ideally in a password manager!".bold
+            say "To schedule backups, run `/var/lib/postgresql/bin mimas_pg_backup -d DB_NAME -o OUTPUT_DIR"
+          end
+        end
       end
     end
   end

data/lib/mimas/plugins/templates/mimas_pg_backup.sh

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+usage() {
+cat << EOF
+  Usage: mimas_pg_backup -d DB_NAME -o OUTPUT_DIR
+
+  Options:
+    -d, --db-name DB_NAME   The name of the database to backup
+    -o, --output DIR        The output directory
+    -h, --help              Print this help
+EOF
+}
+
+db_name=""
+output_dir=""
+
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        -d|--db-name)
+            [[ $# -ge 2 ]] || { echo "Error: --db-name requires an argument" >&2; exit 1; }
+            db_name="$2"
+            shift 2
+            ;;
+        -o|--output)
+            [[ $# -ge 2 ]] || { echo "Error: --output requires an argument" >&2; exit 1; }
+            output_dir="${2/%}"
+            shift 2
+            ;;
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        *)
+            echo "Error: unknown option: $1" >&2
+            usage >&2
+            exit 1
+            ;;
+    esac
+done
+
+if [[ -z "$db_name" || -z "$output_dir" ]]; then
+    echo "Error: --db-name and --output are required" >&2
+    usage >&2
+    exit 1
+fi
+
+# Mimas will only retain the last 5 backups.
+delete_expired_backups() {
+    local -a backups
+    local -a expired_backups
+
+    mapfile -t backups < <(
+        find $output_dir/*_backup_*.dump.enc -maxdepth 1 -type f -printf '%f\n' |
+        sort -r
+    )
+
+    if (( ${#backups[@]} > 5 )); then
+        expired_backups=("${backups[@]:5}")
+
+        for backup in "${expired_backups[@]}"; do
+            rm -- "$output_dir/$backup"
+        done
+    fi
+}
+
+delete_expired_backups
+
+backup_name="${db_name}_backup_$(date -u '+%Y%m%d%H%M%S')"
+certificate_path="/var/lib/postgresql/pg_dump_certificate.pem"
+output_file="$output_dir/${backup_name}.dump.enc"
+
+pg_dump \
+    --format=custom \
+    --username=postgres \
+    --dbname="$db_name" |
+    openssl smime \
+        -encrypt \
+        -aes256 \
+        -binary \
+        -outform DER \
+        -out "$output_file" \
+        "$certificate_path"

data/lib/mimas-postgresql.rb

@@ -11,5 +11,6 @@ require_relative "mimas/plugins/postgresql/commands/configure"
 require_relative "mimas/plugins/postgresql/commands/setup"
 require_relative "mimas/plugins/postgresql/commands/create_db"
 require_relative "mimas/plugins/postgresql/commands/create_role"
+require_relative "mimas/plugins/postgresql/commands/prepare_backups"
 
 Mimas::Plugins.register(Mimas::Plugins::PostgreSQL)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mimas-postgresql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ayush Newatia
@@ -15,19 +15,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
 email: ayush@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - lib/mimas-postgresql.rb
 - lib/mimas/plugins/postgresql.rb
 - lib/mimas/plugins/postgresql/commands/configure.rb
@@ -35,10 +36,12 @@ files:
 - lib/mimas/plugins/postgresql/commands/create_db.rb
 - lib/mimas/plugins/postgresql/commands/create_role.rb
 - lib/mimas/plugins/postgresql/commands/install.rb
+- lib/mimas/plugins/postgresql/commands/prepare_backups.rb
 - lib/mimas/plugins/postgresql/commands/setup.rb
 - lib/mimas/plugins/postgresql/version.rb
 - lib/mimas/plugins/server/console.rb
 - lib/mimas/plugins/server/postgresql.rb
+- lib/mimas/plugins/templates/mimas_pg_backup.sh
 - lib/mimas/plugins/templates/postgresql/conf.d/01-mimas.conf
 - lib/mimas/plugins/templates/postgresql/pg_hba.conf
 - lib/mimas/plugins/templates/postgresql/pg_hba.d/99-mimas.conf
@@ -61,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Install and manage PostgreSQL using Mimas
 test_files: []