[Notes] [Git][BuildStream/buildstream][jennis/another_docs_patch] docs: Add more information to "managing the cache with systemmd" section



Title: GitLab

James Ennis pushed to branch jennis/another_docs_patch at BuildStream / buildstream

Commits:

1 changed file:

Changes:

  • doc/source/using_configuring_artifact_server.rst
    ... ... @@ -155,12 +155,15 @@ Instance with push and requiring client authentication:
    155 155
     Managing the cache with systemd
    
    156 156
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    
    157 157
     
    
    158
    -It is better to run the cache as a systemd service, especially if it is running
    
    158
    +We recommend running the cache as a systemd service, especially if it is running
    
    159 159
     on a dedicated server, as this will allow systemd to manage the cache, in case
    
    160 160
     the server encounters any issues.
    
    161 161
     
    
    162
    -Below are two examples of how to run the cache server as a systemd service, one
    
    163
    -is for pull only and the other is configured for push & pull.
    
    162
    +Below are two examples of how to run the cache server as a systemd service. The
    
    163
    +first, is for pull only and the other is configured for push & pull. Notice that
    
    164
    +the two configurations use different ports.
    
    165
    +
    
    166
    +``bst-artifact-serve.service``:
    
    164 167
     
    
    165 168
     .. code:: ini
    
    166 169
     
    
    ... ... @@ -179,6 +182,9 @@ is for pull only and the other is configured for push & pull.
    179 182
        [Install]
    
    180 183
        WantedBy=multi-user.target
    
    181 184
     
    
    185
    +
    
    186
    +``bst-artifact-serve-receive.service``:
    
    187
    +
    
    182 188
     .. code:: ini
    
    183 189
     
    
    184 190
        #
    
    ... ... @@ -196,11 +202,38 @@ is for pull only and the other is configured for push & pull.
    196 202
        [Install]
    
    197 203
        WantedBy=multi-user.target
    
    198 204
     
    
    205
    +
    
    199 206
     Here we define when systemd should start the service, which is after the networking
    
    200 207
     stack has been started, we then define how to run the cache with the desired
    
    201 208
     configuration, under the artifacts user. The {{ }} are there to denote where you
    
    202 209
     should change these files to point to your desired locations.
    
    203 210
     
    
    211
    +.. note::
    
    212
    +
    
    213
    +    You may need to run some of the following commands as the superuser.
    
    214
    +
    
    215
    +These files should be copied to ``/etc/systemd/system/``. We can then start these services
    
    216
    +with:
    
    217
    +
    
    218
    +.. code:: bash
    
    219
    +
    
    220
    +    systemctl enable bst-artifact-serve.service
    
    221
    +    systemctl enable bst-artifact-serve-receive.service
    
    222
    +
    
    223
    +Then, to start these services:
    
    224
    +
    
    225
    +.. code:: bash
    
    226
    +
    
    227
    +    systemctl start bst-artifact-serve.service
    
    228
    +    systemctl start bst-artifact-serve-receive.service
    
    229
    +
    
    230
    +We can then check if the services are successfully running with:
    
    231
    +
    
    232
    +.. code:: bash
    
    233
    +
    
    234
    +    journalctl -u bst-artifact-serve.service
    
    235
    +    journalctl -u bst-artifact-serve-receive.service
    
    236
    +
    
    204 237
     For more information on systemd services see: 
    
    205 238
     `Creating Systemd Service Files <https://www.devdungeon.com/content/creating-systemd-service-files>`_.
    
    206 239
     
    



  • [Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]