Mirantis Fuel 5.1 开发与用户指南

需积分: 9 93 浏览量更新于2024-07-21 收藏 5.36MB PDF 举报

"fuel5.1文档是OpenStack Fuel的官方文档，主要涵盖了Fuel的架构、运行流程、开发流程等详细信息。文档由Mirantis在2012年至2014年间编写，最后一次更新日期为2014年12月31日。" OpenStack Fuel是一个用于部署和管理OpenStack云环境的工具，它简化了OpenStack组件的配置和更新过程。Fuel Master Node是Fuel部署的核心，负责协调和管理其他节点的部署工作。 **Fuel架构** Fuel架构由多个组成部分构成，主要包括： 1. **Fuel Master Node**: 这是整个部署环境的控制中心，负责执行所有配置任务，包括网络配置、身份管理、存储设置等。 2. **Fuel Agents**: 在被管理的节点上运行，接收并执行Fuel Master Node发送的配置指令。 3. **Nailgun**: Nailgun是Fuel的Web界面后端，用于处理API请求，管理OpenStack部署流程。 4. **Astute**: 负责监控和通信，确保Fuel Master Node与被管理节点之间的数据传输和状态同步。 **运行步骤** 在部署OpenStack环境时，通常遵循以下步骤： 1. **初始化Fuel Master Node**: 设置网络，安装Fuel软件，并进行必要的配置。 2. **添加节点**: 将服务器添加到Fuel环境中，指定它们的角色（如计算节点、控制节点、网络节点等）。 3. **网络配置**: 配置OpenStack环境所需的网络拓扑，如Flat、VLAN或Neutron网络。 4. **部署OpenStack**: 根据预设的配置选项，Fuel Master Node将引导被管理节点通过PXE（预启动执行环境）安装OpenStack组件。 5. **健康检查**: 使用OpenStack测试框架（OSTF）进行健康检查，验证环境的正确性和稳定性。 **开发流程** 对于开发者，Fuel提供了快速入门指南和示例模块，帮助他们了解如何参与Fuel的开发： 1. **Fuel Development Quick-Start**: 提供了如何开始修改和扩展Fuel的指导。 2. **Fuel Development Examples**: 示例模块展示了如何创建和测试新功能。 3. **Fuel Development Environment**: 描述了搭建开发环境的步骤，包括系统测试。 4. **Fuel Development on Live Master Node**: 如何在实际的Fuel Master Node上进行开发。此外，文档还包含了关于使用Fuel settings、避免资源重复和文件冲突、 Puppet模块的封装、变量作用域和 Puppet配置等内容的指南。对于贡献者，还有一份Health Check (OSTF) Contributor's Guide，以及用户指南和Devops Guide，这些内容旨在帮助用户和开发者更好地理解和使用Fuel。 **用户指南** 用户指南涵盖了OpenStack Fuel的安装、配置和环境创建，特别提到了Sahara和Murano测试的重要注意事项。同时，文档还介绍了如何多次运行单个OSTF测试以及Fuel ISO构建系统，包括快速开始、构建系统结构、目标、自定义构建过程及其他选项。 Fuel5.1文档是全面了解和操作OpenStack Fuel的宝贵资源，无论是对初次接触的用户还是经验丰富的开发者，都能从中获得有价值的信息。

sudo apt-get install make postgresql postgresql-server-dev-9.1

sudo apt-get install python-dev python-pip python-virtualenv

Now you can create the virtual environment and activate it.

virtualenv fuel-web-venv

. virtualenv/bin/activate

And then install the dependencies.

pip install ./shotgun

pip install -r nailgun/test-requirements.txt

Now you can look at the list of available formats and generate the one you need:

cd docs

make help

make html

There is a helper script build-docs.sh. It can perform all the required steps automatically. The script

can build documentation in required format.

Documentation build helper

-o - Open generated documentation after build

-c - Clear the build directory

-n - Don't install any packages

-f - Documentation format [html,signlehtml,latexpdf,pdf,epub]

For example, if you want to build HTML documentation you can just use the following script, like this:

./build-docs.sh -f html -o

It will create virtualenv, install the required dependencies and build the documentation in HTML

format. It will also open the documentation with your default browser.

If you don't want to install all the dependencies and you are not interested in building automatic API

documentation there is an easy way to do it.

First remove autodoc modules from extensions section of conf.py file in the docs directory. This

section should be like this:

extensions = [

'rst2pdf.pdfbuilder',

'sphinxcontrib.plantuml',

]

Then remove develop/api_doc.rst file and reference to it from develop.rst index.

Now you can build documentation as usual using make command. This method can be useful if you

want to make some corrections to text and see the results without building the entire environment.

The only Python packages you need are Sphinx packages:

Sphinx

sphinxcontrib-actdiag

sphinxcontrib-blockdiag

sphinxcontrib-nwdiag

sphinxcontrib-plantuml

sphinxcontrib-seqdiag

