jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/377515 )
Change subject: Document restbase & mobilecontentservice roles ...................................................................... Document restbase & mobilecontentservice roles Change-Id: I5f6835ba71a6f78818a73e062f109c41d335e686 --- M puppet/hieradata/common.yaml M puppet/modules/mobilecontentservice/manifests/init.pp M puppet/modules/role/manifests/mobilecontentservice.pp M puppet/modules/role/manifests/restbase.pp A puppet/modules/role/templates/mobilecontentservice/VagrantRoleMobileContentService.wiki.erb A puppet/modules/role/templates/restbase/VagrantRoleRestbase.wiki.erb 6 files changed, 39 insertions(+), 3 deletions(-) Approvals: Mobrovac: Looks good to me, approved jenkins-bot: Verified diff --git a/puppet/hieradata/common.yaml b/puppet/hieradata/common.yaml index 9683949..fdf9553 100644 --- a/puppet/hieradata/common.yaml +++ b/puppet/hieradata/common.yaml @@ -384,6 +384,8 @@ role::mediawiki::hostname: "dev%{hiera('mediawiki::multiwiki::base_domain')}" +role::mobilecontentservice::vhost_name: "mcs%{hiera('mwv::tld')}" + role::quips::vhost_name: "quips%{hiera('mwv::tld')}%{::port_fragment}" role::quips::dir: "%{hiera('mwv::services_dir')}/quips" role::quips::env: @@ -395,6 +397,7 @@ role::restbase::base_url: "//%{hiera('role::mediawiki::hostname')}%{::port_fragment}/api/rest_" role::restbase::domain: "%{hiera('restbase::domain')}" +role::restbase::public_url: "%{hiera('mediawiki::server_url')}/api/rest_v1/" role::restbase::ve_url: "/api/rest_v1/page/html/" role::sal::vhost_name: "sal%{hiera('mwv::tld')}%{::port_fragment}" diff --git a/puppet/modules/mobilecontentservice/manifests/init.pp b/puppet/modules/mobilecontentservice/manifests/init.pp index dbff5c2..32d6744 100644 --- a/puppet/modules/mobilecontentservice/manifests/init.pp +++ b/puppet/modules/mobilecontentservice/manifests/init.pp @@ -16,11 +16,15 @@ $log_level = undef, ) { - require ::restbase + include ::restbase service::node { 'mobileapps': port => $port, log_level => $log_level, } + apache::reverse_proxy { 'mcs': + port => $port, + } + } diff --git a/puppet/modules/role/manifests/mobilecontentservice.pp b/puppet/modules/role/manifests/mobilecontentservice.pp index a0923b4..29d1ee7 100644 --- a/puppet/modules/role/manifests/mobilecontentservice.pp +++ b/puppet/modules/role/manifests/mobilecontentservice.pp @@ -1,8 +1,20 @@ # == Class: role::mobilecontentservice # This role installs the mobile content service. # -class role::mobilecontentservice { +# === Parameters +# +# [*vhost_name*] +# A virtual domain name for convenient access to the service. +# See apache::port_alias. Expected to be set up already. +# +class role::mobilecontentservice( + $vhost_name, +) { include ::role::restbase include ::role::mobilefrontend include ::mobilecontentservice + + mediawiki::import::text { 'VagrantRoleMobileContentService': + content => template('role/mobilecontentservice/VagrantRoleMobileContentService.wiki.erb'), + } } diff --git a/puppet/modules/role/manifests/restbase.pp b/puppet/modules/role/manifests/restbase.pp index 5e2bfdc..718c57d 100644 --- a/puppet/modules/role/manifests/restbase.pp +++ b/puppet/modules/role/manifests/restbase.pp @@ -12,12 +12,17 @@ # [*domain*] # RESTBase domain to serve # +# [*public_url*] +# URL that should be used to link to the Swagger documentation page. +# # [*ve_url*] -# Url that VisualEditor should use to load a page via RESTBase +# URL that VisualEditor should use to load a page via RESTBase # (example: '/api/rest_v1/my.wiki.domain/v1/page/html/') +# class role::restbase ( $base_url, $domain, + $public_url, $ve_url, ) { require ::role::mediawiki @@ -49,5 +54,9 @@ priority => $::LOAD_EARLY, wiki => $::mediawiki::wiki_db, } + + mediawiki::import::text { 'VagrantRoleRestbase': + content => template('role/restbase/VagrantRoleRestbase.wiki.erb'), + } } diff --git a/puppet/modules/role/templates/mobilecontentservice/VagrantRoleMobileContentService.wiki.erb b/puppet/modules/role/templates/mobilecontentservice/VagrantRoleMobileContentService.wiki.erb new file mode 100644 index 0000000..77e7750 --- /dev/null +++ b/puppet/modules/role/templates/mobilecontentservice/VagrantRoleMobileContentService.wiki.erb @@ -0,0 +1,4 @@ +The Mobile Content Service provides a variety of APIs for shipping mobile friendly content to app clients. +* API: http://<%= @vhost_name %><%= @port_fragment %>/ +* Documentation: [[mw:Wikimedia Apps/Team/RESTBase services for apps]] + diff --git a/puppet/modules/role/templates/restbase/VagrantRoleRestbase.wiki.erb b/puppet/modules/role/templates/restbase/VagrantRoleRestbase.wiki.erb new file mode 100644 index 0000000..4321027 --- /dev/null +++ b/puppet/modules/role/templates/restbase/VagrantRoleRestbase.wiki.erb @@ -0,0 +1,4 @@ +RESTBase is a caching / storing API proxy backing the Wikimedia REST API. +* API: <%= @public_url %> +* Documentation: [[mw:RESTBase]] + -- To view, visit https://gerrit.wikimedia.org/r/377515 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I5f6835ba71a6f78818a73e062f109c41d335e686 Gerrit-PatchSet: 8 Gerrit-Project: mediawiki/vagrant Gerrit-Branch: master Gerrit-Owner: Gergő Tisza <gti...@wikimedia.org> Gerrit-Reviewer: BearND <bsitzm...@wikimedia.org> Gerrit-Reviewer: BryanDavis <bda...@wikimedia.org> Gerrit-Reviewer: Dduvall <dduv...@wikimedia.org> Gerrit-Reviewer: Gergő Tisza <gti...@wikimedia.org> Gerrit-Reviewer: Mobrovac <mobro...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits