From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, spp@dpdk.org, nakamura.hiroyuki@po.ntt-tx.co.jp
Cc: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Subject: [spp] [PATCH v2 06/15] docs: add install guide for SPP container
Date: Mon, 18 Jun 2018 15:21:29 +0900 [thread overview]
Message-ID: <20180618062138.13263-7-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20180618062138.13263-1-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/tools/sppc/install.rst | 91 ++++++++++++++++++++++++++++++
1 file changed, 91 insertions(+)
create mode 100644 docs/guides/tools/sppc/install.rst
diff --git a/docs/guides/tools/sppc/install.rst b/docs/guides/tools/sppc/install.rst
new file mode 100644
index 0000000..2a93832
--- /dev/null
+++ b/docs/guides/tools/sppc/install.rst
@@ -0,0 +1,91 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2017-2018 Nippon Telegraph and Telephone Corporation
+
+.. _spp_container_install:
+
+Install
+=======
+
+
+.. _sppc_install_required:
+
+Required Packages
+-----------------
+
+You need to install packages required for DPDK, and docker.
+
+* DPDK 17.11 or later (supporting container)
+* docker
+
+
+.. _sppc_install_config:
+
+Configurations
+--------------
+
+You might need some additional non-mandatory configurations.
+
+Run docker without sudo
+~~~~~~~~~~~~~~~~~~~~~~~
+
+You should run docker as sudo in most of scripts provided in
+SPP container because for running DPDK applications.
+
+However, you can run docker without sudo if you do not run DPDK
+applications.
+It is useful if you run ``docker kill`` for terminating containerized
+process, ``docker rm`` or ``docker rmi`` for cleaning resources.
+
+.. code-block:: console
+
+ # Terminate container from docker command
+ $ docker kill xxxxxx_yyyyyyy
+
+ # Remove all of containers
+ $ docker rm `docker ps -aq`
+
+ # Remove all of images
+ $ docker rmi `docker images -aq`
+
+The reason for running docker requires sudo is docker daemon
+binds to a unix socket instead of a TCP port.
+Unix socket is owned by root and other users can only access it using
+sudo.
+However, you can run if you add your account to docker group.
+
+.. code-block:: console
+
+ $ sudo groupadd docker
+ $ sudo usermod -aG docker $USER
+
+To activate it, you have to logout and re-login at once.
+
+
+Network Proxy
+~~~~~~~~~~~~~
+
+If you are behind a proxy, you should configure proxy to build an image
+or running container.
+SPP container is supportng proxy configuration for getting
+it from shell environments.
+You confirm that ``http_proxy``, ``https_proxy``
+and ``no_proxy`` of environmental variables are defined.
+
+It also required to add proxy configurations for docker daemon.
+Proxy for docker daemon is defined as ``[Service]`` entry in
+``/etc/systemd/system/docker.service.d/http-proxy.conf``.
+
+.. code-block:: console
+
+ [Service]
+ Environment="HTTP_PROXY=http:..." "HTTPS_PROXY=https..." "NO_PROXY=..."
+
+To activate it, you should restart docker daemon.
+
+.. code-block:: console
+
+ $ systemctl daemon-reload
+ $ systemctl restart docker
+
+You can confirm that environments are updated by running
+``docker info``.
--
2.17.1
next prev parent reply other threads:[~2018-06-18 6:21 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-15 7:06 [spp] [PATCH 00/15] Introduction of SPP container tools ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 01/15] docs: add index of SPP container tool ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 02/15] docs: add overview of SPP container ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 03/15] docs: add overview image " ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 04/15] docs: add getting started guide " ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 05/15] docs: add image of example for gsg ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 06/15] docs: add install guide for SPP container ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 07/15] docs: add build image " ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 08/15] docs: add manual for app container launchers ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 09/15] docs: add use cases of SPP container ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 10/15] docs: add usecase image of testing vhost ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 11/15] docs: add usecase image of testing ring ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 12/15] docs: add usecase image of pktgen and l2fwd ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 13/15] docs: add usecase image of using less lcores ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 14/15] docs: add usecase image of load balancer ogawa.yasufumi
2018-06-15 7:06 ` [spp] [PATCH 15/15] docs: add how to develop guide for SPP container ogawa.yasufumi
2018-06-15 12:47 ` Nakamura Hioryuki
2018-06-18 2:33 ` Yasufumi Ogawa
2018-06-18 6:21 ` [spp] [PATCH v2 00/15] Fix mistakes of SPP container documentation ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 01/15] docs: add index of SPP container tool ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 02/15] docs: add overview of SPP container ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 03/15] docs: add overview image " ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 04/15] docs: add getting started guide " ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 05/15] docs: add image of example for gsg ogawa.yasufumi
2018-06-18 6:21 ` ogawa.yasufumi [this message]
2018-06-18 6:21 ` [spp] [PATCH v2 07/15] docs: add build image guide for SPP container ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 08/15] docs: add manual for app container launchers ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 10/15] docs: add usecase image of testing vhost ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 11/15] docs: add usecase image of testing ring ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 12/15] docs: add usecase image of pktgen and l2fwd ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 13/15] docs: add usecase image of using less lcores ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 14/15] docs: add usecase image of load balancer ogawa.yasufumi
2018-06-18 6:21 ` [spp] [PATCH v2 15/15] docs: add how to develop guide for SPP container ogawa.yasufumi
2018-08-15 15:39 ` [spp] [PATCH v2 00/15] Fix mistakes of SPP container documentation Ferruh Yigit
2018-07-24 8:00 ` [spp] [PATCH v2 09/15] docs: add use cases of SPP container ogawa.yasufumi
2018-07-24 8:20 ` Yasufumi Ogawa
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180618062138.13263-7-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=nakamura.hiroyuki@po.ntt-tx.co.jp \
--cc=spp@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).