Just don't forget to rollback all these changes before you commit your corrections.

System Tests

To include documentation on system tests, SYSTEM_TESTS_PATH environment variable should be set

before running sphinx-build or make.

Table of contents

Fuel Development Environment on Live Master Node

If you need to deploy your own developer version of FUEL on live Master Node, you will need to use

the helper script, fuel-web/fuel_development/manage.py. The helper script configures development

environment on masternode, deploys code or restores the production environment.

Help information about manage.py can be found by running it with the '-h' parameter.

Nailgun Developer Version on Live Master Node

Configure the Nailgun development environment by following the instructions: Nailgun Dev

Environment

In your local fuel-web repository run:

workon fuel

cd fuel_development

python manage.py -m MASTER.NODE.ADDRESS nailgun deploy

Nailgun source code will be deployed, all required packages will be installed, required services will be

reconfigured and restarted. After that, developer version of Nailgun can be accessed.

For deploying Nailgun source code only without reconfiguring services run:

python manage.py -m MASTER.NODE.ADDRESS nailgun deploy --synconly

For restoring production version of Nailgun run:

python manage.py -m MASTER.NODE.ADDRESS nailgun revert

If you need to add a new python package or use another version of the python package, make

appropriate changes in the nailgun/requirements.txt file and run:

python manage.py -m MASTER.NODE.ADDRESS nailgun deploy

Nailgun

Nailgun Development Instructions

Setting up Environment

For information on how to get source code see Getting the Source Code.

Preparing Development Environment

Warning

Nailgun requires Python 2.6. with development files. Please check installed Python version using

python€--version. If the version check does not match, you can use PPA (Ubuntu) or pyenv

(Universal)

For PPA:

sudo add-apt-repository ppa:fkrull/deadsnakes

sudo apt-get install python2.6 python2.6-dev

1. Nailgun can be found in fuel-web/nailgun

2. Install and configure PostgreSQL database:

sudo apt-get install postgresql postgresql-server-dev-9.1

sudo -u postgres createuser -SDRP nailgun # enter password "nailgun"

sudo -u postgres createdb nailgun

Table of contents

3. Install pip and development tools:

sudo apt-get install python-dev python-pip

4. Install virtualenv. This is an optional step that increases flexibility when dealing with environment

settings and package installation:

sudo pip install virtualenv virtualenvwrapper

source /usr/local/bin/virtualenvwrapper.sh # you can save this to .bashrc

mkvirtualenv fuel # you can use any name instead of 'fuel'

workon fuel # command selects the particular environment

5. Install Python dependencies. This section assumes that you use virtual environment. Otherwise,

you must install all packages globally. You can install pip and use it to require all the other

packages at once.:

pip install ./shotgun # this fuel project is listed in setup.py requirements

pip install --allow-all-external -r nailgun/test-requirements.txt

6. Create required folder for log files:

sudo mkdir /var/log/nailgun

sudo chown -R `whoami`.`whoami` /var/log/nailgun

Setup for Nailgun Unit Tests

1. Nailgun unit tests use Tox for generating test environments. This means that you don't need to

install all Python packages required for the project to run them, because Tox does this by itself.

2. First, create a virtualenv the way it's described in previous section. Then, install the Tox package:

pip install tox

3. Run the Nailgun backend unit tests:

./run_tests.sh --no-lint-ui --no-webui

4. Run the Nailgun flake8 test:

./run_tests.sh --flake8

5. You can also run the same tests by hand, using tox itself:

cd nailgun

tox -epy26 -- -vv nailgun/test

tox -epep8

6. Tox reuses the previously created environment. After making some changes with package

dependencies, tox should be run with -r option to recreate existing virtualenvs:

tox -r -epy26 -- -vv nailgun/test

tox -r -epep8

Setup for Web UI Tests

1. Install NodeJS and JS dependencies:

sudo apt-get remove nodejs nodejs-legacy

sudo apt-get install software-properties-common

sudo add-apt-repository ppa:chris-lea/node.js

sudo apt-get update

sudo apt-get install nodejs

sudo npm install -g grunt-cli

cd nailgun

npm install

2. Install CasperJS:

Table of contents

sudo npm install -g phantomjs

cd ~

git clone git://github.com/n1k0/casperjs.git

cd casperjs

git checkout tags/1.0.0-RC4

sudo ln -sf `pwd`/bin/casperjs /usr/local/bin/casperjs

3. Run full Web UI test suite (this will wipe your Nailgun database in PostgreSQL):

cd fuel-web

./run_tests.sh --lint-ui

./run_tests.sh --webui

Running Nailgun in Fake Mode

1. Fetch JS dependencies:

cd nailgun

npm install

grunt bower

2. Populate the database from fixtures:

./manage.py syncdb

./manage.py loaddefault # It loads all basic fixtures listed in settings.yaml

./manage.py loaddata nailgun/fixtures/sample_environment.json # Loads fake nodes

3. Start application in "fake" mode, when no real calls to orchestrator are performed:

