diff options
author | James Ennis <james.ennis@codethink.com> | 2018-11-06 16:15:36 +0000 |
---|---|---|
committer | richardmaw-codethink <richard.maw@codethink.co.uk> | 2018-11-07 11:06:11 +0000 |
commit | f514124fc6045b7df7e786940684040c187cc581 (patch) | |
tree | 5b9c259ef5dac3c416c000171b6e8815aca07ef1 /doc/source | |
parent | 09ab676d0567032a4716f32c8c07cb1dbf0a02f5 (diff) | |
download | buildstream-f514124fc6045b7df7e786940684040c187cc581.tar.gz |
using_configuring_artifact_server.rst: Remove examples and redirect to user config/project config
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/using_configuring_artifact_server.rst | 54 |
1 files changed, 7 insertions, 47 deletions
diff --git a/doc/source/using_configuring_artifact_server.rst b/doc/source/using_configuring_artifact_server.rst index e3f2f6af9..cc4880e94 100644 --- a/doc/source/using_configuring_artifact_server.rst +++ b/doc/source/using_configuring_artifact_server.rst @@ -239,52 +239,12 @@ We can then check if the services are successfully running with: For more information on systemd services see: `Creating Systemd Service Files <https://www.devdungeon.com/content/creating-systemd-service-files>`_. -User configuration -~~~~~~~~~~~~~~~~~~ -The user configuration for artifacts is documented with the rest -of the :ref:`user configuration documentation <user_config>`. +Declaring remote artifact caches +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Remote artifact caches can be declared within either: -Note that for self-signed certificates, the public key fields are mandatory. +1. The :ref:`project configuration <project_essentials_artifacts>`, or +2. The :ref:`user configuration <config_artifacts>`. -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 - -.. note:: - - Equivalent statements can be delcared in a project's configuration file - (the ``project.conf``). +Please follow the above links to see examples showing how we declare remote +caches in both the project configuration and the user configuration, respectively. |