mimas-postgresql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '082013adafb7795ab1e364ae00e5c092f4b75c1485745fe1e2cd74e0c5ab2768'
+  data.tar.gz: '0922ae80ccfb5863bf8bbfcf8f2f61a5b67ae46591490c9feb17d89299f1b7e2'
+SHA512:
+  metadata.gz: 81f3a5e2ef7ae98132a7d2cb9c915d5b1de0ee59951bf8b07c0dba2f1516084b642d524fcacdd61e9b7be8f43a8a11dae00400950d6c9eee70d01a788d9d3a3e
+  data.tar.gz: 7edc8d7066a4ac96ebe2b5dca9838aca15944b3e9d30c1a7941dcf0a60f6bc003277e16f9f1d369fd8b9dba12d98f3f7fcafb14b6874bffd1dc77783c00ccdde

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

@@ -0,0 +1,25 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        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"
+
+          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.configure_postgresql(sudo_user: sudo_user)
+
+            say ""
+            say "PostgreSQL has been configured! 🎉"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        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"
+
+          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.start_postgresql_console(sudo_user: sudo_user)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        class CreateDB < Mimas::CLI::Commands::BaseCommand
+          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"
+
+          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"
+
+          def call(server_name:, db_name:, **options)
+            server = Config.current.servers[server_name.to_sym]
+            sudo_user = options[:user]
+
+            ssh(server, user: sudo_user) do |session|
+              unless options[:owner]
+                password = SecureRandom.alphanumeric(64)
+                session.run "sudo -u postgres psql -c \"CREATE ROLE #{db_name} WITH LOGIN PASSWORD \'#{password}\';\"", capture: true
+
+                say ""
+                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
+
+              session.run "sudo -u postgres psql -c \"CREATE DATABASE #{db_name} OWNER #{db_name};\"", capture: true
+
+              say ""
+              say "Created database named #{db_name.dup.bold.magenta}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        class CreateRole < Mimas::CLI::Commands::BaseCommand
+          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"
+
+          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"
+
+          def call(server_name:, role_name:, **options)
+            server = Config.current.servers[server_name.to_sym]
+            sudo_user = options[:user]
+
+            password = options[:password] || SecureRandom.alphanumeric(64)
+            ssh(server, user: sudo_user) do |session|
+              session.run "sudo -u postgres psql -c \"CREATE ROLE #{role_name} WITH LOGIN PASSWORD \'#{password}\';\"", capture: true
+            end
+
+            say ""
+            say "Created a new role #{role_name.dup.bold.magenta} with password: #{password.bold.white}"
+            say "Ensure you save this password as it cannot be displayed again."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        class Install < Mimas::CLI::Commands::BaseCommand
+          desc "Install PostgreSQL on the server."
+
+          argument :server_name,  required: true,   desc: "The name of the server to install 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_postgresql(sudo_user: sudo_user)
+
+            say ""
+            say "PostgreSQL has been installed! 🎉"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      module Commands
+        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"
+
+          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_postgresql(sudo_user: sudo_user)
+            server.configure_postgresql(sudo_user: sudo_user)
+
+            say ""
+            say "PostgreSQL has been installed and configured! 🎉"
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/mimas/plugins/postgresql.rb

@@ -0,0 +1,23 @@
+module Mimas
+  module Plugins
+    module PostgreSQL
+      extend self
+
+      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
+        end
+      end
+
+      TEMPLATES_DIR = Pathname.new(__dir__).join("templates")
+      def templates_dir
+        TEMPLATES_DIR
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Mimas
+  module Plugins
+    module Server
+      module PostgreSQLConsole
+        def start_postgresql_console(sudo_user:)
+          command = "sudo -u postgres psql"
+          interactive_ssh(host, user: sudo_user, command: command)
+        end
+      end
+    end
+  end
+end
+
+::Mimas::Server.include Mimas::Plugins::Server::PostgreSQLConsole

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

