From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0502.ocn.ad.jp (mogw0502.ocn.ad.jp [118.23.178.142]) by dpdk.org (Postfix) with ESMTP id C39C71D901 for ; Fri, 15 Jun 2018 09:06:28 +0200 (CEST) Received: from mf-smf-ucb033c2 (mf-smf-ucb033c2.ocn.ad.jp [153.153.66.225]) by mogw0502.ocn.ad.jp (Postfix) with ESMTP id B3C6924C314; Fri, 15 Jun 2018 16:06:27 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb023 ([153.149.142.86]) by mf-smf-ucb033c2 with ESMTP id TioTfI6gUSNiFTioVf8SoX; Fri, 15 Jun 2018 16:06:27 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.165]) by ntt.pod01.mv-mta-ucb023 with id yv6T1x00K3akymp01v6Tpz; Fri, 15 Jun 2018 07:06:27 +0000 Received: from localhost.localdomain (p5164-ipngn8501marunouchi.tokyo.ocn.ne.jp [153.214.228.164]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Fri, 15 Jun 2018 16:06:27 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org Cc: Yasufumi Ogawa Date: Fri, 15 Jun 2018 16:06:06 +0900 Message-Id: <20180615070615.15594-7-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180615070615.15594-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180615070615.15594-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 06/15] docs: add install guide for SPP container X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 15 Jun 2018 07:06:29 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/tools/sppc/install.rst | 94 ++++++++++++++++++++++++++++++ 1 file changed, 94 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..55be312 --- /dev/null +++ b/docs/guides/tools/sppc/install.rst @@ -0,0 +1,94 @@ +.. _spp_container_install: + +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2017-2018 Nippon Telegraph and Telephone Corporation + + +.. _sppc_install_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