[Notes] [Git][BuildStream/buildstream][master] 3 commits: doc: Add new document about Docker integrations

[Chandan Singh <gitlab mg gitlab com>]

Title: GitLab

Chandan Singh pushed to branch master at BuildStream / buildstream

Commits:

• cda1354c
  by Chandan Singh at 2018-10-10T00:17:51Z

  doc: Add new document about Docker integrations
  
  Add a new section under "Additional writings" section about how
  BuildStream integrates with Docker. At present, this section includes
  only two sections:
  
  - "Run BuildStream inside Docker", that refers to existing instructions
  for doing so
  - "Generate Docker images", that adds instructions for using the newly
  added `contrib/bst-docker-import` script
  
  In future, this document can be extended to include the following
  things:
  
  - Importing Docker sources via `docker` source plugin - if/when the
  Docker source plguin is moved from bst-external to BuildStream proper
  - A Docker sandbox, if/when that is added
  

• dd472d95
  by Chandan Singh at 2018-10-10T00:18:17Z

  NEWS: Add entry about contrib/bst-docker-import
  
  As suggested in
  https://gitlab.com/BuildStream/buildstream/merge_requests/857#note_106809743,
  add a NEWS entry for `contrib/bst-docker-import` that was added
  recently.
  

• 35ac26a7
  by Chandan Singh at 2018-10-10T00:59:17Z

  Merge branch 'chandan/bst-and-docker' into 'master'
  
  Add documentation and NEWS entry about bst-docker-import
  
  See merge request BuildStream/buildstream!864

3 changed files:

• NEWS
• + doc/source/additional_docker.rst
• doc/source/core_additional.rst

Changes:

NEWS

---

...	...	@@ -24,6 +24,9 @@ buildstream 1.3.1
24	24	o Add new `pip` source plugin for downloading python packages using pip,
25	25	based on requirements files from previous sources.
26	26
	27	+ o Generate Docker images from built artifacts using
	28	+ `contrib/bst-docker-import` script.
	29	+
27	30
28	31	=================
29	32	buildstream 1.1.5

doc/source/additional_docker.rst

---

	1	+
	2	+.. _bst_and_docker:
	3	+
	4	+
	5	+BuildStream and Docker
	6	+======================
	7	+
	8	+BuildStream integrates with Docker in multiple ways. Here are some ways in
	9	+which these integrations work.
	10	+
	11	+Run BuildStream inside Docker
	12	+-----------------------------
	13	+
	14	+Refer to the :ref:`BuildStream inside Docker <docker>` documentation for
	15	+instructions on how to run BuildStream as a Docker container.
	16	+
	17	+Generate Docker images
	18	+----------------------
	19	+
	20	+The
	21	+`bst-docker-import script <https://gitlab.com/BuildStream/buildstream/blob/master/contrib/bst-docker-import>`_
	22	+can be used to generate a Docker image from built artifacts.
	23	+
	24	+You can download it and make it executable like this:
	25	+
	26	+.. code:: bash
	27	+
	28	+ mkdir -p ~/.local/bin
	29	+ curl --get https://gitlab.com/BuildStream/buildstream/raw/master/contrib/bst-docker-import > ~/.local/bin/bst-docker-import
	30	+ chmod +x ~/.local/bin/bst-docker-import
	31	+
	32	+Check if ``~/.local/bin`` appears in your PATH environment variable -- if it
	33	+doesn't, you should
	34	+`edit your ~/.profile so that it does <https://stackoverflow.com/questions/14637979/>`_.
	35	+
	36	+Once the script is available in your PATH and assuming you have Docker
	37	+installed, you can start using the ``bst-docker-import`` script. Here is a
	38	+minimal example to generate an image called ``bst-hello`` from an element
	39	+called ``hello.bst`` assuming it is already built:
	40	+
	41	+.. code:: bash
	42	+
	43	+ bst-docker-import -t bst-hello hello.bst
	44	+
	45	+This script can also be used if you are running BuildStream inside Docker. In
	46	+this case, you will need to supply the command that you are using to run
	47	+BuildStream using the ``-c`` option. If you are using the
	48	+`bst-here wrapper script <https://gitlab.com/BuildStream/buildstream/blob/master/contrib/bst-here>`_,
	49	+you can achieve the same results as the above example like this:
	50	+
	51	+.. code:: bash
	52	+
	53	+ bst-docker-import -c bst-here -t bst-hello hello.bst

doc/source/core_additional.rst

---

...	...	@@ -8,3 +8,4 @@ Additional writings
8	8
9	9	additional_cachekeys
10	10	additional_sandboxing
	11	+ additional_docker

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