diff --git a/userdocs/fuel-install-guide.rst b/userdocs/fuel-install-guide.rst index cc0829954..5c092bf91 100644 --- a/userdocs/fuel-install-guide.rst +++ b/userdocs/fuel-install-guide.rst @@ -11,6 +11,7 @@ Fuel Installation Guide fuel-install-guide/sysreq_intro fuel-install-guide/install_install_fuel fuel-install-guide/bootstrap_intro + fuel-install-guide/local-repo fuel-install-guide/plugins_intro fuel-install-guide/vsphere_intro fuel-install-guide/update-fuel diff --git a/userdocs/fuel-install-guide/install/install_set_up_fuel.rst b/userdocs/fuel-install-guide/install/install_set_up_fuel.rst index f71f3363b..9f406c49c 100644 --- a/userdocs/fuel-install-guide/install/install_set_up_fuel.rst +++ b/userdocs/fuel-install-guide/install/install_set_up_fuel.rst @@ -98,11 +98,11 @@ settings and proceed to :ref:`install_install_fuel_master_node`. | | repository field. To configure | | | the Ubuntu repository mirror | | | on a local host, use the | - | | ``fuel-createmirror`` script | + | | ``fuel-mirror`` script | | | shipped with the Fuel ISO. | | | | | | For more information, see: | - | | :ref:`upgrade_local_repo`. | + | | :ref:`local-repo`. | +--------------------------------------+----------------------------------+ | 7. Configure the network time | To avoid issues with the time | | protocol. | settings inconsistency on the | diff --git a/userdocs/fuel-install-guide/intro/intro_install_overview.rst b/userdocs/fuel-install-guide/intro/intro_install_overview.rst index 8cf251226..c591a82a0 100644 --- a/userdocs/fuel-install-guide/intro/intro_install_overview.rst +++ b/userdocs/fuel-install-guide/intro/intro_install_overview.rst @@ -13,7 +13,7 @@ requirements and sequence of tasks that you must complete. #. Verify that your environment meets the recommendations in :ref:`System requirements `. -#. Verify your hardware using the +#. Verify your hardware using the :ref:`Hardware checklist `. #. Determine whether the server on which you plan to install the Fuel @@ -21,7 +21,7 @@ requirements and sequence of tasks that you must complete. * If the server does not have an Internet connection, then you must configure a local repository. For more - information, see: :ref:`Set up a local repository `. + information, see: :ref:`Set up a local repository `. #. If you plan to install Fuel on VMware vSphere, verify that your environment meets the :ref:`VMware vSphere prerequisites ` diff --git a/userdocs/fuel-install-guide/local-repo.rst b/userdocs/fuel-install-guide/local-repo.rst new file mode 100644 index 000000000..e6f463d35 --- /dev/null +++ b/userdocs/fuel-install-guide/local-repo.rst @@ -0,0 +1,80 @@ +.. _local-repo: + +========================= +Set up a local repository +========================= + +Fuel downloads the OpenStack and operating system packages +from the predefined repositories on the Fuel Master node. +If your Fuel Master node does not have an Internet connection, +you must configure a local repository mirror with the required +packages and configure Fuel to use this repository. This +configuration is done using the ``fuel-mirror`` script. + +.. caution:: The ``fuel-createmirror`` script is deprecated. Use + ``fuel-mirror`` instead. + +**To set up a local repository using the Fuel CLI:** + +#. Log in to the Fuel Master node CLI. +#. Create a new local mirror on the Fuel Master node: + + .. code-block:: console + + fuel-mirror create -P PROFILE_NAME -G GROUP + + where ``PROFILE_NAME`` is the name of one of the files without the + ``.yaml`` extension that are provided by the ``fuel-mirror`` package + (``/usr/share/fuel-mirror/*.yaml``). + + **Example:** + + .. code-block:: console + + fuel-mirror create -P ubuntu -G ubuntu + +#. Apply the local mirror to an environment: + + .. code-block:: console + + fuel-mirror apply -P PROFILE_NAME -G GROUP + + You can add the following flags to the :command:`fuel-mirror apply` + command: + + * ``--default`` - to use the new local repository for new environments + by default. + + * ``--replace`` - to use the new local repository instead of the current + ones. Otherwise, the new local repository is merged with the existing + ones. And the current repositories will be overwritten if their + names match the names of the new local repositories. + + For example, to use only the new local repositories by default, run: + + .. code-block:: console + + fuel-mirror apply -G ubuntu -I /usr/share/fuel-mirror/ubuntu.yaml --replace --default + fuel-mirror apply -G mos -I /usr/share/fuel-mirror/ubuntu.yaml --default + +#. Verify that the repository URL is successfully changed using the + :command:`fuel2 release repos list` command. + +.. note:: If you changed the default Fuel root password, add the + ``--fuel-password YOUR_PASSWORD`` flag to the script command. + +About the fuel-mirror script +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``fuel-mirror`` script provided with the ``fuel-mirror`` package enables +you to modify the Fuel repository sources through the Fuel CLI. + +* To view help information, type ``fuel-mirror -h``. + +* The script supports running behind an HTTP or HTTPS proxy. + The following environment variable can be set either + system-wide (through ``~/.bashrc``) or in the script configuration file: + + .. code-block:: console + + http_proxy=http://username:password@host:port/ diff --git a/userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst b/userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst index 9ea72063b..d9af22a5a 100644 --- a/userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst +++ b/userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst @@ -21,4 +21,4 @@ node. .. seealso:: - - :ref:`upgrade_local_repo` + - :ref:`local-repo` diff --git a/userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst b/userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst deleted file mode 100644 index ef1666b1f..000000000 --- a/userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst +++ /dev/null @@ -1,77 +0,0 @@ -.. _upgrade_local_repo: - -Set up a local repository -------------------------- - -Fuel downloads the OpenStack and operating system packages -from the predefined repositories on the Fuel Master node. -If your Fuel Master node does not have an Internet connection, -you must configure a local repository mirror with the required -packages and configure Fuel to use this repository. - -You can set up a local repository in the Fuel web UI -or through Fuel CLI using the ``fuel-createmirror`` script. - -**To set up a local repository in the Fuel web UI** - -#. In the Fuel web UI, navigate to the :guilabel:`Settings` tab - and then scroll down to the :guilabel:`Repositories` section. -#. Change the path under :guilabel:`URI`. - -**To set up a local repository with the ``fuel-createmirror`` script** - -#. Log in to the Fuel Master node CLI. -#. Run the ``fuel-createmirror`` script: - - * If you use the default Fuel root password, type: - - :: - - fuel-createmirror - - * If you change the default Fuel root password, type: - - :: - - fuel-createmirror --password PASSWORD - -#. Restart the docker daemon - - :: - - service docker restart - - Alternatively (recommended), reboot the Fuel Master node. - -About the fuel-createmirror script -++++++++++++++++++++++++++++++++++ - -The ``fuel-createmirror`` is a built-in Fuel script that enables -you to modify the Fuel repository sources from the CLI. - -* The script supports only RSYNC mirrors. - See the `the list of official upstream Ubuntu mirrors `_. - -* The script uses a Docker container with Ubuntu to support dependencies - resolution. - -* To view help information, type ``fuel-createmirror -h``. - -* The script supports running behind an HTTP proxy configured to - Port 873 (rsync). The following environment variables can be set either - system-wide (via ~/.bashrc), or in the script configuration file: - - :: - - http_proxy=http://username:password@host:port/ - RSYNC_PROXY=username:password@host:port - -* You can also configure Docker to use the proxy to download the Ubuntu - image needed to resolve the packages dependencies. Add the environment - variables to the `/etc/sysconfig/docker` file, and export them: - - :: - - http_proxy=http://username:password@host:port/ - RSYNC_PROXY=username:password@host:port - export http_proxy RYSNC_PROXY diff --git a/userdocs/fuel-install-guide/upgrade_intro.rst b/userdocs/fuel-install-guide/upgrade_intro.rst index f5ab54cfb..08c52e48a 100644 --- a/userdocs/fuel-install-guide/upgrade_intro.rst +++ b/userdocs/fuel-install-guide/upgrade_intro.rst @@ -14,7 +14,6 @@ This section includes the following topics. upgrade/upgrade-internals upgrade/upgrade-liberty - upgrade/upgrade-local-repo .. note:: Fuel does not support upgrades for plugins. The old plugin versions may not be compatible with the new version of Fuel. diff --git a/userdocs/fuel-user-guide/configure-environment/settings.rst b/userdocs/fuel-user-guide/configure-environment/settings.rst index 2ab35c299..016472cc1 100644 --- a/userdocs/fuel-user-guide/configure-environment/settings.rst +++ b/userdocs/fuel-user-guide/configure-environment/settings.rst @@ -31,7 +31,7 @@ by editing the corresponding configuration files. packages required to install and update Fuel and OpenStack components. If you do not have an Internet connection, you can set up a local repository and provide the URL to the repository on - this page. + this page. For details, see: :ref:`local-repo`. Kernel parameters Enables you to modify kernel parameters. This field does not set kernel parameters for the Fuel Master node or for nodes that have