[Notes] [Git][BuildStream/buildstream][jennis/patch_remote_cache_docs] 2 commits: docs: Add helpful notes to artifact server configuration instructions



Title: GitLab

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

Commits:

1 changed file:

Changes:

  • doc/source/using_configuring_artifact_server.rst
    ... ... @@ -40,7 +40,7 @@ them in a specific order:
    40 40
     
    
    41 41
     When an artifact is built locally, BuildStream will try to push it to all the
    
    42 42
     caches which have the ``push: true`` flag set. You can also manually push
    
    43
    -artifacts to a specific cache using the :ref:`bst pull command <commands>`.
    
    43
    +artifacts to a specific cache using the :ref:`bst push command <invoking_push>`.
    
    44 44
     
    
    45 45
     Artifacts are identified using the element's :ref:`cache key <cachekeys>` so
    
    46 46
     the builds provided by a cache should be interchangable with those provided
    
    ... ... @@ -110,6 +110,15 @@ You can also use a key pair obtained from a trusted certificate authority instea
    110 110
     
    
    111 111
         openssl req -new -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -batch -subj "/CN=artifacts.com" -out server.crt -keyout server.key
    
    112 112
     
    
    113
    +.. note::
    
    114
    +
    
    115
    +    Note that in the ``-subj "/CN=<foo>"`` argument, ``/CN`` is the *certificate common name*,
    
    116
    +    and as such ``<foo>`` should be the public hostname of the server. IP addresses will
    
    117
    +    **not** provide you with working authentication.
    
    118
    +
    
    119
    +    In addition to this, ensure that the host server is recognised by the client.
    
    120
    +    You may need to add the line: ``<ip address>`` ``<hostname>`` to
    
    121
    +    your ``/etc/hosts`` file.
    
    113 122
     
    
    114 123
     Authenticating users
    
    115 124
     ~~~~~~~~~~~~~~~~~~~~
    
    ... ... @@ -233,3 +242,8 @@ Pull and push:
    233 242
          client-cert: client.crt
    
    234 243
     
    
    235 244
          push: true
    
    245
    +
    
    246
    +.. note::
    
    247
    +
    
    248
    +    Equivalent statements can be delcared in a project's configuration file
    
    249
    +    (the ``project.conf``).



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