python manage.py run -p 8000 --fake-tasks | egrep --line-buffered -v '^$|HTTP' >> /var/log/nailgun.log 2>&1 &

4. (optional) You can also use --fake-tasks-amqp option if you want to make fake environment use

real RabbitMQ instead of fake one:

python manage.py run -p 8000 --fake-tasks-amqp | egrep --line-buffered -v '^$|HTTP' >> /var/log/nailgun.log 2>&1 &

5. (optional) To create a compressed version of UI and put it into static_compressed dir:

grunt build --static-dir=static_compressed

Note: Diagnostic Snapshot is not available in a Fake mode.

Running the Fuel System Tests

For fuel-devops configuration info please refer to Devops Guide article.

1. Run the integration test:

cd fuel-main

make test-integration

2. To save time, you can execute individual test cases from the integration test suite like this (nice

thing about TestAdminNode is that it takes you from nothing to a Fuel master with 9 blank nodes

connected to 3 virtual networks):

cd fuel-main

export PYTHONPATH=$(pwd)

export ENV_NAME=fuelweb

export PUBLIC_FORWARD=nat

export ISO_PATH=`pwd`/build/iso/fuelweb-centos-6.5-x86_64.iso

./fuelweb_tests/run_tests.py --group=test_cobbler_alive

3. The test harness creates a snapshot of all nodes called 'empty' before starting the tests, and

creates a new snapshot if a test fails. You can revert to a specific snapshot with this command:

dos.py revert --snapshot-name <snapshot_name> <env_name>

4. To fully reset your test environment, tell the Devops toolkit to erase it:

Table of contents

dos.py list

dos.py erase <env_name>

Fuel UI Internationalization Guidelines

Fuel UI internationalization is done using i18next library. Please read i18next documentation first.

All translations are stored in nailgun/static/i18n/translation.json

If you want to add new strings to the translations file, follow these rules:

1. Use words describing placement of strings like "button", "title", "summary", "description", "label"

and place them at the end of the key (like "apply_button", "cluster_description", etc.). One-word

strings may look better without any of these suffixes.

2. Do NOT use shortcuts ("bt" instead of "button", "descr" instead of "description", etc.)

3. Nest keys if it makes sense, for example, if there are a few values for statuses, etc.

4. If some keys are used in a few places (for example, in utils), move them to "common.*"

namespace.

5. Use defaultValue ONLY with dynamically generated keys.

Validating translations

To search for absent and unnecessary translation keys you can perform the following steps:

1. Open terminal and cd to fuel-web/nailgun directory.

2. Run "grunt i18n:validate" to start the validation. If there are any mismatches, you'll see the list of

mismatching keys.

Grunt task "i18n:validate" has one optional argument - a comma-separated list of languages to

compare with base English en-US translations. Run "grunt i18n:validate:zh-CN" to perform comparison

only between English and Chinese keys. You can also run "grunt i18n:validate:zh-CN,ru-RU" to

perform comparison between English-Chinese and English-Russian keys.

Nailgun database migrations

Nailgun uses Alembic (http://alembic.readthedocs.org/en/latest/) for database migrations, allowing

access to all common Alembic commands through "python manage.py migrate"

This command creates DB tables for Nailgun service:

python manage.py syncdb

This is done by applying one by one a number of database migration files, which are located in

nailgun/nailgun/db/migration/alembic_migrations/versions. This command does not create

corresponding DB tables unless you created another migration file or updated an existing one, even if

you're making some changes in SQLAlchemy models or creating the new ones. A new migration file

can be generated by running:

python manage.py migrate revision -m "Revision message" --autogenerate

There are two important points here:

1. This command always creates a "diff" between the current database state and the one

described by your SQLAlchemy models, so you should always run "python manage.py

syncdb" before this command. This prevents running the migrate command with an empty

database, which would cause it to create all tables from scratch.

2. Some modifications may not be detected by "--autogenerate", which require manual addition

to the migration file. For example, adding a new value to ENUM field is not detected.

After creating a migration file, you can upgrade the database to a new state by using this command:

python manage.py migrate upgrade +1

Table of contents

剩余104页未读，继续阅读

有金

粉丝: 16
资源: 7

Mirantis Fuel 5.1 开发与用户指南

Mirantis Fuel 6.1官方中文版文档

SW_Fuel_Gauge_User_Guide

使用Fuel轻松安装OpenStack：图文教程

Mediatek SW Fuel Gauge 用户指南：精度与客制化

实验室设备管理系统 SSM毕业设计 附带论文.zip

PPT高效插件神器推荐-最新发布.zip

数据中心机房基础设计及规划方案.pdf

Visio软件全套资源及教程-最新发布.zip

2000-2022年中国地级市生态韧性数据集（含原始数据、计算代码及结果，最新）.zip

Spring Cloud 配置相关项目.zip

最新资源

实验室设备管理系统 SSM毕业设计附带论文.zip