diff --git a/doc/source/configuration/docker_proxy_config.rst b/doc/source/configuration/docker_proxy_config.rst index 725e991e5..3f9ee31f0 100644 --- a/doc/source/configuration/docker_proxy_config.rst +++ b/doc/source/configuration/docker_proxy_config.rst @@ -2,10 +2,40 @@ Docker Proxy Configuration ========================== -This guide describes how to set the Docker HTTP/HTTPS proxy after installation. +StarlingX uses publicly available container runtime registries. If you are +behind a corporate firewall or proxy, you need to set proxy settings. + +For example, if the StarlingX OAM interface or network is behind an http/https +proxy, relative to the Docker registries used by StarlingX or applications +running on StarlingX, then Docker within StarlingX must be configured to use +these http/https proxies. + +.. contents:: + :local: + :depth: 1 + +-------------- +Proxy overview +-------------- + +The figure below shows how proxies are used in StarlingX. + +.. figure:: starlingx_proxy.png + :scale: 75% + :alt: StarlingX proxy usage + + *Figure 1: StarlingX proxy usage* + +---------------------- +Set proxy at bootstrap +---------------------- To set the Docker proxy at bootstrap time, refer to -`Ansible Bootstrap Configurations `_. +:doc:`Ansible Bootstrap Configurations <../deploy_install_guides/r3_release/ansible_bootstrap_configs>`. + +------------------ +Set HTTP proxy URL +------------------ To specify the HTTP proxy URL, use the commands: @@ -14,9 +44,31 @@ To specify the HTTP proxy URL, use the commands: system service-parameter-modify platform docker http_proxy http://my.proxy.com:1080 system service-parameter-apply platform +------------------- +Set HTTPS proxy URL +------------------- + To specify the HTTPS proxy URL, use the commands: :: system service-parameter-modify platform docker https_proxy https://my.proxy.com:1443 system service-parameter-apply platform + +------------------------- +Set no-proxy address list +------------------------- + +A no-proxy address list can be provided for registries not on the other side +of the proxies. This list will be added to the default no-proxy list derived +from localhost, loopback, management, and OAM floating addresses at runtime. + +Due to a Docker restriction, each address in the no-proxy list must not be in +subnet format and it cannot contain a wildcard. For example: + +To specify a no-proxy list, use the commands: + +:: + + system service-parameter-modify platform docker no_proxy: 1.2.3.4, 5.6.7.8 + system service-parameter-apply platform diff --git a/doc/source/configuration/starlingx_proxy.png b/doc/source/configuration/starlingx_proxy.png new file mode 100644 index 000000000..ba74763c3 Binary files /dev/null and b/doc/source/configuration/starlingx_proxy.png differ diff --git a/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst index 184a5d25d..29e835411 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst @@ -142,12 +142,20 @@ On virtual controller-0: admin_username: admin admin_password: ansible_become_pass: + + # Add these lines to configure Docker to use a proxy server + # docker_http_proxy: http://my.proxy.com:1080 + # docker_https_proxy: https://my.proxy.com:1443 + # docker_no_proxy: + # - 1.2.3.4 + EOF Refer to :doc:`/deploy_install_guides/r3_release/ansible_bootstrap_configs` for information on additional Ansible bootstrap configurations for advanced - Ansible bootstrap scenarios, such as docker-proxies when deploying behind a - firewall, etc. + Ansible bootstrap scenarios, such as Docker proxies when deploying behind a + firewall, etc. Refer to :doc:`/../../configuration/docker_proxy_config` for + details about Docker proxy settings. #. Run the Ansible bootstrap playbook: @@ -261,6 +269,19 @@ On virtual controller-0: system host-disk-list controller-0 | awk '/\/dev\/sdb/{print $2}' | xargs -i system host-stor-add controller-0 {} system host-stor-list controller-0 +#. If required, and not already done as part of bootstrap, configure Docker to + use a proxy server. + + #. List Docker proxy parameters: + + :: + + system service-parameter-list platform docker + + #. Refer to :doc:`/../../configuration/docker_proxy_config` for + details about Docker proxy settings. + + ************************************* OpenStack-specific host configuration *************************************