From 339adc3e7997746d0b73ce975649039a7135c73f Mon Sep 17 00:00:00 2001 From: Pavel Lechenko Date: Thu, 1 Aug 2013 02:34:59 +0400 Subject: [PATCH] got rid of sphinx warnings --- 0020-about-fuel.rst | 2 +- 0050-installation-fuel-cli.rst | 12 +-- 0058-advanced-configuration.rst | 2 + .../config.sh | 0 conf.py | 2 +- contents.rst | 3 +- .../0080-testing-openstack.rst | 87 +++++++++++++------ pages/installation-fuel-ui/install.rst | 4 +- 8 files changed, 72 insertions(+), 40 deletions(-) rename {pages/installation-fuel-ui => _static}/config.sh (100%) diff --git a/0020-about-fuel.rst b/0020-about-fuel.rst index 11d74b73c..9392560ef 100644 --- a/0020-about-fuel.rst +++ b/0020-about-fuel.rst @@ -6,7 +6,7 @@ About Fuel .. _contents:: :local: -.. _include:: /pages/about-fuel/0010-introduction.rst +.. include: /pages/about-fuel/0010-introduction.rst .. include:: /pages/about-fuel/0020-what-is-fuel.rst .. include:: /pages/about-fuel/0030-how-it-works.rst .. include:: /pages/about-fuel/0040-reference-topologies.rst diff --git a/0050-installation-fuel-cli.rst b/0050-installation-fuel-cli.rst index 0bfa0c998..c4a41aa47 100644 --- a/0050-installation-fuel-cli.rst +++ b/0050-installation-fuel-cli.rst @@ -6,13 +6,13 @@ Deploy an OpenStack cluster using Fuel CLI ========================================== -.. _contents:: :local: +.. contents: :local: -.. _include:: /pages/installation-fuel-cli/0000-preamble.rst -.. _include:: /pages/installation-fuel-cli/0010-introduction.rst -.. _include:: /pages/installation-fuel-cli/0015-before-you-start.rst -.. _include:: /pages/installation-fuel-cli/0020-machines.rst -.. _include:: /pages/installation-fuel-cli/0057-prepare-for-deployment.rst +.. include: /pages/installation-fuel-cli/0000-preamble.rst +.. include: /pages/installation-fuel-cli/0010-introduction.rst +.. include: /pages/installation-fuel-cli/0015-before-you-start.rst +.. include: /pages/installation-fuel-cli/0020-machines.rst +.. include: /pages/installation-fuel-cli/0057-prepare-for-deployment.rst .. include:: /pages/installation-fuel-cli/0060-understand-the-manifest.rst .. include:: /pages/installation-fuel-cli/0070-orchestration.rst .. include:: /pages/installation-fuel-cli/0080-testing-openstack.rst diff --git a/0058-advanced-configuration.rst b/0058-advanced-configuration.rst index ef9c9bdde..197c1d190 100644 --- a/0058-advanced-configuration.rst +++ b/0058-advanced-configuration.rst @@ -1,3 +1,5 @@ +:orphan: + .. index:: Advanced Topics .. _Advanced: diff --git a/pages/installation-fuel-ui/config.sh b/_static/config.sh similarity index 100% rename from pages/installation-fuel-ui/config.sh rename to _static/config.sh diff --git a/conf.py b/conf.py index e1a9dfdfe..a0c332eb1 100644 --- a/conf.py +++ b/conf.py @@ -128,7 +128,7 @@ html_logo = '_static/fuel_gradient_200.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = '_static/mirantis_icon.png' +html_favicon = '_static/mirantis_icon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/contents.rst b/contents.rst index a856f7130..fb6943a44 100644 --- a/contents.rst +++ b/contents.rst @@ -6,11 +6,10 @@ Table of Contents ================= -.. toctree:: Table of Contents +.. toctree:: :maxdepth: 2 index - 0010-package-contents 0020-about-fuel 0030-release-notes 0040-reference-architecture diff --git a/pages/installation-fuel-cli/0080-testing-openstack.rst b/pages/installation-fuel-cli/0080-testing-openstack.rst index 4a1e6ffb4..4018654e7 100644 --- a/pages/installation-fuel-cli/0080-testing-openstack.rst +++ b/pages/installation-fuel-cli/0080-testing-openstack.rst @@ -1,49 +1,80 @@ Testing OpenStack ----------------- -Now that you've installed OpenStack, its time to take your new openstack cloud for a drive around the block. Follow these steps: +Now that you've installed OpenStack, its time to take your new OpenStack cloud +for a drive around the block. Follow these steps: -#. On the host machine, open your browser to +1. On the host machine, open your browser to http://192.168.0.10/ (change the + IP address value to your own ``public_virtual_ip``) and login as ``nova/nova`` + (unless you changed these credentials in ``site.pp``) - http://192.168.0.10/ (Adjust this value to your own ``public_virtual_ip``.) +2. Click the ``Project`` tab in the left-hand column. - and login as nova/nova (unless you changed this information in ``site.pp``) +3. Under ``Manage Compute``, choose ``Access & Security`` to set security settings: -#. Click the Project tab in the left-hand column. +- Click ``Create Keypair`` and enter a name for the new keypair. The + private key should download automatically; make sure to keep it safe. -#. Under Manage Compute, choose Access & Security to set security settings: +- Click ``Access & Security`` again and click ``Edit Rules`` for the + default Security Group. - #. Click Create Keypair and enter a name for the new keypair. The private key should download automatically; make sure to keep it safe. - #. Click Access & Security again and click Edit Rules for the default Security Group. Add a new rule allowing TCP connections from port 22 to port 22 for all IP addresses using a CIDR of 0.0.0.0/0. (You can also customize this setting as necessary.) Click Add Rule to save the new rule. - #. Add a second new rule allowing ICMP connections with a type and code of -1 to the default Security Group and click Add Rule to save. +- Add a new rule allowing TCP connections from + port 22 to port 22 for all IP addresses using a CIDR of 0.0.0.0/0. + (You can also customize this setting as necessary.) -#. Click Allocate IP To Project and add two new floating ips. Notice that they come from the pool specified in ``config.yaml`` and ``site.pp``. +- Click ``Add Rule`` to save the new rule. +- Add a second new rule allowing ICMP connections with a type and code of + -1 to the default Security Group and click ``Add Rule`` to save. -#. Click Images & Snapshots, then Create Image. Enter a name and specify the Image Location as https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img, with a Format of QCOW2. Check the Public checkbox. +4. Click ``Allocate IP To Project`` and add two new floating IPs. Notice that + they come from the pool specified in ``config.yaml`` and ``site.pp``. -#. The next step is to upload an image to use for creating VMs, but an OpenStack bug prevents you from doing this in the browser. Instead, log in to any of the controllers as root and execute the following commands:: +5. Click ``Images & Snapshots``, then ``Create Image``. - cd ~ - source openrc - glance image-create --name cirros --container-format bare --disk-format qcow2 --is-public yes --location https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img +- Enter a name and specify the ``Image Location`` as + https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img, + with a ``Format`` of ``QCOW2``. Check the ``Public`` checkbox. -#. Go back to the browser and refresh the page. Launch a new instance of this image - using the tiny flavor. Click the Networking tab and choose the default ``net04_ext`` network, then click the Launch button. +6. The next step is to upload an image to use for creating VMs, but an OpenStack + bug prevents you from doing this in the browser. Instead, log in to any of + the controllers as ``root`` and execute the following commands:: -#. On the instances page: + cd ~ + source openrc + glance image-create --name cirros --container-format bare --disk-format qcow2 --is-public yes --location https://launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img - #. Click the new instance and look at the settings. - #. Click the Logs tab to look at the logs. - #. Click the VNC tab to log in. If you see just a big black rectangle, the machine is in screensaver mode; click the grey area and press the space bar to wake it up, then login as ``cirros/cubswin:)``. - #. At the command line, enter ``ifconfig -a | more`` and see the assigned ip address. - #. Enter ``sudo fdisk -l`` to see that no volume has yet been assigned to this VM. +7. Go back to the browser and refresh the page. Launch a new instance of this image + using the tiny flavor. Click the ``Networking`` tab and choose the default + ``net04_ext`` network, then click the Launch button. -#. On the Instances page, click Assign Floating IP and assign an IP address to your instance. You can either choose from one of the existing created IPs by using the pulldown menu or click the plus sign (+) to choose a network and allocate a new IP address. - #. From your host machine, ping the floating ip assigned to this VM. - #. If that works, try to ``ssh cirros@floating-ip`` from the host machine. +8. On the instances page: -#. Back in the browser, click Volumes and Create Volume. Create the new volume, and attach it to the instance. -#. Go back to the VNC tab and repeat ``fdisk -l`` to see the new unpartitioned disk attached. +- Click the new instance and look at the settings. + +- Click the ``Logs`` tab to look at the logs. + +- Click the ``VNC`` tab to log in. If you see just a big black rectangle, the + machine is in screensaver mode; click the grey area and press the space + bar to wake it up, then login as ``cirros/cubswin:)``. + +- At the command line, enter ``ifconfig -a | more`` and see the assigned IP address. + +- Enter ``sudo fdisk -l`` to see that no volume has yet been assigned to this VM. + +9. On the ``Instances`` page, click ``Assign Floating IP`` and assign an IP + address to your instance. You can either choose from one of the existing + created IPs by using the pulldown menu or click the plus sign (+) to choose + a network and allocate a new IP address. + +- From your host machine, ping the floating IP assigned to this VM. + +- If that works, try to ``ssh cirros@floating-ip`` from the host machine. + +10. Back in the browser, click ``Volumes`` and ``Create Volume``. Create the + new volume, and attach it to the instance. + +11. Go back to the VNC tab and repeat ``fdisk -l`` to see the new unpartitioned + disk attached. Now your new VM is ready to be used. \ No newline at end of file diff --git a/pages/installation-fuel-ui/install.rst b/pages/installation-fuel-ui/install.rst index b8e7094c1..8b0b85bda 100644 --- a/pages/installation-fuel-ui/install.rst +++ b/pages/installation-fuel-ui/install.rst @@ -95,7 +95,7 @@ When you unpack the scripts, you will see the following important files and fold Here is the example config file, with the values that you can adjust: -.. literalinclude:: config.sh +.. literalinclude:: /_static/config.sh :language: bash :linenos: @@ -178,7 +178,7 @@ It is still possible to configure other interfaces, or add 802.1Q subinterfaces to the Fuel to be able to access it from office network if required. It is easy to do via standard network configuration scripts for CentOS. When the installation is complete, you can modify -``/etc/sysconfig/network-scripts/ifcfg-eth* `` scripts. For example, if *eth1* +``/etc/sysconfig/network-scripts/ifcfg-eth\*`` scripts. For example, if *eth1* interface is on the L2 network which is planned for PXE booting, and *eth2* is the interface connected to office network switch, *eth0* is not in use, then settings can be the following: