[Notes] [Git][BuildStream/buildstream][jennis/change_arch_install_instructions] 4 commits: Add systemd service file examples to artifacts documentation

[Javier Jardón <gitlab mg gitlab com>]

Title: GitLab

Javier Jardón pushed to branch jennis/change_arch_install_instructions at BuildStream / buildstream

Commits:

• 289de2ef
  by Adam Jones at 2018-08-07T09:24:58Z

  Add systemd service file examples to artifacts documentation
  
  change code style to ini
  

• e42325b9
  by Javier Jardón at 2018-08-07T10:29:46Z

  Merge branch 'adamjones/systemd-cas' into 'master'
  
  Include systemd file examples for google-cas cache
  
  Closes #419
  
  See merge request BuildStream/buildstream!524

• 6d349610
  by Javier Jardón at 2018-08-07T10:53:23Z

  source/install_linux_distro.rst: Fix formatting
  

• 262b19eb
  by James Ennis at 2018-08-07T10:53:51Z

  install_linux_distro.rst: Change install instructions for python-arpy package on Arch
  
    - python-arpy is unobtainable via pacman
    - Also a minor change to how we display install instructions
    from Fedora's dnf package manager
  

2 changed files:

• doc/source/install_artifacts.rst
• doc/source/install_linux_distro.rst

Changes:

doc/source/install_artifacts.rst

---

...	...	@@ -143,6 +143,50 @@ Instance with push and requiring client authentication:
143	143
144	144	bst-artifact-server --port 11002 --server-key server.key --server-cert server.crt --client-certs authorized.crt --enable-push /home/artifacts/artifacts
145	145
	146	+Managing the cache with systemd
	147	+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	148	+
	149	+It is better to run the cache as a systemd service, especially if it is running on a dedicated server, as this will allow systemd to manage the cache, incase the server ever encounters any issues.
	150	+
	151	+Below are two examples of how to run the cache server as a systemd service, one is for pull only and the other is configured for push & pull.
	152	+
	153	+.. code:: ini
	154	+
	155	+ #
	156	+ # Pull
	157	+ #
	158	+ [Unit]
	159	+ Description=Buildstream Artifact pull server
	160	+ After=remote-fs.target network-online.target
	161	+
	162	+ [Service]
	163	+ Environment="LC_ALL=C.UTF-8"
	164	+ ExecStart=/usr/local/bin/bst-artifact-server --port 11001 --server-key {{certs_path}}/privkey.pem --
	165	+ server-cert {{certs_path}}/fullchain.pem {{artifacts_path}}
	166	+ User=artifacts
	167	+
	168	+ [Install]
	169	+ WantedBy=multi-user.target
	170	+
	171	+
	172	+ #
	173	+ # Pull/Push
	174	+ #
	175	+ [Unit]
	176	+ Description=Buildstream Artifact pull/push server
	177	+ After=remote-fs.target network-online.target
	178	+
	179	+ [Service]
	180	+ Environment="LC_ALL=C.UTF-8"
	181	+ ExecStart=/usr/local/bin/bst-artifact-server --port 11002 --server-key {{certs_path}}/privkey.pem --
	182	+ server-cert {{certs_path}}/fullchain.pem --client-certs /home/artifacts/authorized.crt --enable-push /
	183	+ {{artifacts_path}}
	184	+ User=artifacts
	185	+
	186	+ [Install]
	187	+ WantedBy=multi-user.target
	188	+
	189	+Here we define when systemd should start the service, which is after the networking stack has been started, we then define how to run the cache with the desired configuration, under the artifacts user. The {{ }} are there to denote where you should change these files to point to your desired locations.
146	190
147	191	User configuration
148	192	~~~~~~~~~~~~~~~~~~

doc/source/install_linux_distro.rst

---

1		-
2	1	.. _install:
3	2
4	3	Installing BuildStream on a Linux distro
...	...	@@ -57,8 +56,19 @@ Install the dependencies with::
57	56	For the default plugins::
58	57
59	58	sudo pacman -S \
60		- bzr git lzip ostree patch python-arpy python-gobject
	59	+ bzr git lzip ostree patch python-gobject
	60	+
	61	+
	62	+The package *python-arpy* is required by the deb source plugin. This is not
	63	+obtainable via `pacman`, you must get *python-arpy* from AUR:
	64	+https://aur.archlinux.org/packages/python-arpy/
61	65
	66	+To install::
	67	+
	68	+ wget https://aur.archlinux.org/cgit/aur.git/snapshot/python-arpy.tar.gz
	69	+ tar -xvf python-arpy.tar.gz
	70	+ cd python-arpy
	71	+ makepkg -si
62	72
63	73	Debian
64	74	++++++
...	...	@@ -218,14 +228,16 @@ Arch Linux
218	228	~~~~~~~~~~
219	229	Packages for Arch exist in `AUR <https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages>`_.
220	230	Two different package versions are available:
	231	+
221	232	* Latest release: `buildstream <https://aur.archlinux.org/packages/buildstream>`_
222	233	* Latest development snapshot: `buildstream-git <https://aur.archlinux.org/packages/buildstream-git>`_
223	234
	235	+
224	236	Fedora
225	237	~~~~~~
226	238
227	239	BuildStream is not yet in the official Fedora repositories, but you can
228		-install it from a Copr:
	240	+install it from a Copr::
229	241
230	242	sudo dnf copr enable bochecha/buildstream
231	243	sudo dnf install buildstream

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.