summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlena Logvinova <ologvinova@mirantis.com>2017-01-12 16:47:18 +0200
committerOlena Logvinova <ologvinova@mirantis.com>2017-02-03 12:28:19 +0000
commit991c744ea81eb62f4a344880155d014da5bb1566 (patch)
tree98243f79b47f2a252c8e3abad0c1570b276f2e8b
parent72995c5af3bf870f20e4aec183f4d0c04fa14cac (diff)
[Install Guide] Replace fuel-createmirror with fuel-mirror
The patch: 1. Updates the 'Set up a local repository' section of the Fuel Install Guide to replace the deprecated `fuel-createmirror` command with the current `fuel-mirror` one; 2. Moves this file to a separate section since it seems to be not related to the 'Upgrade' section; 3. Fixes noticed typos. Closes-Bug: #1651737 Partial-Bug: #1563086 backport: newton mitaka Change-Id: I523ec8c6d5341a51fbdf555f1e9e0dfbab875770
Notes
Notes (review): Verified+1: Fuel CI <fuel-ci-bot@mirantis.com> Code-Review+2: Maria Zlatkova <mzlatkova@mirantis.com> Code-Review+2: Olga Gusarenko <ogusarenko@mirantis.com> Workflow+1: Olga Gusarenko <ogusarenko@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 03 Feb 2017 13:43:39 +0000 Reviewed-on: https://review.openstack.org/419498 Project: openstack/fuel-docs Branch: refs/heads/master
-rw-r--r--userdocs/fuel-install-guide.rst1
-rw-r--r--userdocs/fuel-install-guide/install/install_set_up_fuel.rst4
-rw-r--r--userdocs/fuel-install-guide/intro/intro_install_overview.rst4
-rw-r--r--userdocs/fuel-install-guide/local-repo.rst80
-rw-r--r--userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst2
-rw-r--r--userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst77
-rw-r--r--userdocs/fuel-install-guide/upgrade_intro.rst1
-rw-r--r--userdocs/fuel-user-guide/configure-environment/settings.rst2
8 files changed, 87 insertions, 84 deletions
diff --git a/userdocs/fuel-install-guide.rst b/userdocs/fuel-install-guide.rst
index cc08299..5c092bf 100644
--- a/userdocs/fuel-install-guide.rst
+++ b/userdocs/fuel-install-guide.rst
@@ -11,6 +11,7 @@ Fuel Installation Guide
11 fuel-install-guide/sysreq_intro 11 fuel-install-guide/sysreq_intro
12 fuel-install-guide/install_install_fuel 12 fuel-install-guide/install_install_fuel
13 fuel-install-guide/bootstrap_intro 13 fuel-install-guide/bootstrap_intro
14 fuel-install-guide/local-repo
14 fuel-install-guide/plugins_intro 15 fuel-install-guide/plugins_intro
15 fuel-install-guide/vsphere_intro 16 fuel-install-guide/vsphere_intro
16 fuel-install-guide/update-fuel 17 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 f71f336..9f406c4 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`.
98 | | repository field. To configure | 98 | | repository field. To configure |
99 | | the Ubuntu repository mirror | 99 | | the Ubuntu repository mirror |
100 | | on a local host, use the | 100 | | on a local host, use the |
101 | | ``fuel-createmirror`` script | 101 | | ``fuel-mirror`` script |
102 | | shipped with the Fuel ISO. | 102 | | shipped with the Fuel ISO. |
103 | | | 103 | | |
104 | | For more information, see: | 104 | | For more information, see: |
105 | | :ref:`upgrade_local_repo`. | 105 | | :ref:`local-repo`. |
106 +--------------------------------------+----------------------------------+ 106 +--------------------------------------+----------------------------------+
107 | 7. Configure the network time | To avoid issues with the time | 107 | 7. Configure the network time | To avoid issues with the time |
108 | protocol. | settings inconsistency on the | 108 | 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 8cf2512..c591a82 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.
13#. Verify that your environment meets the recommendations in 13#. Verify that your environment meets the recommendations in
14 :ref:`System requirements <sysreq_intro>`. 14 :ref:`System requirements <sysreq_intro>`.
15 15
16#. Verify your hardware using the 16#. Verify your hardware using the
17 :ref:`Hardware checklist <preinstall_chklist_hardware_checklist>`. 17 :ref:`Hardware checklist <preinstall_chklist_hardware_checklist>`.
18 18
19#. Determine whether the server on which you plan to install the Fuel 19#. 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.
21 21
22 * If the server does not have an Internet 22 * If the server does not have an Internet
23 connection, then you must configure a local repository. For more 23 connection, then you must configure a local repository. For more
24 information, see: :ref:`Set up a local repository <install_set_up_fuel>`. 24 information, see: :ref:`Set up a local repository <local-repo>`.
25 25
26#. If you plan to install Fuel on VMware vSphere, verify that your environment 26#. If you plan to install Fuel on VMware vSphere, verify that your environment
27 meets the :ref:`VMware vSphere prerequisites <vsphere_intro>` 27 meets the :ref:`VMware vSphere prerequisites <vsphere_intro>`
diff --git a/userdocs/fuel-install-guide/local-repo.rst b/userdocs/fuel-install-guide/local-repo.rst
new file mode 100644
index 0000000..e6f463d
--- /dev/null
+++ b/userdocs/fuel-install-guide/local-repo.rst
@@ -0,0 +1,80 @@
1.. _local-repo:
2
3=========================
4Set up a local repository
5=========================
6
7Fuel downloads the OpenStack and operating system packages
8from the predefined repositories on the Fuel Master node.
9If your Fuel Master node does not have an Internet connection,
10you must configure a local repository mirror with the required
11packages and configure Fuel to use this repository. This
12configuration is done using the ``fuel-mirror`` script.
13
14.. caution:: The ``fuel-createmirror`` script is deprecated. Use
15 ``fuel-mirror`` instead.
16
17**To set up a local repository using the Fuel CLI:**
18
19#. Log in to the Fuel Master node CLI.
20#. Create a new local mirror on the Fuel Master node:
21
22 .. code-block:: console
23
24 fuel-mirror create -P PROFILE_NAME -G GROUP
25
26 where ``PROFILE_NAME`` is the name of one of the files without the
27 ``.yaml`` extension that are provided by the ``fuel-mirror`` package
28 (``/usr/share/fuel-mirror/*.yaml``).
29
30 **Example:**
31
32 .. code-block:: console
33
34 fuel-mirror create -P ubuntu -G ubuntu
35
36#. Apply the local mirror to an environment:
37
38 .. code-block:: console
39
40 fuel-mirror apply -P PROFILE_NAME -G GROUP
41
42 You can add the following flags to the :command:`fuel-mirror apply`
43 command:
44
45 * ``--default`` - to use the new local repository for new environments
46 by default.
47
48 * ``--replace`` - to use the new local repository instead of the current
49 ones. Otherwise, the new local repository is merged with the existing
50 ones. And the current repositories will be overwritten if their
51 names match the names of the new local repositories.
52
53 For example, to use only the new local repositories by default, run:
54
55 .. code-block:: console
56
57 fuel-mirror apply -G ubuntu -I /usr/share/fuel-mirror/ubuntu.yaml --replace --default
58 fuel-mirror apply -G mos -I /usr/share/fuel-mirror/ubuntu.yaml --default
59
60#. Verify that the repository URL is successfully changed using the
61 :command:`fuel2 release repos list` command.
62
63.. note:: If you changed the default Fuel root password, add the
64 ``--fuel-password YOUR_PASSWORD`` flag to the script command.
65
66About the fuel-mirror script
67~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
69The ``fuel-mirror`` script provided with the ``fuel-mirror`` package enables
70you to modify the Fuel repository sources through the Fuel CLI.
71
72* To view help information, type ``fuel-mirror -h``.
73
74* The script supports running behind an HTTP or HTTPS proxy.
75 The following environment variable can be set either
76 system-wide (through ``~/.bashrc``) or in the script configuration file:
77
78 .. code-block:: console
79
80 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 9ea7206..d9af22a 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.
21 21
22.. seealso:: 22.. seealso::
23 23
24 - :ref:`upgrade_local_repo` 24 - :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 ef1666b..0000000
--- a/userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst
+++ /dev/null
@@ -1,77 +0,0 @@
1.. _upgrade_local_repo:
2
3Set up a local repository
4-------------------------
5
6Fuel downloads the OpenStack and operating system packages
7from the predefined repositories on the Fuel Master node.
8If your Fuel Master node does not have an Internet connection,
9you must configure a local repository mirror with the required
10packages and configure Fuel to use this repository.
11
12You can set up a local repository in the Fuel web UI
13or through Fuel CLI using the ``fuel-createmirror`` script.
14
15**To set up a local repository in the Fuel web UI**
16
17#. In the Fuel web UI, navigate to the :guilabel:`Settings` tab
18 and then scroll down to the :guilabel:`Repositories` section.
19#. Change the path under :guilabel:`URI`.
20
21**To set up a local repository with the ``fuel-createmirror`` script**
22
23#. Log in to the Fuel Master node CLI.
24#. Run the ``fuel-createmirror`` script:
25
26 * If you use the default Fuel root password, type:
27
28 ::
29
30 fuel-createmirror
31
32 * If you change the default Fuel root password, type:
33
34 ::
35
36 fuel-createmirror --password PASSWORD
37
38#. Restart the docker daemon
39
40 ::
41
42 service docker restart
43
44 Alternatively (recommended), reboot the Fuel Master node.
45
46About the fuel-createmirror script
47++++++++++++++++++++++++++++++++++
48
49The ``fuel-createmirror`` is a built-in Fuel script that enables
50you to modify the Fuel repository sources from the CLI.
51
52* The script supports only RSYNC mirrors.
53 See the `the list of official upstream Ubuntu mirrors <https://launchpad.net/ubuntu/+archivemirrors>`_.
54
55* The script uses a Docker container with Ubuntu to support dependencies
56 resolution.
57
58* To view help information, type ``fuel-createmirror -h``.
59
60* The script supports running behind an HTTP proxy configured to
61 Port 873 (rsync). The following environment variables can be set either
62 system-wide (via ~/.bashrc), or in the script configuration file:
63
64 ::
65
66 http_proxy=http://username:password@host:port/
67 RSYNC_PROXY=username:password@host:port
68
69* You can also configure Docker to use the proxy to download the Ubuntu
70 image needed to resolve the packages dependencies. Add the environment
71 variables to the `/etc/sysconfig/docker` file, and export them:
72
73 ::
74
75 http_proxy=http://username:password@host:port/
76 RSYNC_PROXY=username:password@host:port
77 export http_proxy RYSNC_PROXY
diff --git a/userdocs/fuel-install-guide/upgrade_intro.rst b/userdocs/fuel-install-guide/upgrade_intro.rst
index f5ab54c..08c52e4 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.
14 14
15 upgrade/upgrade-internals 15 upgrade/upgrade-internals
16 upgrade/upgrade-liberty 16 upgrade/upgrade-liberty
17 upgrade/upgrade-local-repo
18 17
19.. note:: Fuel does not support upgrades for plugins. The old plugin 18.. note:: Fuel does not support upgrades for plugins. The old plugin
20 versions may not be compatible with the new version of Fuel. 19 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 2ab35c2..016472c 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.
31 packages required to install and update Fuel and OpenStack 31 packages required to install and update Fuel and OpenStack
32 components. If you do not have an Internet connection, you can 32 components. If you do not have an Internet connection, you can
33 set up a local repository and provide the URL to the repository on 33 set up a local repository and provide the URL to the repository on
34 this page. 34 this page. For details, see: :ref:`local-repo`.
35 Kernel parameters 35 Kernel parameters
36 Enables you to modify kernel parameters. This field does not set 36 Enables you to modify kernel parameters. This field does not set
37 kernel parameters for the Fuel Master node or for nodes that have 37 kernel parameters for the Fuel Master node or for nodes that have