X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/e4a0595002f1f428a98776070ad4677b6433b46f..f3a8f9b9c6f82205ec5509f311b0a1edeac3d40c:/cookbooks/mediawiki/resources/site.rb diff --git a/cookbooks/mediawiki/resources/site.rb b/cookbooks/mediawiki/resources/site.rb index 323e33259..0508bcbad 100644 --- a/cookbooks/mediawiki/resources/site.rb +++ b/cookbooks/mediawiki/resources/site.rb @@ -17,15 +17,17 @@ # limitations under the License. # +unified_mode true + default_action :create property :site, :kind_of => String, :name_property => true property :aliases, :kind_of => [String, Array] property :directory, :kind_of => String -property :version, :kind_of => String, :default => "1.33" +property :version, :kind_of => String, :default => "1.37" property :database_name, :kind_of => String, :required => true -property :database_user, :kind_of => String, :required => true -property :database_password, :kind_of => String, :required => true +property :database_user, :kind_of => String, :required => [:create, :update] +property :database_password, :kind_of => String, :required => [:create, :update] property :sitename, :kind_of => String, :default => "OpenStreetMap Wiki" property :metanamespace, :kind_of => String, :default => "OpenStreetMap" property :logo, :kind_of => String, :default => "$wgStylePath/common/images/wiki.png" @@ -37,21 +39,27 @@ property :skin, :kind_of => String, :default => "vector" property :site_notice, :kind_of => [String, TrueClass, FalseClass], :default => false property :site_readonly, :kind_of => [String, TrueClass, FalseClass], :default => false property :admin_user, :kind_of => String, :default => "Admin" -property :admin_password, :kind_of => String, :required => true +property :admin_password, :kind_of => String, :required => [:create] property :private_accounts, :kind_of => [TrueClass, FalseClass], :default => false property :private_site, :kind_of => [TrueClass, FalseClass], :default => false -property :recaptcha_public_key, :kind_of => String -property :recaptcha_private_key, :kind_of => String +property :hcaptcha_public_key, :kind_of => String, :default => "" +property :hcaptcha_private_key, :kind_of => String, :default => "" property :extra_file_extensions, :kind_of => [String, Array], :default => [] +property :fpm_max_children, :kind_of => Integer, :default => 5 +property :fpm_start_servers, :kind_of => Integer, :default => 2 +property :fpm_min_spare_servers, :kind_of => Integer, :default => 1 +property :fpm_max_spare_servers, :kind_of => Integer, :default => 3 +property :fpm_request_terminate_timeout, :kind_of => Integer, :default => 300 +property :fpm_prometheus_port, :kind_of => Integer property :reload_apache, :kind_of => [TrueClass, FalseClass], :default => true action :create do - node.normal_unless[:mediawiki][:sites][new_resource.site] = {} - - node.normal[:mediawiki][:sites][new_resource.site][:directory] = site_directory - node.normal[:mediawiki][:sites][new_resource.site][:version] = new_resource.version + node.default[:mediawiki][:sites][new_resource.site] = { + :directory => site_directory, + :version => new_resource.version + } - node.normal_unless[:mediawiki][:sites][new_resource.site][:wgSecretKey] = SecureRandom.base64(48) + secret_key = persistent_token("mediawiki", new_resource.site, "wgSecretKey") mysql_user "#{new_resource.database_user}@localhost" do password new_resource.database_password @@ -70,44 +78,21 @@ action :create do end end - execute "#{mediawiki_directory}/maintenance/install.php" do - action :nothing - # Use metanamespace as Site Name to ensure correct set namespace - command "php maintenance/install.php --server '#{name}' --dbtype 'mysql' --dbname '#{new_resource.database_name}' --dbuser '#{new_resource.database_user}' --dbpass '#{new_resource.database_password}' --dbserver 'localhost' --scriptpath /w --pass '#{new_resource.admin_password}' '#{new_resource.metanamespace}' '#{new_resource.admin_user}'" - cwd mediawiki_directory - user node[:mediawiki][:user] - group node[:mediawiki][:group] - not_if do - ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php") - end - notifies :run, "ruby_block[rename-installer-localsettings]", :immediately - end - - execute "#{mediawiki_directory}/maintenance/update.php" do - action :nothing - command "php maintenance/update.php --quick" - cwd mediawiki_directory - user node[:mediawiki][:user] - group node[:mediawiki][:group] - end - declare_resource :directory, site_directory do owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, mediawiki_directory do owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end - mediawiki_reference = "REL#{new_resource.version}".tr(".", "_") - git mediawiki_directory do action :sync - repository "https://gerrit.wikimedia.org/r/p/mediawiki/core.git" + repository "https://gerrit.wikimedia.org/r/mediawiki/core.git" revision mediawiki_reference depth 1 user node[:mediawiki][:user] @@ -117,20 +102,42 @@ action :create do notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]" end + template "#{mediawiki_directory}/composer.local.json" do + cookbook "mediawiki" + source "composer.local.json.erb" + owner node[:mediawiki][:user] + group node[:mediawiki][:group] + mode "664" + end + execute "#{mediawiki_directory}/composer.json" do action :nothing command "composer update --no-dev" cwd mediawiki_directory user node[:mediawiki][:user] group node[:mediawiki][:group] + environment "COMPOSER_HOME" => site_directory end - template "#{mediawiki_directory}/composer.local.json" do - cookbook "mediawiki" - source "composer.local.json.erb" - owner node[:mediawiki][:user] + execute "#{mediawiki_directory}/maintenance/install.php" do + action :nothing + # Use metanamespace as Site Name to ensure correct set namespace + command "php maintenance/install.php --server '#{name}' --dbtype 'mysql' --dbname '#{new_resource.database_name}' --dbuser '#{new_resource.database_user}' --dbpass '#{new_resource.database_password}' --dbserver 'localhost' --scriptpath /w --pass '#{new_resource.admin_password}' '#{new_resource.metanamespace}' '#{new_resource.admin_user}'" + cwd mediawiki_directory + user node[:mediawiki][:user] + group node[:mediawiki][:group] + not_if do + ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php") + end + notifies :run, "ruby_block[rename-installer-localsettings]", :immediately + end + + execute "#{mediawiki_directory}/maintenance/update.php" do + action :nothing + command "php maintenance/update.php --quick" + cwd mediawiki_directory + user node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o664 end # Safety catch if git doesn't update but install.php hasn't run @@ -147,19 +154,19 @@ action :create do declare_resource :directory, "#{mediawiki_directory}/images" do owner "www-data" group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, "#{mediawiki_directory}/cache" do owner "www-data" group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do user node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end template "#{mediawiki_directory}/LocalSettings.php" do @@ -167,22 +174,59 @@ action :create do source "LocalSettings.php.erb" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o664 + mode "664" variables :name => new_resource.site, :directory => mediawiki_directory, :database_params => database_params, - :mediawiki => mediawiki_params + :mediawiki => mediawiki_params, + :secret_key => secret_key notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]" end - template "/etc/cron.d/mediawiki-#{cron_name}" do - cookbook "mediawiki" - source "mediawiki.cron.erb" - owner "root" - group "root" - mode 0o644 - variables :name => new_resource.site, :directory => site_directory, - :user => node[:mediawiki][:user] + cron_d "mediawiki-#{cron_name}-sitemap" do + comment "Generate sitemap.xml daily" + minute "30" + hour "0" + user node[:mediawiki][:user] + command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/generateSitemap.php --server=https://#{new_resource.site} --urlpath=https://#{new_resource.site}/ --fspath=#{site_directory} --quiet --skip-redirects" + end + + cron_d "mediawiki-#{cron_name}-jobs" do + comment "Run mediawiki jobs" + minute "*/3" + user node[:mediawiki][:user] + command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/runJobs.php --server=https://#{new_resource.site} --maxtime=160 --memory-limit=2048M --procs=8 --quiet" + end + + cron_d "mediawiki-#{cron_name}-email-jobs" do + comment "Run mediawiki email jobs" + user node[:mediawiki][:user] + command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/runJobs.php --server=https://#{new_resource.site} --maxtime=30 --type=enotifNotify --memory-limit=2048M --procs=4 --quiet" + end + + cron_d "mediawiki-#{cron_name}-refresh-links" do + comment "Run mediawiki refresh links table weekly" + minute "5" + hour "0" + weekday "0" + user node[:mediawiki][:user] + command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/refreshLinks.php --server=https://#{new_resource.site} --memory-limit=2048M --quiet" + end + + cron_d "mediawiki-#{cron_name}-cleanup-gs" do + comment "Clean up imagemagick garbage" + minute "10" + hour "2" + user node[:mediawiki][:user] + command "/usr/bin/find /tmp/ -maxdepth 1 -type f -user www-data -mmin +90 -name 'gs_*' -delete" + end + + cron_d "mediawiki-#{cron_name}-cleanup-magick" do + comment "Clean up imagemagick garbage" + minute "20" + hour "2" + user node[:mediawiki][:user] + command "/usr/bin/find /tmp/ -maxdepth 1 -type f -user www-data -mmin +90 -name 'magick-*' -delete" end template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do @@ -190,7 +234,7 @@ action :create do source "mediawiki-backup.cron.erb" owner "root" group "root" - mode 0o700 + mode "700" variables :name => new_resource.site, :directory => site_directory, :database_params => database_params @@ -253,8 +297,8 @@ action :create do mediawiki_extension "ConfirmEdit" do site new_resource.site template "mw-ext-ConfirmEdit.inc.php.erb" - variables :public_key => new_resource.recaptcha_public_key, - :private_key => new_resource.recaptcha_private_key + variables :public_key => new_resource.hcaptcha_public_key, + :private_key => new_resource.hcaptcha_private_key update_site false end end @@ -342,6 +386,11 @@ action :create do update_site false end + mediawiki_extension "CategoryTree" do + site new_resource.site + update_site false + end + mediawiki_extension "cldr" do site new_resource.site template "mw-ext-cldr.inc.php.erb" @@ -360,16 +409,6 @@ action :create do update_site false end - # LocalisationUpdate Update Cron - # template "/etc/cron.d/mediawiki-#{name}-LocalisationUpdate" do - # cookbook "mediawiki" - # source "mediawiki-LocalisationUpdate.cron.erb" - # owner "root" - # group "root" - # mode 0755 - # variables :name => name, :directory => site_directory, :user => node[:mediawiki][:user] - # end - # mediawiki_extension "Translate" do # site new_resource.site # template "mw-ext-Translate.inc.php.erb" @@ -418,26 +457,31 @@ action :create do mediawiki_extension "osmtaginfo" do site new_resource.site - template "mw-ext-osmtaginfo.inc.php.erb" repository "https://github.com/Firefishy/osmtaginfo.git" tag "live" update_site false end + mediawiki_extension "OSMCALWikiWidget" do + site new_resource.site + repository "https://github.com/thomersch/OSMCALWikiWidget.git" + tag "live" + update_site false + end + mediawiki_extension "SimpleMap" do site new_resource.site template "mw-ext-SimpleMap.inc.php.erb" repository "https://github.com/Firefishy/SimpleMap.git" tag "live" update_site false + action :delete end mediawiki_extension "SlippyMap" do site new_resource.site - template "mw-ext-SlippyMap.inc.php.erb" - repository "https://github.com/Firefishy/SlippyMap.git" - tag "live" update_site false + action :delete end mediawiki_extension "Mantle" do @@ -455,6 +499,7 @@ action :create do mediawiki_extension "VisualEditor" do site new_resource.site template "mw-ext-VisualEditor.inc.php.erb" + variables :version => new_resource.version update_site false end @@ -463,11 +508,18 @@ action :create do update_site false end + # Broken Extension - 3 April 2022 - Remove. See https://github.com/openstreetmap/chef/pull/491#issuecomment-1086759504 + mediawiki_extension "QuickInstantCommons" do + site new_resource.site + update_site false + action :delete + end + cookbook_file "#{site_directory}/cc-wiki.png" do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -475,7 +527,7 @@ action :create do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -483,7 +535,7 @@ action :create do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -491,6 +543,20 @@ action :create do domains [new_resource.site] + Array(new_resource.aliases) end + php_fpm new_resource.site do + pm_max_children new_resource.fpm_max_children + pm_start_servers new_resource.fpm_start_servers + pm_min_spare_servers new_resource.fpm_min_spare_servers + pm_max_spare_servers new_resource.fpm_max_spare_servers + request_terminate_timeout new_resource.fpm_request_terminate_timeout + php_admin_values "open_basedir" => "#{site_directory}/:/usr/share/php/:/dev/null:/tmp/" + php_values "memory_limit" => "500M", + "max_execution_time" => "240", + "upload_max_filesize" => "70M", + "post_max_size" => "100M" + prometheus_port new_resource.fpm_prometheus_port + end + apache_site new_resource.site do cookbook "mediawiki" template "apache.erb" @@ -518,7 +584,7 @@ action :update do source "LocalSettings.php.erb" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o664 + mode "664" variables :name => new_resource.site, :directory => mediawiki_directory, :database_params => database_params, @@ -556,10 +622,23 @@ action :delete do end action_class do + include Chef::Mixin::PersistentToken + def site_directory new_resource.directory || "/srv/#{new_resource.site}" end + def mediawiki_reference + shell_out!("git", "ls-remote", "--refs", "--sort=-version:refname", + "https://gerrit.wikimedia.org/r/mediawiki/core.git", + "refs/tags/#{new_resource.version}.*") + .stdout + .split("\n") + .first + .split("/") + .last + end + def cron_name new_resource.site.tr(".", "_") end