@@ -0,0 +1,40 @@
+module Mimas
+  module Plugins
+    module Server
+      module PostgreSQL
+        def install_postgresql(sudo_user:)
+          ssh(self, user: sudo_user) do |session|
+            session.run "sudo apt-get install postgresql postgresql-contrib -y"
+          end
+        end
+
+        def configure_postgresql(sudo_user:)
+          ssh(self, user: sudo_user) do |session|
+            config_file_path = session.run "sudo -u postgres psql -AtXc 'SHOW config_file'", capture: true
+            config_dir = Pathname.new(config_file_path.strip).parent
+
+            config_files = find_files("postgresql/**/*.conf")
+            config_files = config_files.map do |path|
+              [ path, path.split("/postgresql/")[1] ]
+            end.to_h
+
+            tmp_dir = Pathname.new("/").join("tmp", "postgresql")
+
+            config_files.each do |file, destination|
+              destination_parent_folder = Pathname.new(destination).parent
+
+              session.run "mkdir -p #{tmp_dir.join(destination_parent_folder)}"
+              session.upload file, tmp_dir.join(destination)
+            end
+
+            session.run "sudo rsync --archive --recursive --chown=postgres:postgres #{tmp_dir.join("*")} #{config_dir}"
+            session.run "rm -rf #{tmp_dir}"
+            session.run "sudo systemctl restart postgresql"
+          end
+        end
+      end
+    end
+  end
+end
+
+::Mimas::Server.include Mimas::Plugins::Server::PostgreSQL

data/lib/mimas/plugins/templates/postgresql/conf.d/01-mimas.conf

@@ -0,0 +1,6 @@
+shared_buffers = 250MB # 25% of RAM
+wal_buffers = 16MB
+checkpoint_timeout = 15min
+max_wal_size = 2GB
+min_wal_size = 512MB
+checkpoint_completion_target = 0.9

data/lib/mimas/plugins/templates/postgresql/pg_hba.conf

@@ -0,0 +1,17 @@
+# PostgreSQL Client Authentication Configuration File
+# ===================================================
+#
+# Refer to the "Client Authentication" section in the PostgreSQL
+# documentation for a complete description of this file.
+
+
+# DO NOT DISABLE!
+# If you change this first entry you will need to make sure that the
+# database superuser can access the database using some other method.
+# Noninteractive access to all databases is required during automatic
+# maintenance (custom daily cronjobs, replication, and similar tasks).
+#
+# Database administrative login by Unix domain socket
+local   all             postgres                                peer
+
+include_dir pg_hba.d

data/lib/mimas/plugins/templates/postgresql/pg_hba.d/99-mimas.conf

@@ -0,0 +1,5 @@
+# TYPE  DATABASE        USER            ADDRESS                 METHOD
+local   all             all                                     scram-sha-256
+host    all             all             127.0.0.1/32            scram-sha-256
+host    all             all             ::1/128                 scram-sha-256
+host    all             all             0.0.0.0/0               reject

data/lib/mimas-postgresql.rb

@@ -0,0 +1,15 @@
+require "mimas"
+require "securerandom"
+
+require_relative "mimas/plugins/postgresql"
+require_relative "mimas/plugins/server/postgresql"
+require_relative "mimas/plugins/server/console"
+
+require_relative "mimas/plugins/postgresql/commands/install"
+require_relative "mimas/plugins/postgresql/commands/console"
+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"
+
+Mimas::Plugins.register(Mimas::Plugins::PostgreSQL)

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: mimas-postgresql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ayush Newatia
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+email: ayush@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mimas-postgresql.rb
+- lib/mimas/plugins/postgresql.rb
+- lib/mimas/plugins/postgresql/commands/configure.rb
+- lib/mimas/plugins/postgresql/commands/console.rb
+- 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/setup.rb
+- lib/mimas/plugins/postgresql/version.rb
+- lib/mimas/plugins/server/console.rb
+- lib/mimas/plugins/server/postgresql.rb
+- 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
+homepage: https://codeberg.org/ayushn21/mimas-postgresql
+licenses:
+- MIT
+metadata:
+  mimas_plugin: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: Install and manage PostgreSQL using Mimas
+test_files: []