Browse Source

Merge "[Install Guide] Replace fuel-createmirror with fuel-mirror"

Jenkins 2 years ago
parent
commit
d97307f6e8

+ 1
- 0
userdocs/fuel-install-guide.rst View File

@@ -11,6 +11,7 @@ Fuel Installation Guide
11 11
    fuel-install-guide/sysreq_intro
12 12
    fuel-install-guide/install_install_fuel
13 13
    fuel-install-guide/bootstrap_intro
14
+   fuel-install-guide/local-repo
14 15
    fuel-install-guide/plugins_intro
15 16
    fuel-install-guide/vsphere_intro
16 17
    fuel-install-guide/update-fuel

+ 2
- 2
userdocs/fuel-install-guide/install/install_set_up_fuel.rst View File

@@ -98,11 +98,11 @@ settings and proceed to :ref:`install_install_fuel_master_node`.
98 98
    |                                      | repository field. To configure   |
99 99
    |                                      | the Ubuntu repository mirror     |
100 100
    |                                      | on a local host, use the         |
101
-   |                                      | ``fuel-createmirror`` script     |
101
+   |                                      | ``fuel-mirror`` script           |
102 102
    |                                      | shipped with the Fuel ISO.       |
103 103
    |                                      |                                  |
104 104
    |                                      | For more information, see:       |
105
-   |                                      | :ref:`upgrade_local_repo`.       |
105
+   |                                      | :ref:`local-repo`.               |
106 106
    +--------------------------------------+----------------------------------+
107 107
    | 7. Configure the network time        | To avoid issues with the time    |
108 108
    |    protocol.                         | settings inconsistency on the    |

+ 2
- 2
userdocs/fuel-install-guide/intro/intro_install_overview.rst View File

@@ -13,7 +13,7 @@ requirements and sequence of tasks that you must complete.
13 13
 #. Verify that your environment meets the recommendations in
14 14
    :ref:`System requirements <sysreq_intro>`.
15 15
 
16
-#. Verify your hardware using the 
16
+#. Verify your hardware using the
17 17
    :ref:`Hardware checklist <preinstall_chklist_hardware_checklist>`.
18 18
 
19 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 22
    * If the server does not have an Internet
23 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 26
 #. If you plan to install Fuel on VMware vSphere, verify that your environment
27 27
    meets the :ref:`VMware vSphere prerequisites <vsphere_intro>`

+ 80
- 0
userdocs/fuel-install-guide/local-repo.rst View File

@@ -0,0 +1,80 @@
1
+.. _local-repo:
2
+
3
+=========================
4
+Set up a local repository
5
+=========================
6
+
7
+Fuel downloads the OpenStack and operating system packages
8
+from the predefined repositories on the Fuel Master node.
9
+If your Fuel Master node does not have an Internet connection,
10
+you must configure a local repository mirror with the required
11
+packages and configure Fuel to use this repository. This
12
+configuration 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
+
66
+About the fuel-mirror script
67
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
+
69
+The ``fuel-mirror`` script provided with the ``fuel-mirror`` package enables
70
+you 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/

+ 1
- 1
userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst View File

@@ -21,4 +21,4 @@ node.
21 21
 
22 22
 .. seealso::
23 23
 
24
-    - :ref:`upgrade_local_repo`
24
+    - :ref:`local-repo`

+ 0
- 77
userdocs/fuel-install-guide/upgrade/upgrade-local-repo.rst View File

@@ -1,77 +0,0 @@
1
-.. _upgrade_local_repo:
2
-
3
-Set up a local repository
4
--------------------------
5
-
6
-Fuel downloads the OpenStack and operating system packages
7
-from the predefined repositories on the Fuel Master node.
8
-If your Fuel Master node does not have an Internet connection,
9
-you must configure a local repository mirror with the required
10
-packages and configure Fuel to use this repository.
11
-
12
-You can set up a local repository in the Fuel web UI
13
-or 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
-
46
-About the fuel-createmirror script
47
-++++++++++++++++++++++++++++++++++
48
-
49
-The ``fuel-createmirror`` is a built-in Fuel script that enables
50
-you 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

+ 0
- 1
userdocs/fuel-install-guide/upgrade_intro.rst View File

@@ -14,7 +14,6 @@ This section includes the following topics.
14 14
 
15 15
    upgrade/upgrade-internals
16 16
    upgrade/upgrade-liberty
17
-   upgrade/upgrade-local-repo
18 17
 
19 18
 .. note:: Fuel does not support upgrades for plugins. The old plugin
20 19
           versions may not be compatible with the new version of Fuel.

+ 1
- 1
userdocs/fuel-user-guide/configure-environment/settings.rst View File

@@ -31,7 +31,7 @@ by editing the corresponding configuration files.
31 31
            packages required to install and update Fuel and OpenStack
32 32
            components. If you do not have an Internet connection, you can
33 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 35
           Kernel parameters
36 36
            Enables you to modify kernel parameters. This field does not set
37 37
            kernel parameters for the Fuel Master node or for nodes that have

Loading…
Cancel
Save