From 9958d43a53f0fe60028fb6be2e724e6a06dc4975 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=BChler=20Ma=C3=ABlys?= Date: Sat, 30 Mar 2024 13:14:53 +0100 Subject: [PATCH] add deploy to github actions --- .github/workflows/deploy.yml | 0 .gitignore | 5 -- Capfile | 38 ++++++++++++ Gemfile | 6 ++ Gemfile.lock | 39 ++++++++++++ config/deploy.rb | 116 +++++++++++++++++++++++++++++++++++ config/deploy/production.rb | 63 +++++++++++++++++++ config/deploy/staging.rb | 61 ++++++++++++++++++ 8 files changed, 323 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/deploy.yml create mode 100644 Capfile create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 config/deploy.rb create mode 100644 config/deploy/production.rb create mode 100644 config/deploy/staging.rb diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..e69de29 diff --git a/.gitignore b/.gitignore index 52e206b..460a466 100644 --- a/.gitignore +++ b/.gitignore @@ -3,10 +3,5 @@ db.sqlite3 __pycache__ *.env # Capistrano -/config/ -Capfile -Gemfile -Gemfile.lock capistrano.log -<<<<<<< HEAD diff --git a/Capfile b/Capfile new file mode 100644 index 0000000..42dd3a4 --- /dev/null +++ b/Capfile @@ -0,0 +1,38 @@ +# Load DSL and set up stages +require "capistrano/setup" + +# Include default deployment tasks +require "capistrano/deploy" + +# Load the SCM plugin appropriate to your project: +# +# require "capistrano/scm/hg" +# install_plugin Capistrano::SCM::Hg +# or +# require "capistrano/scm/svn" +# install_plugin Capistrano::SCM::Svn +# or +require "capistrano/scm/git" +install_plugin Capistrano::SCM::Git + +# Include tasks from other gems included in your Gemfile +# +# For documentation on these, see for example: +# +# https://github.com/capistrano/rvm +# https://github.com/capistrano/rbenv +# https://github.com/capistrano/chruby +# https://github.com/capistrano/bundler +# https://github.com/capistrano/rails +# https://github.com/capistrano/passenger +# +# require "capistrano/rvm" +# require "capistrano/rbenv" +# require "capistrano/chruby" +# require "capistrano/bundler" +# require "capistrano/rails/assets" +# require "capistrano/rails/migrations" +# require "capistrano/passenger" + +# Load custom tasks from `lib/capistrano/tasks` if you have any defined +Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r } diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..8b4642a --- /dev/null +++ b/Gemfile @@ -0,0 +1,6 @@ +source 'https://rubygems.org' + +gem 'capistrano' +gem 'net-ssh', '>= 6.0.2' +gem 'ed25519', '>= 1.2', '< 2.0' +gem 'bcrypt_pbkdf', '>= 1.0', '< 2.0' diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..0b17fcb --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,39 @@ +GEM + remote: https://rubygems.org/ + specs: + airbrussh (1.5.1) + sshkit (>= 1.6.1, != 1.7.0) + bcrypt_pbkdf (1.1.0) + capistrano (3.18.1) + airbrussh (>= 1.0.0) + i18n + rake (>= 10.0.0) + sshkit (>= 1.9.0) + concurrent-ruby (1.2.3) + ed25519 (1.3.0) + i18n (1.14.4) + concurrent-ruby (~> 1.0) + mutex_m (0.2.0) + net-scp (4.0.0) + net-ssh (>= 2.6.5, < 8.0.0) + net-sftp (4.0.0) + net-ssh (>= 5.0.0, < 8.0.0) + net-ssh (7.2.1) + rake (13.1.0) + sshkit (1.22.0) + mutex_m + net-scp (>= 1.1.2) + net-sftp (>= 2.1.2) + net-ssh (>= 2.8.0) + +PLATFORMS + ruby + +DEPENDENCIES + bcrypt_pbkdf (>= 1.0, < 2.0) + capistrano + ed25519 (>= 1.2, < 2.0) + net-ssh (>= 6.0.2) + +BUNDLED WITH + 2.1.4 diff --git a/config/deploy.rb b/config/deploy.rb new file mode 100644 index 0000000..8206beb --- /dev/null +++ b/config/deploy.rb @@ -0,0 +1,116 @@ +# config valid for current version and patch releases of Capistrano +lock "~> 3.18.1" + +set :application, "masteriq" +set :repo_url, "https://github.com/HE-Arc/MasterIQ.git" +# append :linked_files, '.env' +# Default branch is :master +# ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp + +# Default deploy_to directory is /var/www/my_app_name +# set :deploy_to, "/var/www/my_app_name" + +# Default value for :format is :airbrussh. +# set :format, :airbrussh + +# You can configure the Airbrussh format using :format_options. +# These are the defaults. +# set :format_options, command_output: true, log_file: "log/capistrano.log", color: :auto, truncate: :auto + +# Default value for :pty is false +# set :pty, true + +# Default value for :linked_files is [] +# append :linked_files, "config/database.yml", 'config/master.key' + +# Default value for linked_dirs is [] +# append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system", "vendor", "storage" + +# Default value for default_env is {} +# set :default_env, { path: "/opt/ruby/bin:$PATH" } + +# Default value for local_user is ENV['USER'] +# set :local_user, -> { `git config user.name`.chomp } + +# Default value for keep_releases is 5 +# set :keep_releases, 5 + +# Uncomment the following to require manually verifying the host key before first deploy. +# set :ssh_options, verify_host_key: :secure + +after 'deploy:updating', 'env:copy' +namespace :env do + desc "Copy env files" + task :copy do + on roles([:app, :web]) do |h| + execute "ln -nfs #{shared_path}/.env.api #{release_path}/api/.env" + execute "ln -nfs #{shared_path}/.env.front #{release_path}/frontend/.env" + end + end +end + +after 'deploy:updating', 'pip:install' + +namespace :pip do + desc 'Pip install' + task :install do + on roles([:app, :web]) do |h| + execute "pip install -r #{release_path}/api/requirements.txt" + end + end +end + +after 'deploy:updating', 'npm:install' +namespace :npm do + desc 'NPM install' + task :install do + on roles([:app, :web]) do |h| + execute "npm install --prefix #{release_path}/frontend" + end + end +end + +after 'deploy:updating', 'npm:build' +namespace :npm do + desc 'NPM install' + task :build do + on roles([:app, :web]) do |h| + execute "npm run build --prefix #{release_path}/frontend" + end + end +end + +after 'deploy:updating', 'django:migrate' +namespace :django do + desc 'Django migrations' + task :migrate do + on roles([:app, :web]) do |h| + within "#{release_path}/api" do + execute :python3, 'manage.py', 'migrate' + end + end + end +end + +after 'deploy:publishing', 'gunicorn:restart' + +namespace :gunicorn do + desc 'Restart application' + task :restart do + on roles(:web) do |h| + execute :sudo, 'systemctl restart gunicorn' + end + end +end + +after 'deploy:publishing', 'nginx:restart' + +namespace :nginx do + desc 'Restart application' + task :restart do + on roles(:web) do |h| + execute :sudo, 'service nginx restart' + end + end +end + diff --git a/config/deploy/production.rb b/config/deploy/production.rb new file mode 100644 index 0000000..2d9a064 --- /dev/null +++ b/config/deploy/production.rb @@ -0,0 +1,63 @@ +# server-based syntax +# ====================== +# Defines a single server with a list of roles and multiple properties. +# You can define all roles on a single server, or split them: + +# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value +# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value +# server "db.example.com", user: "deploy", roles: %w{db} +server ENV['DEPLOY_HOST'], user: ENV['DEPLOY_USERNAME'], roles: %w{app db web}, port: ENV['DEPLOY_HOST_SSH_PORT'] +set :deploy_to, "/home/django/project/" +set :branch, "main" + + +# role-based syntax +# ================== + +# Defines a role with one or multiple servers. The primary server in each +# group is considered to be the first unless any hosts have the primary +# property set. Specify the username and a domain or IP for the server. +# Don't use `:all`, it's a meta role. + +# role :app, %w{deploy@example.com}, my_property: :my_value +# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value +# role :db, %w{deploy@example.com} + + + +# Configuration +# ============= +# You can set any configuration variable like in config/deploy.rb +# These variables are then only loaded and set in this stage. +# For available Capistrano configuration variables see the documentation page. +# http://capistranorb.com/documentation/getting-started/configuration/ +# Feel free to add new variables to customise your setup. + + + +# Custom SSH Options +# ================== +# You may pass any option but keep in mind that net/ssh understands a +# limited set of options, consult the Net::SSH documentation. +# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start +# +# Global options +# -------------- +# set :ssh_options, { +# keys: %w(/home/user_name/.ssh/id_rsa), +# forward_agent: false, +# auth_methods: %w(password) +# } +# +# The server-based syntax can be used to override options: +# ------------------------------------ +# server "example.com", +# user: "user_name", +# roles: %w{web app}, +# ssh_options: { +# user: "user_name", # overrides user setting above +# keys: %w(/home/user_name/.ssh/id_rsa), +# forward_agent: false, +# auth_methods: %w(publickey password) +# # password: "please use keys" +# } diff --git a/config/deploy/staging.rb b/config/deploy/staging.rb new file mode 100644 index 0000000..0a3f086 --- /dev/null +++ b/config/deploy/staging.rb @@ -0,0 +1,61 @@ +# server-based syntax +# ====================== +# Defines a single server with a list of roles and multiple properties. +# You can define all roles on a single server, or split them: + +# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value +# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value +# server "db.example.com", user: "deploy", roles: %w{db} + + + +# role-based syntax +# ================== + +# Defines a role with one or multiple servers. The primary server in each +# group is considered to be the first unless any hosts have the primary +# property set. Specify the username and a domain or IP for the server. +# Don't use `:all`, it's a meta role. + +# role :app, %w{deploy@example.com}, my_property: :my_value +# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value +# role :db, %w{deploy@example.com} + + + +# Configuration +# ============= +# You can set any configuration variable like in config/deploy.rb +# These variables are then only loaded and set in this stage. +# For available Capistrano configuration variables see the documentation page. +# http://capistranorb.com/documentation/getting-started/configuration/ +# Feel free to add new variables to customise your setup. + + + +# Custom SSH Options +# ================== +# You may pass any option but keep in mind that net/ssh understands a +# limited set of options, consult the Net::SSH documentation. +# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start +# +# Global options +# -------------- +# set :ssh_options, { +# keys: %w(/home/user_name/.ssh/id_rsa), +# forward_agent: false, +# auth_methods: %w(password) +# } +# +# The server-based syntax can be used to override options: +# ------------------------------------ +# server "example.com", +# user: "user_name", +# roles: %w{web app}, +# ssh_options: { +# user: "user_name", # overrides user setting above +# keys: %w(/home/user_name/.ssh/id_rsa), +# forward_agent: false, +# auth_methods: %w(publickey password) +# # password: "please use keys" +# }