diff options
Diffstat (limited to 'doc/source/install_artifacts.rst')
| -rw-r--r-- | doc/source/install_artifacts.rst | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/doc/source/install_artifacts.rst b/doc/source/install_artifacts.rst new file mode 100644 index 000000000..e96ca972c --- /dev/null +++ b/doc/source/install_artifacts.rst @@ -0,0 +1,188 @@ + + +.. _artifacts: + +Installing an artifact server +============================= +BuildStream caches the results of builds in a local artifact cache, and will +avoid building an element if there is a suitable build already present in the +local artifact cache. + +In addition to the local artifact cache, you can configure one or more remote +artifact caches and BuildStream will then try to pull a suitable build from one +of the remotes, falling back to a local build if needed. + +Configuring BuildStream to use remote caches +-------------------------------------------- +A project will often set up continuous build infrastructure that pushes +built artifacts to a shared cache, so developers working on the project can +make use of these pre-built artifacts instead of having to each build the whole +project locally. The project can declare this cache in its +:ref:`project configuration file <project_essentials_artifacts>`. + +Users can declare additional remote caches in the :ref:`user configuration +<config_artifacts>`. There are several use cases for this: your project may not +define its own cache, it may be useful to have a local mirror of its cache, or +you may have a reason to share artifacts privately. + +Remote artifact caches are identified by their URL. There are currently two +supported protocols: + +* ``http``: Pull and push access, without transport-layer security +* ``https``: Pull and push access, with transport-layer security + +BuildStream allows you to configure as many caches as you like, and will query +them in a specific order: + +1. Project-specific overrides in the user config +2. Project configuration +3. User configuration + +When an artifact is built locally, BuildStream will try to push it to all the +caches which have the ``push: true`` flag set. You can also manually push +artifacts to a specific cache using the :ref:`bst pull command <commands>`. + +Artifacts are identified using the element's :ref:`cache key <cachekeys>` so +the builds provided by a cache should be interchangable with those provided +by any other cache. + + +Setting up a remote artifact cache +---------------------------------- +The rest of this page outlines how to set up a shared artifact cache. + +Setting up the user +~~~~~~~~~~~~~~~~~~~ +A specific user is not needed, however, a dedicated user to own the +artifact cache is recommended. + +.. code:: bash + + useradd artifacts + +The recommended approach is to run two instances on different ports. +One instance has push disabled and doesn't require client authentication. +The other instance has push enabled and requires client authentication. + +Alternatively, you can set up a reverse proxy and handle authentication +and authorization there. + + +Installing the server +~~~~~~~~~~~~~~~~~~~~~ +You will also need to install BuildStream on the artifact server in order +to receive uploaded artifacts over ssh. Follow the instructions for installing +BuildStream :ref:`here <install>` + +When installing BuildStream on the artifact server, it must be installed +in a system wide location, with ``pip3 install .`` in the BuildStream +checkout directory. + +Otherwise, some tinkering is required to ensure BuildStream is available +in ``PATH`` when it's companion ``bst-artifact-server`` program is run +remotely. + +You can install only the artifact server companion program without +requiring BuildStream's more exigent dependencies by setting the +``BST_ARTIFACTS_ONLY`` environment variable at install time, like so: + +.. code:: + + BST_ARTIFACTS_ONLY=1 pip3 install . + + +Command reference +~~~~~~~~~~~~~~~~~ + +.. click:: buildstream._artifactcache.casserver:server_main + :prog: bst-artifact-server + + +Key pair for the server +~~~~~~~~~~~~~~~~~~~~~~~ + +For TLS you need a key pair for the server. The following example creates +a self-signed key, which requires clients to have a copy of the server certificate +(e.g., in the project directory). +You can also use a key pair obtained from a trusted certificate authority instead. + +.. code:: bash + + openssl req -new -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -batch -subj "/CN=artifacts.com" -out server.crt -keyout server.key + + +Authenticating users +~~~~~~~~~~~~~~~~~~~~ +In order to give permission to a given user to upload +artifacts, create a TLS key pair on the client. + +.. code:: bash + + openssl req -new -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -batch -subj "/CN=client" -out client.crt -keyout client.key + +Copy the public client certificate ``client.crt`` to the server and then add it +to the authorized keys, like so: + +.. code:: bash + + cat client.crt >> /home/artifacts/authorized.crt + + +Serve the cache over https +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Public instance without push: + +.. code:: bash + + bst-artifact-server --port 11001 --server-key server.key --server-cert server.crt /home/artifacts/artifacts + +Instance with push and requiring client authentication: + +.. code:: bash + + bst-artifact-server --port 11002 --server-key server.key --server-cert server.crt --client-certs authorized.crt --enable-push /home/artifacts/artifacts + + +User configuration +~~~~~~~~~~~~~~~~~~ +The user configuration for artifacts is documented with the rest +of the :ref:`user configuration documentation <user_config>`. + +Assuming you have the same setup used in this document, and that your +host is reachable on the internet as ``artifacts.com`` (for example), +then a user can use the following user configuration: + +Pull-only: + +.. code:: yaml + + # + # Artifacts + # + artifacts: + + url: https://artifacts.com:11001 + + # Optional server certificate if not trusted by system root certificates + server-cert: server.crt + +Pull and push: + +.. code:: yaml + + # + # Artifacts + # + artifacts: + + url: https://artifacts.com:11002 + + # Optional server certificate if not trusted by system root certificates + server-cert: server.crt + + # Optional client key pair for authentication + client-key: client.key + client-cert: client.crt + + push: true |