[Notes] [Git][BuildStream/buildstream][master] 2 commits: Improve documentation for artifact cache installation

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

Title: GitLab

Javier Jardón pushed to branch master at BuildStream / buildstream

Commits:

• 9b327eb6
  by Ben Brewer at 2018-09-04T14:41:23Z

  Improve documentation for artifact cache installation
  
  Remove ambiguity about systemd service files being separate.
  Add URL for more information about systemd service files.
  Add note about public keys being mandatory for self-signed certs.
  Make cert/key file naming consistent throughout document.
  

• 3e67e64a
  by Javier Jardón at 2018-09-04T16:43:13Z

  Merge branch 'benbrewer/install-artifacts-doc-improvements' into 'master'
  
  Improve documentation for artifact cache installation
  
  See merge request BuildStream/buildstream!777

1 changed file:

• doc/source/install_artifacts.rst

Changes:

doc/source/install_artifacts.rst

---

...	...	@@ -161,13 +161,13 @@ Below are two examples of how to run the cache server as a systemd service, one
161	161
162	162	[Service]
163	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}}
	164	+ ExecStart=/usr/local/bin/bst-artifact-server --port 11001 --server-key {{certs_path}}/server.key --server-cert {{certs_path}}/server.crt {{artifacts_path}}
166	165	User=artifacts
167	166
168	167	[Install]
169	168	WantedBy=multi-user.target
170	169
	170	+.. code:: ini
171	171
172	172	#
173	173	# Pull/Push
...	...	@@ -178,9 +178,7 @@ Below are two examples of how to run the cache server as a systemd service, one
178	178
179	179	[Service]
180	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}}
	181	+ ExecStart=/usr/local/bin/bst-artifact-server --port 11002 --server-key {{certs_path}}/server.key --server-cert {{certs_path}}/server.crt --client-certs {{certs_path}}/authorized.crt --enable-push {{artifacts_path}}
184	182	User=artifacts
185	183
186	184	[Install]
...	...	@@ -188,11 +186,16 @@ Below are two examples of how to run the cache server as a systemd service, one
188	186
189	187	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.
190	188
	189	+For more information on systemd services see:
	190	+`Creating Systemd Service Files <https://www.devdungeon.com/content/creating-systemd-service-files>`_.
	191	+
191	192	User configuration
192	193	~~~~~~~~~~~~~~~~~~
193	194	The user configuration for artifacts is documented with the rest
194	195	of the :ref:`user configuration documentation <user_config>`.
195	196
	197	+Note that for self-signed certificates, the public key fields are mandatory.
	198	+
196	199	Assuming you have the same setup used in this document, and that your
197	200	host is reachable on the internet as ``artifacts.com`` (for example),
198	201	then a user can use the following user configuration:

—
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.