From 7c0d968aa817217b8dd1e0339ca645b98492a8ff Mon Sep 17 00:00:00 2001 From: Nathan Cutler Date: Tue, 30 Jan 2024 17:48:37 +0100 Subject: [PATCH] admin: rework Back-end Installation section Fixes: https://github.com/openSUSE/obs-docu/issues/296 Signed-off-by: Nathan Cutler --- xml/obs_ag_installation_and_configuration.xml | 121 ++++++++++-------- 1 file changed, 70 insertions(+), 51 deletions(-) diff --git a/xml/obs_ag_installation_and_configuration.xml b/xml/obs_ag_installation_and_configuration.xml index 51538300..86010961 100644 --- a/xml/obs_ag_installation_and_configuration.xml +++ b/xml/obs_ag_installation_and_configuration.xml @@ -89,18 +89,24 @@ Back-end Installation The back-end hosts all sources and built packages. It also schedules - the jobs. To install it, install the "obs-server" package. You should - check the /usr/lib/obs/server/BSConfig.pm file, - though the defaults should be good enough for simple cases. - You can control the different back-end components via systemctl. + the jobs. To install it, install the "obs-server" package. After installation, + it's a good idea to check the service configuration in + /usr/lib/obs/server/BSConfig.pm, although + the defaults should be good enough for simple cases. + + + Read more about configuring the backend in . + + + The back-end consists of a number of services that are controlled via systemctl. Basically you can enable/disable the service during booting the system and start/stop/restart it in a running system. For more information, see the systemctl man page. - For example, to restart the repository - server, do: + For example, to restart the repository server, do: + systemctl restart obsrepserver.service - Service Names + Services @@ -110,18 +116,18 @@ - Component - Service Name - Remarks + Service + Description + Remark - Source Server + obssrcserver.service - obssrcserver.service + Source server @@ -129,10 +135,10 @@ - Repository + obsrepserver.service - Server obsrepserver.service + Repository server @@ -140,10 +146,10 @@ - Source + obsservice.service - Services obsservice.service + Source services server @@ -151,10 +157,10 @@ - Download + obsdodup.service - obsdodup.service + Repository metadata download since 2.7 @@ -162,10 +168,10 @@ - Delta Storage + obsdeltastore.service - obsdeltastore.service + Delta storage since 2.7 @@ -173,10 +179,10 @@ - Scheduler + obsscheduler.service - obsscheduler.service + Scheduler @@ -184,10 +190,10 @@ - Dispatcher + obsdispatcher.service - obsdispatcher.service + Dispatcher proxy @@ -195,10 +201,10 @@ - Publisher + obsservicedispatch.service - obspublisher.service + Dispatcher @@ -206,21 +212,32 @@ - Signer + obspublisher.service + + Publisher + + + + + + obssigner.service + + Signer proxy + - Warden + obssignd.service - obswarden.service + Signer @@ -228,21 +245,32 @@ - Cloud upload worker + obswarden.service + + + Warden + + + + + obsclouduploadworker.service + + Cloud upload worker + Only needed for cloud upload feature - Cloud upload server + obsclouduploadserver.service - obsclouduploadserve.service + Cloud upload server Only needed for cloud upload feature @@ -251,27 +279,21 @@
- The sequence in the table reflects the start sequence, you need to - enable the services with + At start time, obssrcserver.service (the source + server) must be started first, and obsrepservice.service + second. The remaining services can be started in any order. When installing + manually, you will need to first enable the services with systemctl enable <name> - first and then you can start them: + so they start automatically at boot (the start order is enforced via + the respective systemd unit files) and then you can start them: systemctl start obssrcserver.service systemctl start obsrepserver.service -systemctl start obsservice.service -systemctl start obsdodup.service -systemctl start obsdeltastore.service -systemctl start obsscheduler.service -systemctl start obsdispatcher.service -systemctl start obspublisher.service -systemctl start obssigner.service -systemctl start obswarden.service -systemctl start obsclouduploadworker.service -systemctl start obsclouduploadserver.service + followed by the remaining services in any order. - The commands start services which are accessible from the outside. Do - not do this on a system connected to an untrusted network or make sure to - block the ports with a firewall. + The start-up commands start services which are accessible from the + outside. If the system is connected to an untrusted network, either block + the ports with a firewall or do not run the commands at all. Cloud Upload Setup @@ -308,9 +330,6 @@ rcobsclouduploadserver start our $clouduploadserver = "http://$hostname:5452"; - - Read more about configuring the backend in . - Ensure that the system time of your cloud uploader instance is correct.