├── .gitignore ├── _images ├── title-page.png └── deliverables │ ├── d_install_rpm.png │ ├── scr_fuel_setup.png │ ├── scr_fuel_log_in.png │ ├── scr_change_hostname.png │ ├── scr_change_pass_ui.png │ ├── scr_partition-disks.png │ ├── d_install_w_internet.png │ ├── d_install_wo_internet.png │ ├── scr_plugin_versioning.png │ └── scr_ironic_baremetal_nic_example.png ├── .gitreview ├── devdocs ├── develop │ ├── nailgun.rst │ ├── _images │ │ ├── graph.png │ │ ├── nmanager.png │ │ ├── dependGraph.png │ │ ├── uml │ │ │ ├── astute.png │ │ │ ├── puppetsync.png │ │ │ ├── nailgun-agent.png │ │ │ ├── cluster_deployment.png │ │ │ ├── network_verification.png │ │ │ └── nodes_provisioning.png │ │ ├── dependGraph02.png │ │ ├── plugin_structure.png │ │ ├── granularDeployment.png │ │ └── test_docstring_structure.png │ ├── system_tests │ │ └── tree.rst │ ├── live_masternode.rst │ └── nailgun │ │ ├── tree.rst │ │ └── development │ │ └── ui_dependencies.rst ├── packaging.rst ├── infra.rst └── develop.rst ├── glossary ├── i.rst ├── p.rst ├── e.rst ├── s.rst ├── n.rst ├── d │ ├── deployment-role.rst │ ├── discovery.rst │ ├── deployment-graph-hierarchy.rst │ ├── deployment-graph-rendering.rst │ ├── deployment-group-fault-tolerance.rst │ ├── deployment-task.rst │ ├── deployment-group.rst │ ├── deployment-graph.rst │ └── deployment-pipeline.rst ├── i │ └── inventory.rst ├── glossary.rst ├── d.rst ├── e │ └── environment-release.rst ├── p │ └── provisioning.rst ├── s │ └── serialized-attributes.rst └── n │ ├── nailgun-extension.rst │ └── nailgun-supertask.rst ├── plugindocs ├── fuel-plugin-sdk-guide │ ├── reference │ │ ├── files │ │ │ ├── volumes.rst │ │ │ ├── node_roles.rst │ │ │ ├── components.rst │ │ │ ├── network_roles.rst │ │ │ └── environment_config.rst │ │ └── files.rst │ ├── create-plugin │ │ ├── plugin-repos.rst │ │ ├── plugin-settings │ │ │ └── override-core-settings.rst │ │ ├── plugin-settings.rst │ │ ├── add-driverlog.rst │ │ ├── plugin-node-roles.rst │ │ └── actions-existing-roles │ │ │ └── skip-core-tasks.rst │ ├── reference.rst │ ├── existing-plugins.rst │ ├── limitations.rst │ ├── create-environment │ │ ├── development-requirements.rst │ │ ├── code-style.rst │ │ ├── autotests │ │ │ ├── autotests-workflow.rst │ │ │ └── autotests-files.rst │ │ ├── repository-branching │ │ │ ├── repository-branching-delete.rst │ │ │ └── repository-branching-create.rst │ │ ├── repository-branching.rst │ │ ├── launchpad-project.rst │ │ └── repository-workflow.rst │ ├── requirements.rst │ ├── create-environment.rst │ ├── create-plugin.rst │ ├── introduction.rst │ ├── additional-information.rst │ └── how-plugins-work.rst └── fuel-plugin-sdk-guide.rst ├── requirements.txt ├── _templates ├── openstackdocs │ ├── static │ │ ├── favicon.ico │ │ ├── images │ │ │ ├── loading.gif │ │ │ ├── search-icon.png │ │ │ ├── docs │ │ │ │ ├── license.png │ │ │ │ ├── superuser1.png │ │ │ │ ├── superuser2.png │ │ │ │ ├── superuser3.png │ │ │ │ └── superuser4.png │ │ │ ├── footer-twitter.png │ │ │ ├── footer-youtube.png │ │ │ ├── footer-facebook.png │ │ │ ├── footer-linkedin.png │ │ │ ├── openstack-logo-full.png │ │ │ ├── openstack-logo-vert.png │ │ │ ├── footer-facebook-hover.png │ │ │ ├── footer-linkedin-hover.png │ │ │ ├── footer-twitter-hover.png │ │ │ └── footer-youtube-hover.png │ │ └── js │ │ │ └── doc-characters.json │ ├── localtoc.html │ ├── theme.conf │ ├── license_cc.html │ ├── titlerow.html │ ├── sidebartoc.html │ ├── css.html │ ├── script_search.html │ └── navigation.html └── fuel.style ├── userdocs ├── release-notes │ ├── obtain-product.rst │ ├── new-features │ │ ├── dmz.rst │ │ ├── user-documentation.rst │ │ ├── master-backup-restore.rst │ │ ├── fuel-cli.rst │ │ ├── task-graphs.rst │ │ ├── brute-force.rst │ │ ├── s3-api.rst │ │ ├── snapshots-timmy.rst │ │ ├── fuel-web-ui.rst │ │ └── vmware-certificate.rst │ └── new-features.rst ├── snippets │ └── notes │ │ ├── deprecated-cli-v1.rst │ │ ├── enable-experimental-features.rst │ │ └── fuel2-task-list-filters.rst ├── fuel-install-guide │ ├── sysreq │ │ ├── sysreq_additional_components.rst │ │ ├── sysreq_hw_intro.rst │ │ ├── sysreq_fuel_master_node_network_reqs.rst │ │ ├── sysreq_fuel_master_node_hw_requirements.rst │ │ └── sysreq_storage_reqs.rst │ ├── preinstall_intro.rst │ ├── plugins │ │ ├── plugins_prerequisites.rst │ │ ├── plugins_view_plugins.rst │ │ └── plugins_uninstall_upgrade.rst │ ├── plugins_intro.rst │ ├── vsphere │ │ ├── vsphere_boot_master.rst │ │ ├── vsphere_prereq.rst │ │ ├── vsphere_upload_iso.rst │ │ ├── vsphere_verify_master.rst │ │ ├── vsphere_create_vm.rst │ │ ├── vsphere_mount_iso.rst │ │ ├── vsphere_install_master.rst │ │ ├── vsphere_configure_esxi_networking.rst │ │ └── vsphere_configure_network.rst │ ├── upgrade │ │ ├── upgrade-internals.rst │ │ └── upgrade-liberty.rst │ ├── vsphere_intro.rst │ ├── upgrade_intro.rst │ ├── install │ │ ├── install_download_iso.rst │ │ ├── install_login_fuel_master_node_multiple_nics.rst │ │ └── install_before_you_install_fuel.rst │ ├── intro_fuel_install_intro.rst │ ├── bootstrap_intro.rst │ ├── bootstrap │ │ └── bootstrap_inject_cert.rst │ ├── sysreq_intro.rst │ ├── install_install_fuel.rst │ └── intro │ │ ├── intro_planning_your_environment.rst │ │ └── intro_install_overview.rst ├── fuel-user-guide │ ├── configure-environment │ │ ├── workflows │ │ │ ├── workflows-create.rst │ │ │ └── workflows-create │ │ │ │ ├── examples.rst │ │ │ │ └── examples │ │ │ │ ├── workflows-add-task.rst │ │ │ │ ├── workflows-swap-task.rst │ │ │ │ └── workflows-skip-task.rst │ │ ├── network-templates │ │ │ ├── network-templates-structure │ │ │ │ ├── network_assignment.rst │ │ │ │ ├── nic_mapping.rst │ │ │ │ └── templates_for_node_role.rst │ │ │ ├── network-templates-structure.rst │ │ │ ├── network-templates-delete.rst │ │ │ ├── network-templates-overview.rst │ │ │ ├── network-templates-limitations.rst │ │ │ ├── examples │ │ │ │ └── one-network.rst │ │ │ └── network-templates-examples.rst │ │ ├── dns-ntp-support.rst │ │ ├── change-roles.rst │ │ ├── map-logical-to-physical-nic.rst │ │ ├── enable-usb-discovery.rst │ │ ├── nfv │ │ │ ├── nfv-configure-dpdk-nic.rst │ │ │ └── nfv-configure-sriov-nic.rst │ │ ├── verify-networks.rst │ │ ├── add-label.rst │ │ ├── workflows.rst │ │ ├── network-templates.rst │ │ ├── select-bootable-device.rst │ │ ├── config-drive-format.rst │ │ ├── configure-vmware-vcenter-settings.rst │ │ ├── change-hostname-slave-nodes.rst │ │ └── selectable-offload.rst │ ├── plugins │ │ ├── hot-plugable.rst │ │ ├── plugins_update_userguide.rst │ │ └── plugins_install_userguide.rst │ ├── maintain-environment │ │ ├── rollback-ug.rst │ │ ├── reinstall-node.rst │ │ ├── workflows-manage │ │ │ ├── view-workflows.rst │ │ │ ├── download-workflows.rst │ │ │ ├── delete-workflows.rst │ │ │ ├── upload-workflows.rst │ │ │ ├── download-deployment-info.rst │ │ │ └── run-workflows.rst │ │ ├── remove-node.rst │ │ ├── workflows-manage.rst │ │ ├── redeploy-node.rst │ │ └── rollback-compute-node.rst │ ├── troubleshooting.rst │ ├── post-deployment-conf │ │ ├── lcm-git-repo │ │ │ ├── lcm-prerequisites.rst │ │ │ ├── audit-enforce-changes.rst │ │ │ └── set-up-git-repo.rst │ │ └── modify-os-env-settings.rst │ ├── file-ref │ │ ├── astute-yaml-master.rst │ │ ├── fuel-env-template │ │ ├── settings-yaml.rst │ │ ├── engine-yaml.rst │ │ └── docker-template │ ├── manage-environment │ │ ├── nfv-run │ │ │ ├── nfv-verify.rst │ │ │ ├── nfv-create-sriov-port.rst │ │ │ ├── nfv-associate-floating-ip.rst │ │ │ ├── nfv-launch-vm.rst │ │ │ └── nfv-create-flavor.rst │ │ ├── nfv-run.rst │ │ ├── enable-experimental-features.rst │ │ └── cgroups │ │ │ ├── cgroups-modify-single-node.rst │ │ │ ├── cgroups-modify-multiple-nodes.rst │ │ │ └── cgroups-example.rst │ ├── post-deployment-conf.rst │ ├── introduction.rst │ ├── create-environment │ │ └── change-password.rst │ ├── manage-environment.rst │ ├── create-environment.rst │ ├── install-additional-components │ │ └── sahara-install.rst │ ├── deploy-environment │ │ ├── reset-environment.rst │ │ ├── provision-environment.rst │ │ └── deploy-changes.rst │ ├── install-additional-components.rst │ ├── deploy-environment.rst │ ├── maintain-environment.rst │ ├── verify-environment │ │ ├── run-health-checks.rst │ │ └── troubleshoot-health-checks.rst │ ├── cli │ │ ├── cli_node_group.rst │ │ ├── cli_basic_usage.rst │ │ ├── cli_deploy.rst │ │ ├── cli_network_template.rst │ │ ├── cli_provision.rst │ │ ├── cli_vip.rst │ │ ├── cli_management.rst │ │ ├── cli_change_ip_range.rst │ │ ├── cli_audit_enforce.rst │ │ ├── cli_client_config_file.rst │ │ └── cli_environment.rst │ └── configure-additional-components.rst ├── fuel-install-guide.rst ├── fuel-user-guide.rst └── release-notes.rst ├── setup.cfg ├── tox.ini ├── examples └── network_templates.html ├── setup.py └── index.rst /.gitignore: -------------------------------------------------------------------------------- 1 | plantuml.jar 2 | /_build 3 | /.tox 4 | 5 | -------------------------------------------------------------------------------- /_images/title-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/title-page.png -------------------------------------------------------------------------------- /.gitreview: -------------------------------------------------------------------------------- 1 | [gerrit] 2 | host=review.openstack.org 3 | port=29418 4 | project=openstack/fuel-docs.git 5 | -------------------------------------------------------------------------------- /devdocs/develop/nailgun.rst: -------------------------------------------------------------------------------- 1 | .. _nailgun: 2 | 3 | Nailgun 4 | ======= 5 | 6 | .. toctree:: 7 | nailgun/tree -------------------------------------------------------------------------------- /devdocs/develop/_images/graph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/graph.png -------------------------------------------------------------------------------- /glossary/i.rst: -------------------------------------------------------------------------------- 1 | .. _i: 2 | 3 | = 4 | I 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | i/inventory.rst -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files/volumes.rst: -------------------------------------------------------------------------------- 1 | .. _volumes.yaml: 2 | 3 | volumes.yaml 4 | ============ 5 | -------------------------------------------------------------------------------- /devdocs/develop/_images/nmanager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/nmanager.png -------------------------------------------------------------------------------- /glossary/p.rst: -------------------------------------------------------------------------------- 1 | .. _p: 2 | 3 | = 4 | P 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | p/provisioning.rst -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx==1.3b3 2 | rst2pdf 3 | funcparserlib 4 | webcolors 5 | beautifulsoup4==4.4.0 6 | openstackdocstheme 7 | -------------------------------------------------------------------------------- /_images/deliverables/d_install_rpm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/d_install_rpm.png -------------------------------------------------------------------------------- /_images/deliverables/scr_fuel_setup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_fuel_setup.png -------------------------------------------------------------------------------- /devdocs/develop/_images/dependGraph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/dependGraph.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/astute.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/astute.png -------------------------------------------------------------------------------- /glossary/e.rst: -------------------------------------------------------------------------------- 1 | .. _e: 2 | 3 | = 4 | E 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | e/environment-release.rst -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files/node_roles.rst: -------------------------------------------------------------------------------- 1 | .. _node_roles.yaml: 2 | 3 | node_roles.yaml 4 | =============== 5 | -------------------------------------------------------------------------------- /_images/deliverables/scr_fuel_log_in.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_fuel_log_in.png -------------------------------------------------------------------------------- /devdocs/develop/_images/dependGraph02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/dependGraph02.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/puppetsync.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/puppetsync.png -------------------------------------------------------------------------------- /glossary/s.rst: -------------------------------------------------------------------------------- 1 | .. _s: 2 | 3 | = 4 | S 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | s/serialized-attributes.rst -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files/components.rst: -------------------------------------------------------------------------------- 1 | .. _components.yaml: 2 | 3 | components.yaml 4 | ================ 5 | -------------------------------------------------------------------------------- /_images/deliverables/scr_change_hostname.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_change_hostname.png -------------------------------------------------------------------------------- /_images/deliverables/scr_change_pass_ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_change_pass_ui.png -------------------------------------------------------------------------------- /_images/deliverables/scr_partition-disks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_partition-disks.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/favicon.ico -------------------------------------------------------------------------------- /devdocs/develop/_images/plugin_structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/plugin_structure.png -------------------------------------------------------------------------------- /_images/deliverables/d_install_w_internet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/d_install_w_internet.png -------------------------------------------------------------------------------- /_images/deliverables/d_install_wo_internet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/d_install_wo_internet.png -------------------------------------------------------------------------------- /_images/deliverables/scr_plugin_versioning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_plugin_versioning.png -------------------------------------------------------------------------------- /devdocs/develop/_images/granularDeployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/granularDeployment.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/nailgun-agent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/nailgun-agent.png -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files/network_roles.rst: -------------------------------------------------------------------------------- 1 | .. _network_roles.yaml: 2 | 3 | network_roles.yaml 4 | ================== 5 | -------------------------------------------------------------------------------- /_templates/openstackdocs/localtoc.html: -------------------------------------------------------------------------------- 1 | {%- if display_toc %} 2 |
Contents
3 | {{ toc }} 4 | {%- endif %} 5 | -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/loading.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/loading.gif -------------------------------------------------------------------------------- /devdocs/develop/_images/test_docstring_structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/test_docstring_structure.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/cluster_deployment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/cluster_deployment.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/network_verification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/network_verification.png -------------------------------------------------------------------------------- /devdocs/develop/_images/uml/nodes_provisioning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/devdocs/develop/_images/uml/nodes_provisioning.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/search-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/search-icon.png -------------------------------------------------------------------------------- /glossary/n.rst: -------------------------------------------------------------------------------- 1 | .. _n: 2 | 3 | = 4 | N 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | n/nailgun-extension.rst 11 | n/nailgun-supertask.rst -------------------------------------------------------------------------------- /_images/deliverables/scr_ironic_baremetal_nic_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_images/deliverables/scr_ironic_baremetal_nic_example.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/docs/license.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/docs/license.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-twitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-twitter.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-youtube.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-youtube.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/docs/superuser1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/docs/superuser1.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/docs/superuser2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/docs/superuser2.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/docs/superuser3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/docs/superuser3.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/docs/superuser4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/docs/superuser4.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-facebook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-facebook.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-linkedin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-linkedin.png -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/plugin-repos.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-repos: 2 | 3 | =================== 4 | Plugin repositories 5 | =================== 6 | 7 | TBD -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/openstack-logo-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/openstack-logo-full.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/openstack-logo-vert.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/openstack-logo-vert.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-facebook-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-facebook-hover.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-linkedin-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-linkedin-hover.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-twitter-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-twitter-hover.png -------------------------------------------------------------------------------- /_templates/openstackdocs/static/images/footer-youtube-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/devops/fuel-docs/master/_templates/openstackdocs/static/images/footer-youtube-hover.png -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/plugin-settings/override-core-settings.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _override-core-settings: 3 | 4 | Override core settings 5 | ---------------------- 6 | 7 | TBD -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-reference: 2 | 3 | Reference 4 | ========= 5 | 6 | .. toctree:: 7 | :maxdepth: 3 8 | 9 | reference/files.rst 10 | -------------------------------------------------------------------------------- /devdocs/packaging.rst: -------------------------------------------------------------------------------- 1 | .. _packaging: 2 | 3 | Packaging 4 | ========= 5 | 6 | .. toctree:: 7 | :maxdepth: 3 8 | 9 | packaging/package_versions 10 | packaging/perestroika 11 | -------------------------------------------------------------------------------- /userdocs/release-notes/obtain-product.rst: -------------------------------------------------------------------------------- 1 | ================== 2 | How to obtain Fuel 3 | ================== 4 | 5 | Check for the download link in the 6 | `Releases section of the Fuel Wiki `_. -------------------------------------------------------------------------------- /_templates/openstackdocs/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = basic 3 | stylesheet = css/basic.css 4 | pygments_style = native 5 | 6 | [options] 7 | globaltoc_depth = 6 8 | globaltoc_includehidden = true 9 | analytics_tracking_code = UA-17511903-1 10 | -------------------------------------------------------------------------------- /devdocs/develop/system_tests/tree.rst: -------------------------------------------------------------------------------- 1 | .. _system-tests: 2 | 3 | System Tests 4 | ============ 5 | 6 | To include documentation on system tests, **SYSTEM_TESTS_PATH** 7 | environment variable should be set before running *sphinx-build* or 8 | *make*. 9 | 10 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = fuel-docs 3 | version = 9.0.0 4 | author = OpenStack 5 | author-email = fuel-dev@lists.launchpad.net 6 | 7 | [build_sphinx] 8 | all_files = 1 9 | build-dir = doc/build 10 | source-dir = . 11 | 12 | [wheel] 13 | universal = 1 14 | -------------------------------------------------------------------------------- /glossary/d/deployment-role.rst: -------------------------------------------------------------------------------- 1 | .. deployment-role: 2 | 3 | Deployment role 4 | --------------- 5 | 6 | A high-level entity representing the node's profile; for example, a set of 7 | services provided by a node. The examples of a node's profile are 8 | ``controller``, ``compute``, ``load-balancer``, ``zabbix``. -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | minversion = 1.6 3 | skipsdist = True 4 | 5 | [testenv] 6 | usedevelop = True 7 | install_command = pip install --allow-external -U {opts} {packages} 8 | setenv = VIRTUAL_ENV={envdir} 9 | deps = -r{toxinidir}/requirements.txt 10 | 11 | [testenv:venv] 12 | commands = {posargs:} 13 | -------------------------------------------------------------------------------- /userdocs/snippets/notes/deprecated-cli-v1.rst: -------------------------------------------------------------------------------- 1 | .. caution:: The Fuel command-line interface has been updated. Although old 2 | ``fuel`` commands are still available, we recommend that you use 3 | the new ``fuel2`` commands instead. See 4 | the :ref:`cli_comparison_matrix`. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq/sysreq_additional_components.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_addtional_components: 2 | 3 | Additional components 4 | --------------------- 5 | 6 | If you plan to install additional OpenStack programs, see the system 7 | requirements for additional components: 8 | 9 | * :ref:`sysreq_ironic_prereq` 10 | -------------------------------------------------------------------------------- /glossary/i/inventory.rst: -------------------------------------------------------------------------------- 1 | .. inventory: 2 | 3 | Inventory 4 | --------- 5 | 6 | The process of collecting specific node data; such as hardware 7 | specification, rack location in the data-center, and so on. 8 | 9 | Fuel Nailgun uses the collected data to calculate the values of 10 | serialized attributes; such as partitioning schema. -------------------------------------------------------------------------------- /glossary/d/discovery.rst: -------------------------------------------------------------------------------- 1 | .. discovery: 2 | 3 | Discovery 4 | --------- 5 | 6 | The process of discovering a newly booted node for the Fuel purposes of 7 | provisioning and deployment. 8 | 9 | During discovery, the node registers in the Fuel Nailgun service and receives 10 | an identifier required for the deployment and provisioning phase. -------------------------------------------------------------------------------- /glossary/d/deployment-graph-hierarchy.rst: -------------------------------------------------------------------------------- 1 | .. _deployment-graph-hierarchy: 2 | 3 | Deployment graph hierarchy 4 | -------------------------- 5 | 6 | A sequence in which Fuel processes the deployment graph classes. 7 | The hierarchy of deployment graph classes includes the following levels: 8 | 9 | * ``release`` 10 | * ``plugin`` 11 | * ``cluster`` -------------------------------------------------------------------------------- /devdocs/infra.rst: -------------------------------------------------------------------------------- 1 | .. _infra: 2 | 3 | Fuel Infra configuration 4 | ======================== 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | infra/overview 10 | infra/jenkins_master_deployment 11 | infra/jenkins_slave_deployment 12 | infra/puppet_master_deployment 13 | infra/zabbix_server_deployment 14 | infra/seed_server_deployment 15 | -------------------------------------------------------------------------------- /glossary/d/deployment-graph-rendering.rst: -------------------------------------------------------------------------------- 1 | .. deployment-graph-rendering: 2 | 3 | Deployment graph rendering 4 | -------------------------- 5 | 6 | The process of compilation of the deployment graph. 7 | The process comprises the assignment of deployment tasks to nodes, 8 | computation of the deployment tasks parameters, and resolution of 9 | the deployment tasks dependencies. -------------------------------------------------------------------------------- /glossary/d/deployment-group-fault-tolerance.rst: -------------------------------------------------------------------------------- 1 | .. deployment-group-fault-tolerance: 2 | 3 | Deployment group fault tolerance 4 | -------------------------------- 5 | 6 | An absolute or relative value for the number of nodes of a deployment group 7 | that can fail. The value is useful for the deployment to succeed when a limited 8 | amount of non-critical nodes fails to deploy. -------------------------------------------------------------------------------- /userdocs/snippets/notes/enable-experimental-features.rst: -------------------------------------------------------------------------------- 1 | .. note:: 2 | This feature requires Fuel experimental features mode to be enabled. 3 | If you have not enabled Fuel experimental features 4 | during installation of the Fuel Master node, enable it before you complete 5 | the tasks in this section as described in 6 | :ref:`enable-experimental-features`. 7 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/dmz.rst: -------------------------------------------------------------------------------- 1 | ==================== 2 | Basic DMZ enablement 3 | ==================== 4 | 5 | Implemented the possibility to place public API endpoints and 6 | OpenStack Dashboard into a separate secured network segment 7 | usually called demilitarized zone (DMZ). 8 | 9 | See `blueprint `__ -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/user-documentation.rst: -------------------------------------------------------------------------------- 1 | ================== 2 | User documentation 3 | ================== 4 | 5 | Fuel Newton includes a number of major user documentation updates: 6 | 7 | * :ref:`upgrade_intro` 8 | * :ref:`cli_comparison_matrix` 9 | * :ref:`workflow-intro` 10 | * :ref:`workflows_manage` 11 | * :ref:`create-snapshot` 12 | * :ref:`ug-troubleshooting` -------------------------------------------------------------------------------- /glossary/d/deployment-task.rst: -------------------------------------------------------------------------------- 1 | .. _deployment-task: 2 | 3 | Deployment task 4 | --------------- 5 | 6 | A unit of execution on a node responsible for the configuration and 7 | installation of a particular piece; for example, keystone, database, 8 | bonding configuration, and so on. 9 | 10 | Each deployment task has a set of parameters which specify how and when Fuel 11 | executes the task. -------------------------------------------------------------------------------- /glossary/glossary.rst: -------------------------------------------------------------------------------- 1 | .. _glossary: 2 | 3 | Glossary 4 | ======== 5 | 6 | This glossary is a collection of terms related to OpenStack and Fuel. 7 | The glossary is intended to assist in consistency in usage 8 | of terminology in the Fuel documentation. 9 | 10 | .. toctree:: 11 | :maxdepth: 2 12 | 13 | d.rst 14 | e.rst 15 | i.rst 16 | n.rst 17 | p.rst 18 | s.rst 19 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-reference-files: 2 | 3 | 4 | Files 5 | ===== 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | files/components.rst 11 | files/deployment_tasks.rst 12 | files/environment_config.rst 13 | files/metadata.rst 14 | files/network_roles.rst 15 | files/node_roles.rst 16 | files/volumes.rst 17 | -------------------------------------------------------------------------------- /glossary/d.rst: -------------------------------------------------------------------------------- 1 | .. _d: 2 | 3 | = 4 | D 5 | = 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | d/deployment-graph.rst 11 | d/deployment-graph-hierarchy.rst 12 | d/deployment-graph-rendering.rst 13 | d/deployment-group.rst 14 | d/deployment-group-fault-tolerance.rst 15 | d/deployment-pipeline.rst 16 | d/deployment-role.rst 17 | d/deployment-task.rst 18 | d/discovery.rst -------------------------------------------------------------------------------- /examples/network_templates.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | network_templates 4 | 5 | 6 |

network_templates

7 | default.yaml
8 | one_network.yaml
9 | two_networks.yaml
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /glossary/d/deployment-group.rst: -------------------------------------------------------------------------------- 1 | .. deployment-group: 2 | 3 | Deployment group 4 | ---------------- 5 | 6 | A low-level grouping entity which works as an association between 7 | roles and deployment tasks. Fuel associates each group simultaneously with 8 | a role and a set of tasks. One role may be associated with more than one 9 | deployment group and one deployment group may be associated with several 10 | deployment tasks. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/preinstall_intro.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak oneColumn 4 | 5 | .. _preinstall_intro: 6 | 7 | Pre-installation checklists 8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9 | 10 | Before you install Fuel, verify that you configured your 11 | environment for the installation. 12 | 13 | This section includes the following topics: 14 | 15 | .. toctree:: 16 | :maxdepth: 3 17 | 18 | preinstall/preinstall_hardware_checklist 19 | -------------------------------------------------------------------------------- /devdocs/develop/live_masternode.rst: -------------------------------------------------------------------------------- 1 | Fuel Development Environment on Live Master Node 2 | ================================================ 3 | 4 | If you need to deploy your own developer version of FUEL on live 5 | Master Node, you can use the helper scripts, that are available 6 | in the `fuel-dev-tools ` repository. 7 | 8 | Help information about fuel-dev-tools can be found by running it 9 | with the '-h' parameter. 10 | -------------------------------------------------------------------------------- /glossary/e/environment-release.rst: -------------------------------------------------------------------------------- 1 | .. environment-release: 2 | 3 | .. index:: environment, release, Fuel, MOS, MOM, MCP 4 | 5 | Environment release 6 | ------------------- 7 | 8 | A set of pre-configured parameters applied to an OpenStack environment 9 | from the ``Release`` template. 10 | The ``Release`` template specifies a set of common attributes such as a 11 | repository list, default list of roles, default node partitioning, networks 12 | allocation, and so on. -------------------------------------------------------------------------------- /glossary/p/provisioning.rst: -------------------------------------------------------------------------------- 1 | .. provisioning: 2 | 3 | Provisioning 4 | ------------ 5 | 6 | The process of setting up a node into a minimal viable state with a 7 | pre-installed operating system and required supporting components. 8 | This process includes partitioning, installation of base system, and 9 | preconfiguration of a minimal amount of services and settings that Fuel 10 | requires to be able to manage this node after rebooting it into the 11 | installed system. -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/master-backup-restore.rst: -------------------------------------------------------------------------------- 1 | =================================== 2 | Fuel Master node backup and restore 3 | =================================== 4 | 5 | Added support for the backup and restore of the Fuel Master node features. 6 | You can use the backup archives to restore the Fuel Master node in case 7 | of a hardware failure or other system malfunction. 8 | 9 | See the Fuel User guide: 10 | 11 | * :ref:`back-up-fuel` 12 | * :ref:`restore-fuel` -------------------------------------------------------------------------------- /glossary/s/serialized-attributes.rst: -------------------------------------------------------------------------------- 1 | .. serialized-attributes: 2 | 3 | Serialized attributes 4 | --------------------- 5 | 6 | A large hash of attributes used as input data for deployment tasks. 7 | 8 | Fuel derives the serialized attributes from the user-provided high-level 9 | input. 10 | 11 | Input examples: 12 | 13 | * Common cluster attributes 14 | * Per-node attributes 15 | * Networking configuration 16 | * Node data collected during the inventory phase 17 | * Any third-party configuration -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/plugin-settings.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _plugin-settings: 3 | 4 | Plugin settings 5 | --------------- 6 | 7 | You can add plugin setting to the Fuel web UI, set restrictions, task 8 | conditions, and override the core task settings. 9 | 10 | .. toctree:: 11 | :maxdepth: 3 12 | 13 | plugin-settings/add-settings.rst 14 | plugin-settings/settings-restrictions.rst 15 | plugin-settings/task-conditions.rst 16 | plugin-settings/override-core-settings.rst -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows/workflows-create.rst: -------------------------------------------------------------------------------- 1 | .. _workflow-create: 2 | 3 | Create a custom deployment workflow 4 | =================================== 5 | 6 | You can modify the release workflow configuration by creating a 7 | cluster or plugin workflow with the required changes. 8 | 9 | This section includes the following topics: 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | 14 | workflows-create/structure.rst 15 | workflows-create/examples.rst 16 | -------------------------------------------------------------------------------- /_templates/openstackdocs/license_cc.html: -------------------------------------------------------------------------------- 1 | 2 | Creative Commons Attribution 3.0 License 3 | 4 |

5 | Except where otherwise noted, this document is licensed under 6 | Creative Commons 7 | Attribution 3.0 License. See all 8 | OpenStack Legal Documents. 9 |

10 | -------------------------------------------------------------------------------- /_templates/openstackdocs/static/js/doc-characters.json: -------------------------------------------------------------------------------- 1 | { 2 | "images":[ 3 | { 4 | "image":"superuser1.png", 5 | "caption":"Jesse Proudman" 6 | }, 7 | { 8 | "image":"superuser2.png", 9 | "caption":"Narayan Desai" 10 | }, 11 | { 12 | "image":"superuser3.png", 13 | "caption":"Elissa Murphy" 14 | }, 15 | { 16 | "image":"superuser4.png", 17 | "caption":"Tim Bell" 18 | } 19 | ] 20 | } -------------------------------------------------------------------------------- /glossary/n/nailgun-extension.rst: -------------------------------------------------------------------------------- 1 | .. nailgun-extension: 2 | 3 | Nailgun extension 4 | ----------------- 5 | 6 | An isolated piece of code that you keep in a separate repository and 7 | plug in and out. The Nailgun extension can introduce additional 8 | API handlers, callbacks and embeds itself into the attributes serialization 9 | pipeline. 10 | 11 | You can use the extensions to integrate into the deployment pipeline 12 | third-party services, such as LDAP or your own configuration management 13 | database. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows/workflows-create/examples.rst: -------------------------------------------------------------------------------- 1 | Examples 2 | -------- 3 | 4 | Workflow customization is a powerful mechanism that enables you to 5 | create complex configurations. This section provides examples 6 | of how you can modify a deployment workflow. 7 | 8 | .. toctree:: 9 | :maxdepth: 1 10 | 11 | examples/workflows-add-task.rst 12 | examples/workflows-skip-task.rst 13 | examples/workflows-create-role.rst 14 | examples/workflows-swap-task.rst 15 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/plugins/hot-plugable.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _hot-plugable: 3 | 4 | Installing and Managing Plugins 5 | =============================== 6 | 7 | You can manage your plugins in Fuel web UI on 8 | :guilabel:`Unlock Settings Tab`. 9 | You can install, enable, and update the plugins on an already deployed environment. 10 | You can also change the plugin settings if supported by the plugin. 11 | 12 | .. toctree:: 13 | :maxdepth: 3 14 | 15 | plugins_install_userguide 16 | plugins_update_userguide -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/existing-plugins.rst: -------------------------------------------------------------------------------- 1 | .. _existing-plugins: 2 | 3 | Overview of existing plugins 4 | ============================ 5 | 6 | * `Fuel plugins on GitHub `_ - 7 | contains the source code of Fuel Plugins. 8 | * `DriverLog `_ - 9 | contains the list of plugin maintainers with their contacts, compatible OpenStack releases, 10 | and the CI/CD pipeline. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/rollback-ug.rst: -------------------------------------------------------------------------------- 1 | .. _rollback-ug: 2 | 3 | =============== 4 | Rollback a node 5 | =============== 6 | 7 | You can use the rollback feature to return different OpenStack nodes, such as 8 | compute nodes, Ceph nodes, and others, to their original state. This can be 9 | used to revert changes during a failed upgrade or other malfunction. 10 | 11 | This section includes the following topics: 12 | 13 | .. toctree:: 14 | :maxdepth: 3 15 | 16 | rollback-compute-node.rst -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/add-driverlog.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _add-driverlog: 3 | 4 | Add plugin to DriverLog 5 | ----------------------- 6 | 7 | The DriverLog project provides information about drivers and plugins to 8 | the OpenStack community. 9 | 10 | To make your plugin visible and engage the community, add the plugin to 11 | the DriverLog project. 12 | 13 | For information on how to add your plugin, see the 14 | `DriverLog wiki page `_. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/plugins/plugins_update_userguide.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_update_userguide: 2 | 3 | Update a Fuel plugin 4 | --------------------- 5 | 6 | The update procedure is common for all plugins hosted 7 | in the pre-populated repository. 8 | 9 | **To update a Fuel plugin:** 10 | 11 | #. Run the :command:`yum update` command: 12 | 13 | .. code-block:: console 14 | 15 | yum update 16 | 17 | #. Register the plugin in Nailgun: 18 | 19 | .. code-block:: console 20 | 21 | fuel plugins --sync -------------------------------------------------------------------------------- /glossary/d/deployment-graph.rst: -------------------------------------------------------------------------------- 1 | .. _deployment-graph: 2 | 3 | Deployment graph 4 | ---------------- 5 | 6 | A collection of deployment tasks with their parameters and dependencies 7 | resolved according to the settings of the current deployment. 8 | 9 | Fuel renders each graph from a three-level hierarchical representation of its 10 | class. For example, for basic deployment, the deployment graph class is 11 | ``default``. Fuel builds the deployment graph with respect to the existing 12 | graphs of the default class for plugins as well as for a cluster-specific 13 | graph. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/troubleshooting.rst: -------------------------------------------------------------------------------- 1 | .. _ug-troubleshooting: 2 | 3 | =============== 4 | Troubleshooting 5 | =============== 6 | 7 | This section describes issues and procedures that help to troubleshoot 8 | problems that may occur in Fuel and related components. 9 | 10 | This section includes the following topics: 11 | 12 | .. toctree:: 13 | :maxdepth: 3 14 | 15 | troubleshooting/service-status.rst 16 | troubleshooting/restart-service.rst 17 | troubleshooting/logging.rst 18 | troubleshooting/debug-mode.rst 19 | troubleshooting/network.rst 20 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/plugins/plugins_prerequisites.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_prerequisites: 2 | 3 | Prerequisites 4 | ------------- 5 | 6 | When planning to deploy an environment with Fuel plugins, consider the 7 | following: 8 | 9 | * If you already have an environment that you want to upgrade, see 10 | *Upgrade Fuel*. 11 | * Install plugin on Fuel 6.1 or later. 12 | * Read additional requirements provided by the selected plugin. 13 | 14 | .. seealso:: 15 | 16 | - `Fuel plugins catalog 17 | `__ 18 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/fuel-cli.rst: -------------------------------------------------------------------------------- 1 | =============================== 2 | Fuel CLI versions consolidation 3 | =============================== 4 | 5 | Consolidated two versions of the Fuel CLI ``fuel`` and ``fuel2``. The ``fuel2`` 6 | entry point now provides a complete set of features as well as contains 7 | advanced capabilities and a better structured syntax of commands. The old 8 | Fuel CLI will be deprecated in one of the future releases. 9 | 10 | See :ref:`cli_comparison_matrix` | `blueprint `__ -------------------------------------------------------------------------------- /devdocs/develop.rst: -------------------------------------------------------------------------------- 1 | .. _develop: 2 | 3 | Developer Guide 4 | =============== 5 | 6 | .. toctree:: 7 | :maxdepth: 3 8 | 9 | develop/architecture 10 | develop/sequence 11 | develop/quick_start 12 | develop/addition_examples 13 | develop/env 14 | develop/system_tests/tree 15 | develop/live_masternode 16 | develop/nailgun 17 | develop/module_structure 18 | develop/fuel_settings 19 | develop/puppet_tips 20 | develop/pxe_deployment 21 | develop/ostf_contributors_guide 22 | develop/custom-bootstrap-node 23 | develop/modular-architecture 24 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/plugins_intro.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak oneColumn 4 | 5 | .. _fuel-plugins: 6 | 7 | Fuel Plugins 8 | ~~~~~~~~~~~~ 9 | 10 | You can extend Fuel functionality by installing the plugins 11 | that companies and individual contributors develop for Fuel. 12 | 13 | This section includes the following topics: 14 | 15 | .. toctree:: 16 | :maxdepth: 3 17 | 18 | plugins/plugins_overview 19 | plugins/plugins_prerequisites 20 | plugins/plugins_install_plugins 21 | plugins/plugins_view_plugins 22 | plugins/plugins_uninstall_upgrade 23 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/task-graphs.rst: -------------------------------------------------------------------------------- 1 | ==================================================== 2 | Data-driven workflows for basic environment actions 3 | ==================================================== 4 | 5 | In addition to a node deployment workflow, introduced a capability 6 | to execute workflows for the following basic actions in an environment: 7 | 8 | * Node provisioning 9 | * Node deletion 10 | * Environment verification, that is network configuration check 11 | 12 | See :ref:`workflow-intro` | `blueprint `__ -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo/lcm-prerequisites.rst: -------------------------------------------------------------------------------- 1 | .. _lcm-prerequisites: 2 | 3 | Prerequisites 4 | ============= 5 | 6 | To apply changes using ``.yaml`` files from a Git repository, 7 | your environment must meet the following prerequisites: 8 | 9 | * A Git repository that has a structure similar to the described in 10 | :ref:`repo-structure`. 11 | * The Fuel Master node must have an access to the Git 12 | repository with the structure and to the repository with the Fuel 13 | IaC extension.. 14 | * Your environment must run Mirantis OpenStack 9.2 or later. 15 | 16 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/limitations.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-limitations: 2 | 3 | Limitations 4 | =========== 5 | 6 | * You must install and configure Fuel plugins that affect core functionality 7 | before deploying an OpenStack environment. Otherwise, you will have to 8 | redeploy the environment to enable the core plugin. Application-level 9 | plugins can be installed later on top of the already deployed environments. 10 | * Fuel plugins cannot be upgraded from one major to another major version. 11 | * Fuel plugins for SDN solutions cannot create a new networking option in 12 | the Fuel web UI wizard. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/file-ref/astute-yaml-master.rst: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _astute-yaml-master-ref: 8 | 9 | astute.yaml (Fuel Master node) 10 | ------------------------------ 11 | 12 | Fuel Master Node: 13 | **/etc/fuel/astute.yaml** 14 | 15 | Fuel uses the *astute.yaml* file to pass configuration attributes 16 | to Puppet. 17 | 18 | Usage 19 | +++++ 20 | 21 | The */etc/fuel/astute.yaml* file is installed 22 | on the Fuel Master node 23 | and must not be deleted. 24 | 25 | 26 | File Format 27 | +++++++++++ 28 | 29 | The *xxx.yaml* file 30 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run/nfv-verify.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-verify: 2 | 3 | Verify a virtual instance with accelerated workloads 4 | ---------------------------------------------------- 5 | 6 | After you configured and launched a virtual instance, you can verify 7 | that NFV features are enabled on the machine. 8 | 9 | **To verify a virtual instance with accelerated workloads:** 10 | 11 | #. Log in to the virtual instance CLI using SSH as root. 12 | 13 | Use the floating IP address. 14 | 15 | #. View the information about the CPU architecture: 16 | 17 | :: 18 | 19 | lscpu 20 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide.rst: -------------------------------------------------------------------------------- 1 | .. _fuel-install-guide: 2 | 3 | ======================= 4 | Fuel Installation Guide 5 | ======================= 6 | 7 | .. toctree:: 8 | :maxdepth: 3 9 | 10 | fuel-install-guide/intro_fuel_install_intro 11 | fuel-install-guide/sysreq_intro 12 | fuel-install-guide/install_install_fuel 13 | fuel-install-guide/bootstrap_intro 14 | fuel-install-guide/local-repo 15 | fuel-install-guide/plugins_intro 16 | fuel-install-guide/vsphere_intro 17 | fuel-install-guide/update-fuel 18 | fuel-install-guide/upgrade_intro 19 | fuel-install-guide/preinstall_intro 20 | 21 | -------------------------------------------------------------------------------- /glossary/n/nailgun-supertask.rst: -------------------------------------------------------------------------------- 1 | .. _nailgun-supertask: 2 | 3 | Nailgun supertask 4 | ----------------- 5 | 6 | An entity of operations with the cluster. The operations can contain several 7 | other transactions, such as provisioning, deployment, network verification, 8 | and so on. 9 | 10 | Each cluster operation represents a Nailgun transaction. 11 | Each transaction may consist of several instances of a deployment pipeline 12 | invocation: data conversion and graph execution. 13 | 14 | .. note:: The transactions cannot be completely rolled back. 15 | The transactions are not true transactions in terms of ACID. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/plugins/plugins_view_plugins.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_view_plugins: 2 | 3 | View Fuel plugins 4 | ----------------- 5 | 6 | You can view the list of installed plugins in the Fuel Web UI, as well as in 7 | the Fuel CLI. 8 | 9 | To view the list of installed plugins using the Fuel Web UI, click the 10 | :guilabel:`Plugins` button. It is located at the top of the screen at the 11 | Fuel level. 12 | 13 | You can find the following information for every plugin: 14 | 15 | * version 16 | * description 17 | * homepage 18 | * authors 19 | * licenses 20 | * releases 21 | 22 | .. seealso:: 23 | 24 | - Fuel plugins CLI 25 | 26 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/post-deployment-conf.rst: -------------------------------------------------------------------------------- 1 | .. _post-deployment-conf: 2 | 3 | ================================================ 4 | Modify an OpenStack environment after deployment 5 | ================================================ 6 | 7 | You can adjust the configuration of your OpenStack environment after 8 | deployment. This includes the day-2 operations, such as environment and 9 | network settings reconfiguration, and so on. 10 | 11 | This section includes the following topics: 12 | 13 | .. toctree:: 14 | :maxdepth: 1 15 | 16 | post-deployment-conf/modify-os-env-settings.rst 17 | post-deployment-conf/lcm-git-repo.rst 18 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_boot_master.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_boot_master: 2 | 3 | Boot the Fuel Master node 4 | ------------------------- 5 | 6 | #. When the boot menu appears, press the **Tab** key on the keyboard and 7 | modify the last kernel parameter ``showmenu`` to ``yes``. Press **Enter**. 8 | #. Wait for the Fuel Master node installation to complete. 9 | 10 | To access the Fuel Web UI, your browser must have an access 11 | to the Fuel Master node through the IP gateway that is connected 12 | to the Port Group network that you configured in :ref:`vsphere_configure_network`. 13 | 14 | Proceed to :ref:`vsphere_verify_master`. 15 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/development-requirements.rst: -------------------------------------------------------------------------------- 1 | .. _development-requirements: 2 | 3 | Development requirements 4 | ------------------------ 5 | 6 | Your development environment must meet the following requirements: 7 | 8 | * Provide DEB and RPM packages and the dependencies. For instructions 9 | on creating packages, see `Fedora project wiki `_ 10 | and `Ubuntu Packaging Guide `_. 11 | 12 | * Create Puppet manifests according to the Official OpenStack documentation. 13 | See `Puppet in OpenStack `_. -------------------------------------------------------------------------------- /userdocs/snippets/notes/fuel2-task-list-filters.rst: -------------------------------------------------------------------------------- 1 | .. note:: 2 | 3 | By default, the :command:`fuel2 task list` shows all deployment tasks. 4 | Although, you can filter the tasks in the command output by: 5 | 6 | * Environment ID: 7 | 8 | .. code-block:: console 9 | 10 | fuel2 task list --env 11 | 12 | * Tasks statuses: 13 | 14 | .. code-block:: console 15 | 16 | fuel2 task list --statuses ready 17 | 18 | The available tasks statuses are ``pending``, ``error``, 19 | ``ready``, and ``running``. 20 | 21 | * Tasks names: 22 | 23 | .. code-block:: console 24 | 25 | fuel2 task list --names -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq/sysreq_hw_intro.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_hw_intro: 2 | 3 | Hardware requirements 4 | --------------------- 5 | 6 | Planning hardware requirements for an OpenStack environment is a complex task 7 | that requires analysis of the applications that you plan to run in your cloud, 8 | as well as understanding how your cloud will expand over time. Therefore, the 9 | hardware requirements for Fuel Slave nodes will differ for each use case. 10 | However, hardware requirements for Fuel Master node are identical for all 11 | deployments. 12 | 13 | .. seealso:: 14 | 15 | - :ref:`sysreq_master_node_hardware_recs` 16 | - :ref:`sysreq_fuel_slave_node_hw_recs` 17 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_prereq.rst: -------------------------------------------------------------------------------- 1 | .. _vmware_prereq: 2 | 3 | VMware vSphere prerequisites 4 | ---------------------------- 5 | 6 | Before you install Fuel and use your OpenStack environment in intergration 7 | with vSphere, you must configure all components of VMware vSphere. 8 | 9 | .. note:: 10 | 11 | The vCenter Server supported versions are 5.1, 5.5, and 6.0. 12 | 13 | Complete the following steps: 14 | 15 | * Install ESXi. 16 | * Install vCenter. 17 | * Configure vCenter. 18 | * Create Datacenter. 19 | * Create vCenter cluster. 20 | * Add ESXi hosts to clusters in vCenter. 21 | 22 | For more information, see the VMware vSphere documentation. 23 | -------------------------------------------------------------------------------- /devdocs/develop/nailgun/tree.rst: -------------------------------------------------------------------------------- 1 | .. _nailgun-development: 2 | 3 | Nailgun Development Instructions 4 | ================================ 5 | 6 | .. toctree:: 7 | development/env 8 | development/i18n 9 | development/db_migrations 10 | development/shell_doc 11 | development/ui_dependencies 12 | development/code_testing 13 | 14 | 15 | Nailgun Customization Instructions 16 | ================================== 17 | 18 | .. _nailgun-customization: 19 | 20 | .. toctree:: 21 | customization/partitions 22 | customization/reliability 23 | customization/roles 24 | customization/settings 25 | customization/bonding_in_ui 26 | customization/extensions 27 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/upgrade/upgrade-internals.rst: -------------------------------------------------------------------------------- 1 | .. _upgrade-internals: 2 | 3 | ======== 4 | Overview 5 | ======== 6 | 7 | The upgrade is implemented with upgrade engines, which are python 8 | modules: 9 | 10 | * **Host system engine:** 11 | 12 | #. Copies new repositories to Fuel Master node. 13 | #. Installs a package and all the required dependencies such as 14 | Puppet manifests, bootstrap images, provisioning images etc. 15 | 16 | * **OpenStack engine:** 17 | 18 | #. Installs all data required for OpenStack patching. 19 | #. Adds new releases using the Nailgun REST API. 20 | This allows the full list of OpenStack releases to be displayed 21 | in the Fuel web UI. 22 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide.rst: -------------------------------------------------------------------------------- 1 | .. index:: Fuel Plugin SDK Guide 2 | 3 | .. _fuel-plugin-sdk-guide: 4 | 5 | ===================== 6 | Fuel Plugin SDK Guide 7 | ===================== 8 | 9 | .. toctree:: 10 | :maxdepth: 3 11 | 12 | fuel-plugin-sdk-guide/introduction.rst 13 | fuel-plugin-sdk-guide/how-plugins-work.rst 14 | fuel-plugin-sdk-guide/existing-plugins.rst 15 | fuel-plugin-sdk-guide/create-environment.rst 16 | fuel-plugin-sdk-guide/create-plugin.rst 17 | fuel-plugin-sdk-guide/requirements.rst 18 | fuel-plugin-sdk-guide/limitations.rst 19 | fuel-plugin-sdk-guide/reference.rst 20 | fuel-plugin-sdk-guide/faq.rst 21 | fuel-plugin-sdk-guide/additional-information.rst 22 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-structure/network_assignment.rst: -------------------------------------------------------------------------------- 1 | .. _network-assignment: 2 | 3 | network_assignment 4 | ------------------ 5 | 6 | **Description** 7 | 8 | Describes mapping between endpoints and network names. The **Example** 9 | section describes the mapping that Fuel configures by default 10 | without using templates. The set of networks can be changed 11 | using API. 12 | 13 | **Example** 14 | 15 | :: 16 | 17 | network_assignments: 18 | storage: 19 | ep: br-storage 20 | private: 21 | ep: br-prv 22 | public: 23 | ep: br-ex 24 | management: 25 | ep: br-mgmt 26 | fuelweb_admin: 27 | ep: br-fw-admin 28 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/introduction.rst: -------------------------------------------------------------------------------- 1 | 2 | .. index:: Introduction 3 | 4 | .. _User-Introduction: 5 | 6 | Introduction to the User Guide 7 | ============================== 8 | 9 | The Fuel User Guide provides instructions on how to configure, test, and 10 | operate OpenStack environments using Fuel web UI and CLI. 11 | 12 | If you have already deployed OpenStack environments using earlier versions 13 | of the Fuel software, see the *Upgrading Fuel* section in the Fuel Installation 14 | Guide for instructions on upgrading your existing OpenStack distribution and 15 | the Fuel software. 16 | 17 | Before you read this document, you must install the Fuel Master node as 18 | described in the *Fuel Installation Guide*. 19 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_upload_iso.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_upload_iso: 2 | 3 | Upload the Fuel ISO to the VMware vSphere datastore 4 | --------------------------------------------------- 5 | 6 | You need to download the `Fuel ISO `_ 7 | and upload it do a vSphere datastore. 8 | 9 | **To upload the Fuel ISO to the VMware vSphere datastore:** 10 | 11 | #. Log into the vSphere web client. 12 | #. Click **vCenter**. 13 | #. Go to the Datastores and choose your datastore. 14 | #. Go to the Actions menu and select **Browse Files**. 15 | #. Click the **Upload Files** icon, browse your filesystem, 16 | and select your Fuel ISO. 17 | #. Proceed to :ref:`vsphere_configure_network`. 18 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/brute-force.rst: -------------------------------------------------------------------------------- 1 | ========================== 2 | SSH brute force protection 3 | ========================== 4 | 5 | Implemented the possibility to add SSH brute force protection 6 | for your OpenStack environment. 7 | 8 | To activate SSH brute force protection: 9 | 10 | #. Log in to the Fuel web UI. 11 | #. Open the :guilabel:`Settings` tab. 12 | #. Expand :guilabel:`Security` section. 13 | #. In the :guilabel:`SSH Security` section, select 14 | :guilabel:`Restrict SSH service on network` check box. 15 | #. Optionally, add secure networks. 16 | #. Select :guilabel:`Brute force protection` check box. 17 | 18 | See :ref:`settings-ug` | `LP1563721 `__ -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere_intro.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak oneColumn 4 | 5 | .. _vsphere_intro: 6 | 7 | Install Fuel on VMware vSphere 8 | ============================== 9 | 10 | This section describes how to configure your VMware vSphere environment 11 | to install Fuel. 12 | 13 | This section includes the following topics: 14 | 15 | .. toctree:: 16 | :maxdepth: 3 17 | 18 | vsphere/vsphere_prereq 19 | vsphere/vsphere_configure_esxi_networking 20 | vsphere/vsphere_upload_iso 21 | vsphere/vsphere_configure_network 22 | vsphere/vsphere_create_vm 23 | vsphere/vsphere_mount_iso 24 | vsphere/vsphere_install_master 25 | vsphere/vsphere_boot_master 26 | vsphere/vsphere_verify_master 27 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/plugins/plugins_install_userguide.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_install_userguide: 2 | 3 | Install a Fuel plugin 4 | --------------------- 5 | 6 | The installation procedure is common for all plugins hosted 7 | in the pre-populated repository, for example 8 | http://mirror.fuel-infra.org/mos-plugins/centos/ 9 | 10 | **To install a Fuel plugin:** 11 | 12 | #. Configure the plugin repository on the Fuel Master node. 13 | 14 | #. Run the :command:`yum makecache` command. 15 | 16 | #. Run the :command:`yum install` command: 17 | 18 | .. code-block:: console 19 | 20 | yum install 21 | 22 | #. Register the plugin in Nailgun: 23 | 24 | .. code-block:: console 25 | 26 | fuel plugins --sync -------------------------------------------------------------------------------- /userdocs/release-notes/new-features.rst: -------------------------------------------------------------------------------- 1 | ============ 2 | New features 3 | ============ 4 | 5 | This section includes the detailed description of features and enhancements 6 | introduced in the Newton release. 7 | 8 | .. note:: Fuel Newton uses Ubuntu 16.04 as a host operating system 9 | for OpenStack nodes. 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | 14 | new-features/master-backup-restore 15 | new-features/fuel-web-ui 16 | new-features/fuel-cli 17 | new-features/fuel-plugins 18 | new-features/task-graphs 19 | new-features/vmware-certificate 20 | new-features/brute-force 21 | new-features/snapshots-timmy 22 | new-features/s3-api 23 | new-features/dmz 24 | new-features/user-documentation -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/upgrade_intro.rst: -------------------------------------------------------------------------------- 1 | .. _upgrade_intro: 2 | 3 | ============ 4 | Upgrade Fuel 5 | ============ 6 | 7 | If you have a functional Fuel installation, you can upgrade the Fuel software 8 | to the latest version without reinstalling your environments. 9 | 10 | This section includes the following topics. 11 | 12 | .. toctree:: 13 | :maxdepth: 1 14 | 15 | upgrade/upgrade-internals 16 | upgrade/upgrade-liberty 17 | 18 | .. note:: Fuel does not support upgrades for plugins. The old plugin 19 | versions may not be compatible with the new version of Fuel. 20 | Therefore, you must uninstall the Fuel plugins before 21 | upgrading Fuel. See :ref:`plugins_upgrade_uninstall_plugin`. 22 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_verify_master.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_verify_master: 2 | 3 | Verify the Fuel Master node operation 4 | ------------------------------------- 5 | 6 | You need to verify that the Fuel Master node operates correctly. 7 | 8 | **To verify the Fuel Master node operation:** 9 | 10 | #. Create a new VM on the same ESXi host. 11 | #. Boot the created VM via PXE. 12 | 13 | If the boot is successful, 14 | the "Total nodes" at the top right of the Fuel Web UI will increase 15 | its value after two to five minutes. 16 | 17 | **To verify that the Fuel bootstrap node runs on ESXi:** 18 | 19 | #. Open the node information window in the Fuel Web UI. 20 | #. Verify that the **Manufacturer** field says **VMWARE**. 21 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/requirements.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-requirements: 2 | 3 | Requirements 4 | ============ 5 | 6 | * Plugin code must be idempotent. 7 | * Do not copy modules from fuel-library. Add the module path 8 | into task description instead and use fuel-library as framework: 9 | ``puppet_modules: "puppet/modules:/etc/puppet/modules"`` 10 | * If you use plugin pre-deployment scripts that somehow change the state of 11 | the Fuel Master node -- for example, changes to Nailgun database -- 12 | ensure that all these changes are removed in the post-deployment script. 13 | * See :ref:`code-style` and 14 | `Fuel contribution guidelines `_ 15 | * recommendation on pre_build_hook -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/create-environment/change-password.rst: -------------------------------------------------------------------------------- 1 | .. _change-fuel-passwd-ug: 2 | 3 | Change the Fuel Master node administrative password 4 | --------------------------------------------------- 5 | 6 | We highly recommend that you change the default password for the *admin* 7 | user to the one that meets your company's security requirements. 8 | 9 | **To change the Fuel Administrator password:** 10 | 11 | #. In the Fuel web UI, click the user icon: 12 | 13 | .. image:: /_images/deliverables/scr_change_pass_ui.png 14 | 15 | #. Click :guilabel:`Change Password`. 16 | #. Type the current password, the new password, and then confirm the new 17 | password. 18 | To display what you type, click the eye icon. 19 | #. Click :guilabel:`Apply`. 20 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run/nfv-create-sriov-port.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-create-sriov-port: 2 | 3 | Create a network port for SR-IOV 4 | -------------------------------- 5 | 6 | To use SR-IOV, create a network port in the ``admin_internal_net``. 7 | 8 | **To creat a network port for SR-IOV:** 9 | 10 | #. Log in to Horizon. 11 | #. Click :guilabel:`Networks`. 12 | #. Select the ``admin_internal_net`` network. 13 | #. Click :guilabel:`Create Port`. 14 | #. In the Create Port wizard, fill the following fields: 15 | 16 | * :guilabel:`Name` - for example: ``sriov-port`` 17 | * :guilabel:`Admin State` - UP 18 | * :guilabel:`Binding: VNIC Type` - Direct 19 | 20 | #. Click :guilabel:`Create Port`. 21 | #. Proceed to :ref:`nfv-launch-vm`. 22 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/file-ref/fuel-env-template: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _xxx-ref: 8 | 9 | xxx.yaml 10 | -------- 11 | 12 | Fuel Master Node: 13 | **yyy** 14 | 15 | The *xxx.yaml* file 16 | 17 | Usage 18 | ----- 19 | 20 | #. Dump provisioning information using this 21 | :ref:`fuel CLI` command:: 22 | 23 | fuel --env 1 provisioning default 24 | 25 | where ``--env 1`` points to the specific environment 26 | (id=1 in this example). 27 | 28 | 29 | #. Edit file. 30 | 31 | 32 | #. Upload the modified file: 33 | :: 34 | 35 | fuel --env-1 provisioning upload 36 | 37 | 38 | File Format 39 | ~~~~~~~~~~~ 40 | 41 | The *xxx.yaml* file 42 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/s3-api.rst: -------------------------------------------------------------------------------- 1 | ====================================== 2 | S3 API authentication through Keystone 3 | ====================================== 4 | 5 | Implemented the possibility to enable Keystone to authenticate queries 6 | to S3 API on RadosGW using the Fuel CLI and Fuel web UI. 7 | 8 | .. note:: 9 | 10 | Enablement of the Keystone authentication for S3 API increases the load 11 | on the Keystone service. Consult with documentation and support on 12 | mitigating the risks related with the high load of the Keystone service. 13 | 14 | See `LP1540426`_ | `spec`_ 15 | 16 | .. _`LP1540426`: https://bugs.launchpad.net/mos/+bug/1540426 17 | .. _`spec`: https://specs.openstack.org/openstack/fuel-specs/specs/10.0/s3-keystone-integration.html -------------------------------------------------------------------------------- /_templates/openstackdocs/titlerow.html: -------------------------------------------------------------------------------- 1 |
2 |
3 |

{{ title }}

4 |
5 |
6 | {% if prev %} 7 | 8 | {% endif %} 9 | {% if next %} 10 | 11 | {% endif %} 12 | 13 |
14 |
15 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012 Mirantis, Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 4 | # not use this file except in compliance with the License. You may obtain 5 | # a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | # License for the specific language governing permissions and limitations 13 | # under the License. 14 | 15 | import setuptools 16 | 17 | 18 | setuptools.setup( 19 | setup_requires=['pbr'], 20 | pbr=True) 21 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-structure.rst: -------------------------------------------------------------------------------- 1 | .. _network-templates-structure: 2 | 3 | Structure of network templates 4 | ------------------------------ 5 | 6 | You can use the structure described in this section, as well 7 | as the default template, to create a template that meets the 8 | requirements of your configuration. 9 | 10 | Network parameters are defined in the ``adv_net_template`` 11 | section in the ``network_template_.yaml`` file. 12 | 13 | .. toctree:: 14 | :maxdepth: 1 15 | 16 | network-templates-structure/network_scheme.rst 17 | network-templates-structure/nic_mapping.rst 18 | network-templates-structure/templates_for_node_role.rst 19 | network-templates-structure/network_assignment.rst 20 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_create_vm.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_create_vm: 2 | 3 | Create the Fuel Master node virtual machine 4 | ------------------------------------------- 5 | 6 | You need to create a new virtual machine with a guest 7 | operating system to run the Fuel Master node on it. 8 | 9 | **To create the Fuel Master node virtual machine:** 10 | 11 | #. On the vCenter screen choose **Virtual Machines**. 12 | #. Click **Create a Virtual Machine**. 13 | #. Click **Create a new virtual machine**. 14 | Do not use templates. 15 | #. Name your new VM and select the datacenter where the Fuel ISO is located. 16 | #. Select a compute resource (ESXi host), storage, and compatibility 17 | for the VM. 18 | #. Select a guest operating system. 19 | #. Proceed to: :ref:`vsphere_mount_iso`. 20 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_mount_iso.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_mount_iso: 2 | 3 | Mount the Fuel ISO 4 | ------------------ 5 | 6 | You must mount the Fuel ISO to install the Fuel Master node 7 | on the virtual machine. 8 | 9 | **To mount the Fuel ISO:** 10 | 11 | #. For the CD/DVD drive, choose **Datastore ISO File** from 12 | the dropdown menu on the right. 13 | #. Navigate through the datastore and choose the ISO you uploaded earlier. 14 | #. Enable the CD/DVD drive by clicking the **Connect...** checkbox 15 | opposite the drive. 16 | #. Go to the **VM Options** tab and expand the **Boot Options** submenu. 17 | #. Enable the "Force BIOS setup" item. 18 | #. Click **Next**. 19 | #. Verify the new Virtual Machine settings and proceed. 20 | #. Proceed to :ref:`vsphere_install_master`. 21 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment.rst: -------------------------------------------------------------------------------- 1 | .. _manage-environment: 2 | 3 | Manage your OpenStack environment 4 | ================================= 5 | 6 | This section describes the tasks that you need 7 | to perform with your OpenStack environment on a day-to-day basis. 8 | 9 | This section includes the following sections: 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | 14 | manage-environment/cgroups.rst 15 | manage-environment/cgroups/cgroups-configure.rst 16 | manage-environment/cgroups/cgroups-modify-multiple-nodes.rst 17 | manage-environment/cgroups/cgroups-modify-single-node.rst 18 | manage-environment/cgroups/cgroups-example.rst 19 | manage-environment/role-operations.rst 20 | manage-environment/nfv-run.rst 21 | manage-environment/enable-experimental-features.rst 22 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-run-vm: 2 | 3 | Run an instance with workload acceleration 4 | ========================================== 5 | 6 | If you have enabled workflow acceleration, you can create a flavor 7 | that supports such NFV features as DPDK and SR-IOV and deploy instances 8 | using that flavor. 9 | 10 | You can configure the corresponding settings in the OpenStack Dashboard 11 | (Horizon) or through the CLI. This section only describes the Horizon 12 | configuration. 13 | 14 | This section includes the following topics: 15 | 16 | .. toctree:: 17 | :maxdepth: 2 18 | 19 | nfv-run/nfv-create-flavor.rst 20 | nfv-run/nfv-create-sriov-port.rst 21 | nfv-run/nfv-launch-vm.rst 22 | nfv-run/nfv-associate-floating-ip.rst 23 | nfv-run/nfv-verify.rst 24 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/install/install_download_iso.rst: -------------------------------------------------------------------------------- 1 | .. _install_download_iso: 2 | 3 | Download the ISO image 4 | ---------------------- 5 | 6 | The Fuel ISO image includes Fuel software components, as well as the 7 | latest release of OpenStack which is required to create your OpenStack 8 | environment. Therefore, if you use Fuel, you do not need to download any 9 | additional OpenStack components. 10 | 11 | However, the Fuel ISO does not include the operating system packages. The Fuel 12 | Master node dynamically downloads the packages from the configured software 13 | repository. 14 | 15 | **To download the ISO image:** 16 | 17 | #. Go to the `Fuel project page `_. 18 | #. Download the ISO to your computer. 19 | #. Proceed to :ref:`install_prepare_install_media`. 20 | 21 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/create-environment.rst: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _create-env-ug: 8 | 9 | Create a new OpenStack environment 10 | ================================== 11 | 12 | After you install the Fuel Master node, 13 | your Fuel Slave nodes appear as **Unallocated nodes** in the Fuel web UI. 14 | You can now create, configure, and deploy your first OpenStack environment. 15 | You can deploy and manage multiple OpenStack environments using one Fuel 16 | Master node. However, you must create each environment separately. 17 | 18 | This section includes the following topics: 19 | 20 | .. toctree:: 21 | :maxdepth: 3 22 | 23 | create-environment/prerequisites-limitations.rst 24 | create-environment/start-create-env.rst 25 | create-environment/change-password.rst 26 | 27 | -------------------------------------------------------------------------------- /_templates/openstackdocs/sidebartoc.html: -------------------------------------------------------------------------------- 1 |
2 |
3 | 4 |
5 |
6 |
7 |
8 |

{{ _('Contents') }}

 9 | {{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} 10 |
11 |
12 |
13 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/code-style.rst: -------------------------------------------------------------------------------- 1 | .. _code-style: 2 | 3 | Install style checkers 4 | ---------------------- 5 | 6 | To keep the code readable, reviewable, and maintainable, adhere to the 7 | standardized style of `Puppet `_ 8 | and `Python `_. 9 | 10 | Integrate the code style checkers to your Continuous Integration (CI) workflow. 11 | 12 | **To install a Puppet code style checker:** 13 | 14 | .. code-block:: console 15 | 16 | gem install puppet-lint 17 | puppet-lint --with-context ./myplugin/deployment_scripts 18 | 19 | **To install a Python code style checker:** 20 | 21 | .. code-block:: console 22 | 23 | pip install pep8 24 | pep8 --show-source --show-pep8 ./myplugin/deployment_scripts -------------------------------------------------------------------------------- /glossary/d/deployment-pipeline.rst: -------------------------------------------------------------------------------- 1 | .. _deployment-pipeline: 2 | 3 | Deployment pipeline 4 | ------------------- 5 | 6 | A sequence of data transformations from user-friendly instructions 7 | to the low-level data representation in the form of deployment input 8 | data and deployment graph. 9 | 10 | The deployment pipeline workflow: 11 | 12 | #. Fuel manipulates the input data provided by the user. Data examples: 13 | 14 | * Cluster attributes 15 | * OpenStack release version 16 | * Networking settings 17 | * Huge Pages allocation 18 | 19 | #. Fuel converts the data using a set of serializers. 20 | 21 | #. Using the converted data, Fuel builds a deployment graph. 22 | 23 | #. Fuel passes the deployment graph to a task executor. 24 | 25 | #. The task executor carries out the deployment tasks based on the input data. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/intro_fuel_install_intro.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak oneColumn 4 | 5 | .. _intro_fuel_install: 6 | 7 | Introduction to Fuel Installation 8 | ================================= 9 | 10 | This section provides an overview of the Fuel installation 11 | process. You can install Fuel either using pre-built ISO image or 12 | using rpm packages available on one of Fuel mirrors. Using ISO 13 | you can install Fuel on a server with an Internet connection or 14 | on a server that is isolated from the Internet for security reasons. 15 | Depending on your choice, the workflow differs. 16 | 17 | This section includes the following topics: 18 | 19 | .. toctree:: 20 | :maxdepth: 3 21 | 22 | intro/intro_fuel_intro.rst 23 | intro/intro_install_overview 24 | intro/intro_planning_your_environment 25 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-delete.rst: -------------------------------------------------------------------------------- 1 | .. _network-template-delete: 2 | 3 | Delete a network template 4 | ------------------------- 5 | 6 | You can delete a network template that you have previously uploaded. 7 | 8 | .. warning:: 9 | 10 | Do not delete network templates that are used in your OpenStack 11 | environment as it may result in a failure of the whole network 12 | configuration. 13 | 14 | **To delete a network template:** 15 | 16 | #. Log in to the Fuel Master node CLI. 17 | #. Type: 18 | 19 | :: 20 | 21 | fuel --env network-template --delete 22 | 23 | **Example:** 24 | 25 | :: 26 | 27 | fuel --env 1 network-template --delete 28 | 29 | .. seealso:: 30 | 31 | - :ref:`cli-network-group` 32 | - :ref:`cli-network-template` 33 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/reinstall-node.rst: -------------------------------------------------------------------------------- 1 | .. _reinstall-node: 2 | 3 | ================ 4 | Reinstall a node 5 | ================ 6 | 7 | You may need to reinstall a node in case of failures on the root partition, 8 | for example, failure to upgrade the operating system. 9 | 10 | **To reinstall a node**: 11 | 12 | #. Log in to the Fuel Master node CLI. 13 | 14 | #. Reprovision the node by issuing: 15 | 16 | :: 17 | 18 | fuel node --node-id --provision 19 | 20 | where points to a specific node identified by its ID 21 | (a number) that you can get by issuing the ``fuel nodes`` command. 22 | 23 | **Example:** 24 | 25 | :: 26 | 27 | fuel node --node-id 1 --provision 28 | 29 | #. Redeploy the node: 30 | 31 | :: 32 | 33 | fuel node --node-id --deploy -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment.rst: -------------------------------------------------------------------------------- 1 | .. _create-environment: 2 | 3 | Create a development environment 4 | ================================ 5 | 6 | To create a development environment, you must: 7 | 8 | * Set up a repository and adhere to the workflow. 9 | * Set up Continuous Integration and Continuous Deployment (CI/CD). 10 | * Set up a testing framework. 11 | 12 | This section includes the following topics: 13 | 14 | .. toctree:: 15 | :maxdepth: 2 16 | 17 | create-environment/development-requirements.rst 18 | create-environment/code-style.rst 19 | create-environment/repository-workflow.rst 20 | create-environment/repository-branching.rst 21 | create-environment/launchpad-project.rst 22 | create-environment/plugin-repo.rst 23 | create-environment/plugin-ci.rst 24 | create-environment/autotests.rst 25 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-overview.rst: -------------------------------------------------------------------------------- 1 | .. _network-templates-overview: 2 | 3 | Overview of network templates 4 | ----------------------------- 5 | 6 | A network template is a ``.yaml`` file that contains network configuration 7 | for an OpenStack environment. To apply custom network 8 | configurations, create and configure 9 | the template according to your environment requirements. For your convenience, 10 | use the following :ref:`network-templates-examples`. 11 | 12 | The name of the network template 13 | must follow this convention: ``network_template_.yaml``. Verify the 14 | ID of your OpenStack environment by running the ``fuel environment`` command. 15 | 16 | For example, if the ID of an OpenStack environment is ``1``, the name of the 17 | template is ``network_template_1.yaml``. 18 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/dns-ntp-support.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _dns-ntp-support-ug: 3 | 4 | Change the DNS and NTP server settings 5 | -------------------------------------- 6 | 7 | If the Fuel Master node does not have access to the Internet 8 | or if you plan to disable Internet access after deployment, you 9 | may want to change the NTP and DNS servers for the nodes and omit 10 | routing through the Fuel Master node. 11 | 12 | **To change the DNS and NTP server settings:** 13 | 14 | #. In the Fuel web UI, click the guilabel:`Networks` tab. 15 | #. Click :guilabel:`Other`. 16 | #. Type the DNS server IP address or NTP server IP address or FQDN. 17 | #. Click :guilabel:`Save Settings`. 18 | 19 | .. note:: 20 | Fuel does not verify if the specified DNS and NTP services are 21 | available. Verify that you specify correct values. 22 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/autotests/autotests-workflow.rst: -------------------------------------------------------------------------------- 1 | .. _autotests-workflow: 2 | 3 | Automation tests execution order 4 | -------------------------------- 5 | 6 | #. Base test cases are executed: these are the tests that set up environment 7 | and install the Fuel Master node. 8 | #. After passing these tests, snapshots are created which will be used by 9 | the tests for creating clusters. 10 | #. Revert to the previously created snapshots. 11 | #. Set up the cluster and deploy it. 12 | #. Run OSTF. 13 | 14 | For test execution debugging, use ``dos.py``. 15 | 16 | To create a snapshot, run: 17 | 18 | .. code-block:: console 19 | 20 | dos.py snapshot --snapshot-name= 21 | 22 | To revert a snapshot, run: 23 | 24 | .. code-block:: console 25 | 26 | dos.py revert --snapshot-name= -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/file-ref/settings-yaml.rst: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _settings-yaml-ref: 8 | 9 | settings.yaml 10 | ------------- 11 | 12 | Fuel Master Node: 13 | **/root/settings_x.yaml/** 14 | 15 | The *settings.yaml* file contains 16 | the current values for the information 17 | on the Settings page of the Fuel UI. 18 | 19 | Usage 20 | +++++ 21 | 22 | #. Dump provisioning information using the following 23 | Fuel command: 24 | 25 | :: 26 | 27 | fuel --env 1 settings default 28 | 29 | where ``--env 1`` points to the specific environment 30 | (id=1 in this example). 31 | 32 | 33 | #. Edit file. 34 | 35 | 36 | #. Upload the modified file: 37 | :: 38 | 39 | fuel --env-1 settings upload 40 | 41 | 42 | File Format 43 | +++++++++++ 44 | 45 | Modify the Fuel settings using the Fuel web UI. 46 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide.rst: -------------------------------------------------------------------------------- 1 | .. index:: Fuel User Guide 2 | 3 | .. _fuel-user-guide: 4 | 5 | =============== 6 | Fuel User Guide 7 | =============== 8 | 9 | .. toctree:: 10 | :maxdepth: 3 11 | 12 | fuel-user-guide/introduction.rst 13 | fuel-user-guide/create-environment.rst 14 | fuel-user-guide/configure-environment.rst 15 | fuel-user-guide/install-additional-components.rst 16 | fuel-user-guide/deploy-environment.rst 17 | fuel-user-guide/post-deployment-conf.rst 18 | fuel-user-guide/next-steps.rst 19 | fuel-user-guide/configure-additional-components.rst 20 | fuel-user-guide/verify-environment.rst 21 | fuel-user-guide/manage-environment.rst 22 | fuel-user-guide/maintain-environment.rst 23 | fuel-user-guide/plugins/hot-plugable.rst 24 | fuel-user-guide/file-ref.rst 25 | fuel-user-guide/cli.rst 26 | fuel-user-guide/troubleshooting.rst -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/plugin-node-roles.rst: -------------------------------------------------------------------------------- 1 | .. _plugin-node-roles: 2 | 3 | ========================== 4 | Plugin specific node roles 5 | ========================== 6 | 7 | Defining a new role allows you to explicitly define all the tasks that run on 8 | it. 9 | 10 | Defining a new role is convenient if you need to run some services on 11 | separate nodes: 12 | 13 | * If you deploy a service with some specific hardware or security 14 | requirements. 15 | 16 | * If your software conflicts with some of the packages installed on 17 | the existing roles 18 | 19 | * If the tasks that you execute conflict with the existing tasks. 20 | 21 | .. toctree:: 22 | :maxdepth: 3 23 | 24 | plugin-node-roles/define-new-role.rst 25 | plugin-node-roles/volume-allocation.rst 26 | plugin-node-roles/hot-pluggable.rst 27 | plugin-node-roles/modify-ui-wizard.rst -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/install-additional-components/sahara-install.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _sahara-install: 3 | 4 | Install the Hadoop cluster service 5 | ---------------------------------- 6 | 7 | You install the OpenStack Hadoop cluster service, or Sahara, when you 8 | deploy an OpenStack 9 | environment. Follow the steps described in :ref:`create-env-ug` and 10 | :ref:`configure-env-ug` to configure other components and settings of your 11 | OpenStack environment. Then, follow the steps described in this section to 12 | configure Ironic in the deployment wizard. 13 | 14 | **To install the Hadoop cluster service:** 15 | 16 | #. Create and configure your environment as described in :ref:`create-env-ug`. 17 | #. On the :guilabel:`Additional Services` page, select 18 | :guilabel:`Install Sahara`. 19 | #. Configure and deploy your environment. 20 | #. Proceed to :ref:`sahara_configure`. 21 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin.rst: -------------------------------------------------------------------------------- 1 | .. _create-plugin: 2 | 3 | ==================== 4 | Create a Fuel plugin 5 | ==================== 6 | 7 | To create a Fuel plugin, you must: 8 | 9 | * Install Fuel Plugin Builder on the Fuel Master node. 10 | * Create a plugin. 11 | 12 | This section includes the following topics: 13 | 14 | .. toctree:: 15 | :maxdepth: 3 16 | 17 | create-plugin/install-plugin-builder.rst 18 | create-plugin/create-auto-plugin.rst 19 | create-plugin/describe-plugin.rst 20 | create-plugin/define-plugin-actions.rst 21 | create-plugin/actions-existing-roles.rst 22 | create-plugin/plugin-settings.rst 23 | create-plugin/plugin-node-roles.rst 24 | create-plugin/plugin-attributes.rst 25 | create-plugin/modify-ui.rst 26 | create-plugin/plugin-repos.rst 27 | create-plugin/add-driverlog.rst 28 | create-plugin/plugin-versioning-system.rst -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/deploy-environment/reset-environment.rst: -------------------------------------------------------------------------------- 1 | .. index:: Reset an environment after deployment 2 | 3 | .. contents :local: 4 | 5 | .. _reset_environment: 6 | 7 | Reset an OpenStack environment after deployment 8 | ----------------------------------------------- 9 | 10 | You may want to reset an OpenStack environment after it was 11 | successfully deployed, failed to deploy with an error, or 12 | you have interrupted the deployment to modify the settings. 13 | After you reset an OpenStack environment, Fuel reboots all 14 | Fuel Slave nodes and returns them to the *Unallocated* state. 15 | 16 | **To reset an OpenStack environment:** 17 | 18 | #. In the Fuel web UI, click the :guilabel:`Dashboard` tab. 19 | #. Click :guilabel:`Reset`. 20 | #. Wait while Fuel reboots the nodes. The nodes must have the 21 | status :guilabel:`Online`. 22 | #. Configure and deploy a new environment. 23 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-structure/nic_mapping.rst: -------------------------------------------------------------------------------- 1 | .. _nic-mapping: 2 | 3 | nic_mapping 4 | ----------- 5 | 6 | **Description** 7 | 8 | Specifies aliases to the network interface names mapping, 9 | for example, ``adm: eth0``. If a node is not listed in this section, 10 | default mapping applies. You can configure custom mapping for 11 | any node using the node name. The number of NICs depends on the 12 | network topology and may vary. Aliases are optional and if 13 | all nodes have the same number of NICs connected in a similar 14 | manner, you can use NIC names instead. 15 | 16 | **Example** 17 | 18 | :: 19 | 20 | nic_mapping: 21 | default: 22 | adm: eth0 23 | pub: eth1 24 | man: eth2 25 | stor: eth3 26 | node-33: 27 | adm: eth0 28 | pub: eth4 29 | man: eth1 30 | stor: eth2 31 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/plugins/plugins_uninstall_upgrade.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_upgrade_uninstall_plugin: 2 | 3 | 4 | Uninstall a plugin 5 | ------------------ 6 | 7 | Fuel does not support upgrades for plugins. The old plugin versions 8 | may not be compatible with the new version of Fuel. Therefore, you must 9 | uninstall the Fuel plugins before upgrading Fuel. 10 | 11 | **To uninstall a plugin:** 12 | 13 | #. Log in to the Fuel Master node CLI. 14 | #. Create an ``uninstall.sh`` script with the following content:: 15 | 16 | #!/bin/bash 17 | set -eux 18 | echo uninstall > /tmp/myplugin_uninstall 19 | 20 | where ``myplugin`` is the name of your plugin. 21 | 22 | #. Put the ``uninstall.sh`` script in your plugin folder. 23 | #. Type:: 24 | 25 | fuel plugins --remove myplugin 26 | 27 | .. seealso:: 28 | 29 | - `Fuel Plugin Wiki `_ 30 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/bootstrap_intro.rst: -------------------------------------------------------------------------------- 1 | .. _install_configure_bootstrap: 2 | 3 | Configure a bootstrap image 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | You can build a custom Ubuntu bootstrap image with 7 | the Fuel bootstrap builder that Fuel Master will use 8 | to boot Fuel Slave nodes. 9 | 10 | You can include additional packages, custom drivers, and even 11 | change the default Ubuntu kernel to be deployed on Fuel Slave nodes. 12 | 13 | This section includes the following topics: 14 | 15 | .. toctree:: 16 | :maxdepth: 2 17 | 18 | bootstrap/bootstrap_builder 19 | bootstrap/bootstrap_container 20 | bootstrap/bootstrap_view 21 | bootstrap/bootstrap_select 22 | bootstrap/bootstrap_add_package 23 | bootstrap/bootstrap_install_kernel 24 | bootstrap/bootstrap_inject_cert 25 | bootstrap/bootstrap_inject_driver 26 | bootstrap/bootstrap_debug 27 | bootstrap/bootstrap_troubleshoot 28 | 29 | -------------------------------------------------------------------------------- /userdocs/release-notes.rst: -------------------------------------------------------------------------------- 1 | .. _release-notes: 2 | 3 | ================== 4 | Fuel Release Notes 5 | ================== 6 | 7 | The community is releasing Fuel Newton. 8 | 9 | The following table lists the released revisions of this documentation: 10 | 11 | +-----------------------+------------------+-------------+ 12 | | Revision | Date | Description | 13 | +=======================+==================+=============+ 14 | | Newton G.A. | October 20, 2016 | G.A. | 15 | +-----------------------+------------------+-------------+ 16 | 17 | These release notes supplement the Fuel documentation and list 18 | enhancements, resolved and known issues in this version of Fuel. 19 | 20 | .. toctree:: 21 | :maxdepth: 1 22 | 23 | release-notes/new-features.rst 24 | release-notes/fuel-resolved-issues.rst 25 | release-notes/fuel-known-issues.rst 26 | release-notes/obtain-product.rst 27 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-plugin/actions-existing-roles/skip-core-tasks.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _skip-core-tasks: 3 | 4 | Skipping core tasks 5 | ------------------- 6 | 7 | Core tasks are the tasks defined by Fuel, as opposed to plugin tasks. 8 | 9 | You can disable core tasks from running on target nodes either completely 10 | or to overrun the core tasks with your plugin tasks. 11 | 12 | For example, networking plugins often disable creation of the default 13 | networks, which are usually created by Fuel during deployment. You can 14 | do this by describing the task with the same ID as the existing one and 15 | the type ``skipped``: 16 | 17 | :ref:`deployment_tasks.yaml`: 18 | 19 | .. code-block:: ini 20 | 21 | - id: openstack-network-networks 22 | type: skipped 23 | 24 | .. note:: If you try to redefine a core task by creating a new task with same 25 | ID as the one of the existing, the deployment will fail. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_install_master.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_install_master: 2 | 3 | Install the Fuel Master node on VMware vSphere 4 | ---------------------------------------------- 5 | You need to install the Fuel Master node on the created 6 | virtual machine. 7 | 8 | **To install the Fuel Master node on VMware vSphere:** 9 | 10 | #. At the Virtual Machines screen, select the Fuel VM and run it 11 | by clicking the **Power on** icon. 12 | #. Click the **Open a virtual machine console** icon. 13 | #. When the BIOS appears, use the arrow keys on your keyboard 14 | to navigate to the **Boot** tab. Then move the highlighted selection 15 | to the **CD-ROM drive**. 16 | #. Using the **+** button on the keyboard, move the **CD-ROM Drive** item 17 | to the top level. 18 | #. Navigate to the **Exit** tab, choose **Exit Saving Changes**, 19 | and confirm your decision. 20 | #. Proceed to :ref:`vsphere_boot_master`. 21 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/enable-experimental-features.rst: -------------------------------------------------------------------------------- 1 | .. _enable-experimental-features: 2 | 3 | Enable experimental features 4 | ---------------------------- 5 | 6 | Experimental features provide useful functionality, but may not be mature 7 | enough for environments that require high levels of stability. By default, 8 | experimental features are disabled. You can enable experimental features 9 | during the installation of the Fuel Master or anytime later. 10 | 11 | **To enable experimental features:** 12 | 13 | #. Log in to the Fuel Master node CLI. 14 | #. Open the ``/etc/fuel/astute.yaml`` file for editing. 15 | #. Add ``experimental`` to the ``feature_groups`` section. 16 | 17 | **Example:** 18 | 19 | :: 20 | 21 | "FEATURE_GROUPS": 22 | - experimental 23 | 24 | #. Apply the Nailgun Puppet manifest by typing: 25 | 26 | :: 27 | 28 | puppet apply /etc/puppet/modules/fuel/examples/nailgun.pp 29 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/repository-branching/repository-branching-delete.rst: -------------------------------------------------------------------------------- 1 | .. _repository-branching-delete: 2 | 3 | Delete a branch 4 | --------------- 5 | 6 | You may need to delete a branch in OpenStack if you no longer need the branch, 7 | merged that branch with other branch, or dropped the development of the branch 8 | 9 | **To delete a branch:** 10 | 11 | #. Select from the following options: 12 | 13 | * Contact the openstack-infra core team via mailing list. 14 | See `example request `_. 15 | * Report a bug in the `Fuel project `_ and assign 16 | it to Fuel DevOps team. 17 | * Request in #openstack-infra IRC channel on freenode.net. You can contact 18 | the following core members there: fungi, clarkb, jeblair, pleia2. 19 | 20 | .. seealso:: 21 | 22 | - :ref:`repository-branching-create` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/install-additional-components.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak 4 | 5 | .. _install-additional-components: 6 | 7 | Install additional components 8 | ============================= 9 | 10 | If you want to install additional components, such as the OpenStack Telemetry 11 | service (Ceilometer), the Bare Metal service (Ironic), or the Hadoop cluster 12 | (Sahara), you must select a corresponding checkbox in the deployment wizard. 13 | However, some components require additional configuration before installation. 14 | This section describes the installation process for the OpenStack programs 15 | that require additional attention. 16 | 17 | Follow the steps described in the corresponding sub-sections of this section. 18 | 19 | This section includes the following topics: 20 | 21 | .. toctree:: 22 | :maxdepth: 3 23 | 24 | install-additional-components/ironic-install.rst 25 | install-additional-components/sahara-install.rst 26 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-limitations.rst: -------------------------------------------------------------------------------- 1 | .. _network-templates-limitations: 2 | 3 | Network template limitations 4 | ---------------------------- 5 | 6 | When using network templates, consider the following limitations: 7 | 8 | * All operations with templates must be performed through CLI or API. 9 | The Fuel web UI does not support network templates. 10 | * The Public network which maps to the External network in OpenStack 11 | cannot be removed. 12 | * When you use network templates, do not download and modify Fuel 13 | deployment configurations using the ``fuel download`` and 14 | ``fuel upload`` commands as it may result in a system malfunction. 15 | * Mapping of network roles to networks, as well as network topology cannot 16 | be configured for individual nodes. They can only be set for a node role 17 | or/and node group. 18 | * Network verification in the Fuel web UI has limited support. 19 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/change-roles.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _change-roles: 3 | 4 | Change the role of a node 5 | -------------------------- 6 | 7 | If you have assigned a wrong role or want to add additional roles to a node, 8 | you can modify this setting before you deploy an OpenStack environment, as 9 | well as after the deployment. 10 | 11 | **To change the role of a node:** 12 | 13 | #. In the Fuel web UI, click :guilabel:`Nodes`. 14 | #. Select a node. 15 | 16 | * If the OpenStack environment is not yet deployed: 17 | 18 | #. Click :guilabel:`Edit Roles`. 19 | #. Modify the role as required. 20 | 21 | * If the OpenStack environment has been already deployed: 22 | 23 | #. Click :guilabel:`Delete`. 24 | 25 | Fuel changes the node's status to *Unallocated*. 26 | 27 | #. Click :guilabel:`Add Node`. 28 | #. Select the node and assign a new role or roles to the node as 29 | described in :ref:`add-nodes-ug`. 30 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/introduction.rst: -------------------------------------------------------------------------------- 1 | 2 | .. index:: Introduction 3 | 4 | .. _plugin-sdk-introduction: 5 | 6 | Introduction to the Fuel Plugin SDK Guide 7 | ========================================= 8 | 9 | The Fuel Plugin SDK Guide provides instructions on how to build, test, and 10 | troubleshoot your plugins; the guide also gives an overview of the existing 11 | plugins. 12 | 13 | Before you read this document, you must do the following: 14 | 15 | #. Install the latest Fuel version. See :ref:`fuel-install-guide`. 16 | #. Deploy an OpenStack environment with one controller and one compute node. 17 | See :ref:`create-env-ug`. For testing purposes you will need to use at 18 | least 3 Controller nodes for high availability. 19 | 20 | This guide is a work in progress and will eventually have most of 21 | the information you need on Fuel Plugin SDK. In the meantime, use 22 | the `community Wiki page `_ 23 | as a supplementing reference. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_configure_esxi_networking.rst: -------------------------------------------------------------------------------- 1 | .. _configure_esxi: 2 | 3 | Configure ESXi host networking 4 | ------------------------------ 5 | 6 | To integrate OpenStack with VMware vCenter, you must configure the VMware ESXi 7 | host networking. 8 | 9 | **To configure ESXi host networking**: 10 | 11 | #. In VMware vSphere web-client open the ESXi host page. 12 | #. Select **Manage** > **Networking**. 13 | #. Click **Add network**. 14 | The **Add networking** wizard starts. 15 | #. In the **Add Networking** wizard, select the Virtual Machine Port 16 | group. 17 | #. Select the **Virtual Machine Port Group** option 18 | to ensure that the network is created in vSwitch0. 19 | #. Create a network called **br100**. 20 | 21 | .. note:: 22 | You must name the network ``br100``. Otherwise, Fuel will not 23 | be able to communicate with VMware vSphere. 24 | 25 | #. In the VLAN ID field, type a VLAN Tag. 26 | #. Proceed to :ref:`vsphere_upload_iso`. 27 | 28 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-workflows.rst: -------------------------------------------------------------------------------- 1 | .. _view_workflows: 2 | 3 | ================================================ 4 | View an environment deployment workflows details 5 | ================================================ 6 | 7 | You can view the deployment details of a specific environment through 8 | the Fuel web UI or Fuel CLI. 9 | 10 | **To view the workflows details using the Fuel web UI:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. Select the :guilabel:`Workflows` tab. 14 | 15 | **To view the workflows details using the Fuel CLI:** 16 | 17 | #. Log in to the Fuel Master node. 18 | #. Type: 19 | 20 | .. code-block:: console 21 | 22 | fuel2 graph list --env 23 | 24 | The system response of the :command:`fuel2 graph list` command shows 25 | the table with workflows, their relations, names, and types. 26 | 27 | The ``name`` parameter defines additional information about the workflow 28 | and has no impact on business logic. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/map-logical-to-physical-nic.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _map-logical-to-physical: 3 | 4 | Map a logical network to a physical interface 5 | --------------------------------------------- 6 | 7 | You may want to allocate specific network interfaces 8 | to handle different types of network traffic to achieve better 9 | performance in your OpenStack environment. 10 | Fuel enables you to modify mappings for your entire network, except for the 11 | *Admin* network for which you can make changes only during the Fuel 12 | Master node installation. 13 | 14 | Network interface mapping can be modified after you deploy an OpenStack 15 | environment. The ``net-config`` task updates the networking configuration. 16 | 17 | **To map a logical network to a physical interface:** 18 | 19 | #. In the Fuel web UI, click :guilabel:`Nodes`. 20 | #. Select a node. 21 | #. Click :guilabel:`Configure Interfaces`. 22 | #. Drag and drop a logical network to the corresponding physical interface 23 | or bond. 24 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/deploy-environment.rst: -------------------------------------------------------------------------------- 1 | .. _deploy-env: 2 | 3 | =============================== 4 | Deploy an OpenStack environment 5 | =============================== 6 | 7 | After you finish configuring, you can deploy your OpenStack environment. 8 | 9 | In large OpenStack deployments (e.g. 50 compute nodes or more), 10 | we recommend that you provision the OpenStack nodes before you 11 | deploy an OpenStack environment. 12 | 13 | Fuel provides the following options to deploy an OpenStack environment: 14 | 15 | * Standard deployment 16 | Provision all OpenStack nodes during the deployment. 17 | 18 | * Advanced deployment 19 | Pre-provision specific OpenStack nodes and then deploy the OpenStack 20 | environment. 21 | 22 | This section includes the following topics: 23 | 24 | .. toctree:: 25 | :maxdepth: 3 26 | 27 | deploy-environment/provision-environment.rst 28 | deploy-environment/deploy-changes.rst 29 | deploy-environment/stop-deploy-ui.rst 30 | deploy-environment/reset-environment.rst -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/install/install_login_fuel_master_node_multiple_nics.rst: -------------------------------------------------------------------------------- 1 | .. _install_login_fuel_master_node_multiple_nics: 2 | 3 | Log in to the Fuel Master node with multiple NICs 4 | ------------------------------------------------- 5 | 6 | If the server on which the Fuel Master node is installed has more than one 7 | network interface card (NIC), you can access the Fuel web UI with a particular 8 | NIC. 9 | 10 | **To access the Fuel web UI with a particular NIC:** 11 | 12 | #. Connect the NIC to the appropriate switch. 13 | #. On the Fuel Master node, set an IP address for the NIC. 14 | #. Use the IP address that you assigned to log in to the Fuel web UI. 15 | For example: ``https://IP_YOU_ASSIGN:8443/`` 16 | 17 | .. note:: 18 | 19 | The tasks above do not change the default administrator network settings. 20 | You can access the Fuel web UI using the URL displayed on the Fuel boot 21 | screen. 22 | 23 | .. seealso:: 24 | 25 | - :ref:`install_login_fuel_master_node` 26 | - :ref:`update_fuel` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst: -------------------------------------------------------------------------------- 1 | .. _download_workflows: 2 | 3 | ============================== 4 | Download a deployment workflow 5 | ============================== 6 | 7 | Fuel enables you to download deployment workflows using the Fuel web UI or 8 | Fuel CLI. 9 | 10 | **To download a deployment workflow using the Fuel web UI:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. Select the required OpenStack environment. 14 | #. Go to the :guilabel:`Workflows` tab. 15 | #. In the :guilabel:`Download` column, click on one of the available formats 16 | of the required graph file to download. 17 | 18 | **To download a deployment workflow using the Fuel CLI:** 19 | 20 | #. Log in to the Fuel Master node CLI. 21 | #. Download the required workflow using the :command:`fuel2 graph download` 22 | command. 23 | 24 | **Example:** 25 | 26 | .. code-block:: console 27 | 28 | fuel2 graph download --env 1 --all 29 | 30 | .. seealso:: 31 | 32 | * :ref:`cli-workflows` -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/additional-information.rst: -------------------------------------------------------------------------------- 1 | .. _additional-information: 2 | 3 | Additional information 4 | ====================== 5 | 6 | If you have any questions about Fuel plugins, use the openstack-dev 7 | mailing list (use the [fuel][plugins] prefix). For instructions on 8 | the mailing list usage, see the 9 | `openstack-dev `_ 10 | mailing list instructions. 11 | 12 | To file a defect for this document, do the following: 13 | 14 | #. Go to the `Fuel Launchpad project `_. 15 | #. Click :guilabel:`Report a bug.` 16 | #. Put ``[SDK]`` in the :guilabel:`Summary` field and provide a summary 17 | of the defect. 18 | #. Provide a detailed description of the defect in the ticket body. 19 | #. Once you save the bug, tag it with ``area-docs``. 20 | 21 | Use the same procedure to file a bug report for the Fuel plugin framework 22 | itself, just use ``[Fuel plugins]`` instead of ``[SDK]`` in the 23 | :guilabel:`Summary` field. -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_network_reqs.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_fuel_master_node_network_reqs: 2 | 3 | Fuel Master Node network requirements 4 | ------------------------------------- 5 | 6 | To deploy the Fuel Slave nodes on which you will run your Controller, 7 | Compute, Storage or other nodes, the Fuel Master node must have access to the 8 | Internet. 9 | 10 | When you deploy the Fuel Slave nodes, the Fuel Master node connects to the 11 | preconfigured repositories through the Internet and installs the selected 12 | operating system and the OpenStack packages on the nodes. 13 | 14 | For security reasons, you may not want to connect the Fuel Master node to 15 | the Internet. In this case, set up a local repository with the required 16 | installation packages and configure these repositories on the Fuel Master 17 | node. 18 | 19 | .. warning:: You can run only one Fuel Master node in a network set or the 20 | product will behave unexpectedly. 21 | 22 | .. seealso:: 23 | 24 | - :ref:`local-repo` 25 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/enable-usb-discovery.rst: -------------------------------------------------------------------------------- 1 | .. _enable-usb-discovery: 2 | 3 | Enable USB devices discovery 4 | ---------------------------- 5 | 6 | When Fuel discovers Fuel Slave nodes, it does not automatically detect USB 7 | devices. However, for testing or other purposes you may need to enable 8 | USB devices discovery. 9 | 10 | **To enable USB devices discovery:** 11 | 12 | #. Log in to Fuel Master node CLI. 13 | #. Open the ``/etc/fuel-bootstrap-cli/fuel_bootstrap_cli.yaml`` file 14 | for editing. 15 | #. Add ``report_usb_block_devices`` to the ``extend_kopts`` string. 16 | 17 | **Example:** 18 | 19 | .. code-block:: console 20 | 21 | extend_kopts: "biosdevname=0 net.ifnames=1 debug ignore_loglevel 22 | log_buf_len=10M print_fatal_signals=1 LOGLEVEL=8 report_usb_block_devices" 23 | 24 | #. Rebuild the bootstrap image: 25 | 26 | :: 27 | 28 | fuel-bootstrap build --activate 29 | 30 | #. Reboot all discovered Fuel Slave nodes. 31 | 32 | The nodes boot the new bootstrap image. 33 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run/nfv-associate-floating-ip.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-associate-floating-ip: 2 | 3 | Allocate a floating IP address to a virtual machine 4 | ------------------------------------------------------ 5 | 6 | You can associate or change a floating IP address of a virtual machine 7 | any time after virtual machine creation. Although, Mirantis OpenStack 8 | automatically assigns a private IP address to a VM at the moment of creation, 9 | you may want to assign a floating IP address, so that the VM can communicate 10 | with external networks. 11 | 12 | **To allocate a floating IP address with a virtual machine:** 13 | 14 | #. Log in to Horizon. 15 | #. Click :menuselection:`Project --> Compute --> Instances`. 16 | #. Click the arrow in the :guilabel:`Actions` column. 17 | #. Select :guilabel:`Associate Floating IP`. 18 | 19 | The Manage Floating IP Associations wizard starts. 20 | 21 | #. In the IP Address field, click :guilabel:`+`. 22 | #. Click :guilabel:`Allocate IP`. 23 | #. Click :guilabel:`Associate`. 24 | -------------------------------------------------------------------------------- /_templates/openstackdocs/css.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 21 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment.rst: -------------------------------------------------------------------------------- 1 | .. _maintain-environment: 2 | 3 | =================================== 4 | Maintain your OpenStack environment 5 | =================================== 6 | 7 | After you deploy your OpenStack environment, you 8 | manage many operations through the Horizon dashboard. 9 | However, operations such as adding or removing nodes, 10 | changing environment settings, and so on must be performed 11 | in the Fuel UI or CLI. 12 | 13 | This section includes the following topics: 14 | 15 | .. toctree:: 16 | :maxdepth: 1 17 | 18 | maintain-environment/backup-fuel 19 | maintain-environment/restore-fuel 20 | maintain-environment/remove-node.rst 21 | maintain-environment/redeploy-node.rst 22 | maintain-environment/access-shell.rst 23 | maintain-environment/rollback-ug.rst 24 | maintain-environment/reinstall-node.rst 25 | maintain-environment/create-snapshot.rst 26 | maintain-environment/workflows-manage.rst 27 | maintain-environment/shutdown-env.rst 28 | maintain-environment/start-env.rst 29 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/verify-environment/run-health-checks.rst: -------------------------------------------------------------------------------- 1 | .. _run-health-checks: 2 | 3 | Run a health check 4 | ------------------ 5 | 6 | We recommend that you run all health tests immediately after you 7 | deploy your OpenStack environment, so you can promptly address any 8 | issues with your environment configuration. 9 | 10 | Each test contains information on its estimated and actual duration. 11 | Information about test processing time is based on the tests 12 | conducted in our lab. Therefore, actual time for 13 | the test to complete may vary for different environments. 14 | 15 | After a test is complete, the results appear in the 16 | :guilabel:`Status` column. If a test fails, Fuel displays an 17 | error message. To assist in troubleshooting, the test 18 | scenario is displayed under the failure message and the failed step is 19 | highlighted. 20 | 21 | **To run a health check:** 22 | 23 | #. In the Fuel web UI, click the :guilabel:`Health Check` tab. 24 | #. Select the tests that you want to run. 25 | #. Click :guilabel:`Run Tests`. 26 | 27 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/repository-branching.rst: -------------------------------------------------------------------------------- 1 | .. _repository-branching: 2 | 3 | Managing Git branches 4 | --------------------- 5 | 6 | To track the release cycle efficiently, branch your project or use tags. 7 | 8 | Difference between a branch and a tag: 9 | 10 | * A tag represents a version of a particular branch at a moment in time. 11 | * A branch represents a separate thread of development that may run 12 | concurrently with other development efforts on the same code base. 13 | Changes to a branch may eventually be merged back into another branch 14 | to unify them. 15 | 16 | Examples: 17 | 18 | * For a tagging example, see the `VPNaaS plugin `_ repository. 19 | * For a branching example, see the `LMA plugin `_ repository. 20 | 21 | .. toctree:: 22 | :maxdepth: 3 23 | :hidden: 24 | 25 | repository-branching/repository-branching-create.rst 26 | repository-branching/repository-branching-delete.rst 27 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/remove-node.rst: -------------------------------------------------------------------------------- 1 | .. _remove-node: 2 | 3 | ============= 4 | Remove a node 5 | ============= 6 | 7 | You may need to remove a node from your environment to replace 8 | hardware, repair an error, complete maintenance operations, and so on. 9 | 10 | **To remove a node:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. In the :guilabel:`Nodes` tab, select the node that you want to remove and 14 | click :guilabel:`Delete`. 15 | 16 | The deployed node will be marked as :guilabel:`PENDING DELETION` and will 17 | be removed from the environment after redeployment. 18 | #. Adjust the settings of your environment as required. 19 | #. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. 20 | 21 | Puppet removes the node from the configuration files and 22 | re-triggers corresponding services. 23 | 24 | .. seealso:: 25 | 26 | - `Node management commands `_ 27 | - :ref:`add-nodes-ug` 28 | - :ref:`redeploy-node` 29 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows/workflows-create/examples/workflows-add-task.rst: -------------------------------------------------------------------------------- 1 | .. _workflows-add-task: 2 | 3 | Add a task 4 | ---------- 5 | 6 | You can add a task to an existing role. 7 | 8 | **To add a task:** 9 | 10 | #. Create a ``.yaml`` file. 11 | 12 | For example, ``my_tasks.yaml``. 13 | 14 | #. Add the task description to the ``my_tasks.yaml`` file. 15 | 16 | **Example:** 17 | 18 | .. code-block:: console 19 | 20 | - id: my_task 21 | type: puppet 22 | groups: [compute] 23 | required_for: [deploy_end] 24 | requires: [netconfig] 25 | parameters: 26 | puppet_manifest: /etc/puppet/modules/my_task.pp 27 | puppet_modules: /etc/puppet/modules 28 | timeout: 3600 29 | 30 | #. Log in to the Fuel CLI. 31 | #. Run the following command: 32 | 33 | .. code-block:: console 34 | 35 | fuel rel --sync-deployment-tasks --dir 36 | 37 | Fuel syncs the with the internal database. 38 | 39 | #. Deploy the OpenStack environment. 40 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/examples/one-network.rst: -------------------------------------------------------------------------------- 1 | .. _one-network: 2 | 3 | Configure a single network topology 4 | ----------------------------------- 5 | 6 | Fuel supports a single network configuration where one network serves 7 | all OpenStack traffic. This configuration is common in 8 | proof of concept deployments where no additional networks are 9 | available. 10 | 11 | **To configure a single network:** 12 | 13 | #. Save `network template for one network 14 | `_ 15 | as ``network_template_.yaml``. 16 | 17 | #. Upload the network template by typing: 18 | 19 | :: 20 | 21 | # fuel network-template --upload --env 22 | 23 | #. Deploy the OpenStack environment. 24 | #. Allocate the correct floating IP pool to the network. 25 | 26 | #. Clear the gateway from `router04`. 27 | #. Delete the `admin_floating_net__subnet` subnet. 28 | #. Create a new subnet with the floating IP pool from the single network. 29 | #. Set gateway on `router04`. 30 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/repository-branching/repository-branching-create.rst: -------------------------------------------------------------------------------- 1 | .. _repository-branching-create: 2 | 3 | Create a branch 4 | --------------- 5 | 6 | There are two ways to create a branch, using CLI or using the web UI. 7 | 8 | **To create a branch using CLI:** 9 | 10 | .. code-block:: console 11 | 12 | git push : 13 | 14 | Where: 15 | 16 | * ```` is the name of your Gerrit remote or the full remote URL. 17 | * ```` is the refname; this can be a branch or something else. 18 | * ```` is the name of the branch you want created. 19 | 20 | **To create a branch using the web UI:** 21 | 22 | #. Ensure you are a core reviewer. 23 | #. Go to `review.openstack.org `_. 24 | #. In the :guilabel:`Project` menu, click :guilabel:`Branches`. 25 | #. Enter a new branch name and click the :guilabel:`Create branch` button. 26 | You can leave the :guilabel:`Initial revision` field blank. 27 | 28 | .. seealso:: 29 | 30 | - :ref:`repository-branching-delete` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst: -------------------------------------------------------------------------------- 1 | .. _delete_workflows: 2 | 3 | ============================ 4 | Delete a deployment workflow 5 | ============================ 6 | 7 | Fuel stores the information about all deployment workflows associated with 8 | each deployment of an environment as well as custom workflows if any. 9 | You can delete deployment workflows using the Fuel web UI or 10 | Fuel CLI. 11 | 12 | **To delete a deployment workflow using the Fuel web UI:** 13 | 14 | #. Log in to the Fuel web UI. 15 | #. Select the required OpenStack environment. 16 | #. Go to the :guilabel:`Workflows` tab. 17 | #. Click :guilabel:`Delete` in the required workflow field. 18 | 19 | **To delete a deployment workflow using the Fuel CLI:** 20 | 21 | #. Log in to the Fuel Master node CLI. 22 | #. Delete the required workflow using the :command:`fuel2 graph delete` 23 | command. 24 | 25 | **Example:** 26 | 27 | .. code-block:: console 28 | 29 | fuel2 graph delete -e 1 -t provision 30 | 31 | .. seealso:: 32 | 33 | * :ref:`cli-workflows` 34 | -------------------------------------------------------------------------------- /_templates/openstackdocs/script_search.html: -------------------------------------------------------------------------------- 1 | 2 | 29 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_node_group.rst: -------------------------------------------------------------------------------- 1 | .. _cli-node-group: 2 | 3 | Node group management commands 4 | ------------------------------ 5 | 6 | The following table describes node group management commands 7 | available in the Fuel CLI. 8 | 9 | .. list-table:: **Node group management commands** 10 | :widths: 10 10 20 11 | :header-rows: 1 12 | 13 | * - Description 14 | - Command 15 | - Example 16 | * - List all available node groups. 17 | - ``fuel nodegroup`` 18 | - List node groups for a specific OpenStack environment: 19 | 20 | :: 21 | 22 | fuel --env nodegroup 23 | 24 | * - Create a node group. 25 | - ``fuel --env nodegroup --create --name "group_name"`` 26 | - :: 27 | 28 | fuel --env nodegroup --create --name "group 1" 29 | * - Delete a node group. 30 | - ``fuel --env nodegroup --delete --group `` 31 | - 32 | * - Assign a node to a specific node group. 33 | - ``fuel --env nodegroup --assign --node --group 34 | `` 35 | - 36 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/bootstrap/bootstrap_inject_cert.rst: -------------------------------------------------------------------------------- 1 | .. _bootstrap_inject_cert: 2 | 3 | Inject custom SSL certificates 4 | ------------------------------ 5 | 6 | You can inject any customization scripts and files inside 7 | a bootstrap using ``fuel-bootstrap``. 8 | For example, you can add custom certificates to access 9 | an https repository. 10 | 11 | **To inject certificate files:** 12 | 13 | #. Add a certificate to the Fuel Master system to provide 14 | correct work of debootstrap run on the Fuel Master node: 15 | 16 | .. code-block:: console 17 | 18 | $ update-ca-trust force-enable 19 | $ cp cert.crt /etc/pki/ca-trust/source/anchors/ 20 | $ update-ca-trust extract 21 | 22 | #. Create a directory with the certificate to inject: 23 | 24 | .. code-block:: console 25 | 26 | $ mkdir -p /root/bootstrap_root/usr/local/share/ca-certificates/ 27 | $ cp cert.crt /root/bootstrap_root/usr/local/share/ca-certificates/ 28 | 29 | #. Build the bootstrap: 30 | 31 | .. code-block:: console 32 | 33 | $ fuel-bootstrap build --load-cert --extra-dir /root/bootstrap_root/ 34 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq/sysreq_fuel_master_node_hw_requirements.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_master_node_hardware_recs: 2 | 3 | Fuel Master node hardware requirements 4 | -------------------------------------- 5 | 6 | When planning hardware for the Fuel Master node, verify that your hardware 7 | meets the following minimum requirements: 8 | 9 | For a production environment: 10 | 11 | * Quad-core CPU 12 | * 4 GB RAM 13 | * 10 Gigabit network port 14 | * Disk size depends on the number of deployed nodes. All nodes send logs 15 | to the Fuel Master node using rsyslog. During installation, Fuel creates 16 | a separate partition for ``/var`` to store the remote logs and allocates 40% 17 | of the disk size to it. Our recommendation for the remote logs partition 18 | is 20 GB per node. If you deploy 10 nodes with Fuel, you need to have a 19 | (20 x 10) x 2.5 = 500 GB disk for the Fuel Master node. 20 | * IPMI access through an independent management network 21 | 22 | For a testing environment: 23 | 24 | * Dual-core CPU 25 | * 2 GB RAM 26 | * 1 Gigabit network port 27 | * 50 GB disk 28 | * Physical console access 29 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-additional-components.rst: -------------------------------------------------------------------------------- 1 | .. raw:: pdf 2 | 3 | PageBreak 4 | 5 | .. _configure-additional-components: 6 | 7 | Configure additional components 8 | =============================== 9 | 10 | If you have installed additional components, such as the OpenStack application 11 | catalog (Murano), the Telemetry service (Ceilometer), the Bare Metal service 12 | (Ironic), or the Hadoop cluster (Sahara), you may need to complete post- 13 | deployment steps that will ensure your OpenStack environment functions 14 | correctly. 15 | 16 | If you installed any of these components, complete the steps described in the 17 | corresponding sections. 18 | 19 | If you installed Ironic, complete the tasks described in the following 20 | sections: 21 | 22 | .. toctree:: 23 | :maxdepth: 3 24 | 25 | configure-additional-components/ironic_configure.rst 26 | configure-additional-components/ironic_prepare_image.rst 27 | 28 | If you installed Sahara, complete the tasks described in the following 29 | sections: 30 | 31 | .. toctree:: 32 | :maxdepth: 3 33 | 34 | configure-additional-components/sahara_configure.rst 35 | 36 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst: -------------------------------------------------------------------------------- 1 | .. _workflows_manage: 2 | 3 | ================ 4 | Manage workflows 5 | ================ 6 | 7 | Fuel enables you to manage the deployment workflows through both the Fuel web 8 | UI and CLI. You can view, upload, download, execute, and delete default 9 | workflows as well as the custom ones. Execution of the custom deployment 10 | workflows and merging them with the default deployment workflows allows for 11 | the implementation of complex orchestrated workflows, such as bug fixes 12 | application, reference architecture alteration, and upgrades. 13 | 14 | This section includes the following topics: 15 | 16 | .. toctree:: 17 | :maxdepth: 2 18 | 19 | workflows-manage/view-workflows.rst 20 | workflows-manage/upload-workflows.rst 21 | workflows-manage/download-workflows.rst 22 | workflows-manage/run-workflows.rst 23 | workflows-manage/delete-workflows.rst 24 | workflows-manage/view-history.rst 25 | workflows-manage/download-deployment-info.rst 26 | 27 | .. seealso:: 28 | 29 | * :ref:`workflow-intro` 30 | * :ref:`cli-workflows` 31 | * :ref:`data-driven` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/nfv/nfv-configure-dpdk-nic.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-configure-dpdk-nic: 2 | 3 | Configure DPDK network interface 4 | -------------------------------- 5 | 6 | When configuring network for DPDK, you must place private network 7 | on the same interface on which you enable DPDK. For better network 8 | performance and redundancy, you can bind two network interfaces in one. 9 | 10 | **To configure DPDK network interface:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. Click :guilabel:`Nodes`. 14 | #. Select the node on which you enabled DPDK. 15 | #. Click :guilabel:`Configure Interfaces`. 16 | #. Optionally, bond network interfaces. 17 | #. On the required network interface, enable DPDK by clicking 18 | :guilabel:`Disabled` next to :guilabel:`DPDK`. 19 | #. Drag and drop the **Private** network to the DPDK-enabled network 20 | interface. 21 | #. Optionally, adjust the name of the physical network. 22 | #. Click :guilabel:`Apply`. 23 | #. Configure the rest of the environment settings as required and deploy 24 | the environment as described in :ref:`deploy-env`. 25 | 26 | .. seealso:: 27 | 28 | - :ref:`nfv-run-vm` 29 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/snapshots-timmy.rst: -------------------------------------------------------------------------------- 1 | ==================================================== 2 | Creation of targeted diagnostic snapshots with Timmy 3 | ==================================================== 4 | 5 | Replaced Shotgun with Timmy, a diagnostic utility for OpenStack environments 6 | that simplifies and optimizes OpenStack troubleshooting. 7 | 8 | Timmy enables you to create a diagnostic snapshot of your OpenStack 9 | environment through CLI depending on your needs: 10 | 11 | * Gather logging information from a single node or a subset of nodes 12 | filtered by an assigned role or a service running on the node. 13 | * Designate the time frame which logging information should cover. 14 | * Specify services, the logging information of which to be included into 15 | a snapshot. 16 | * Specify a folder or a list of folders from where logging information 17 | should be retrieved, filter the logging files included in that folders 18 | by date and time, and include this logging information into the diagnostic 19 | snapshot. 20 | 21 | See :ref:`create-snapshot` | `blueprint `__ -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst: -------------------------------------------------------------------------------- 1 | .. _upload_workflows: 2 | 3 | ============================ 4 | Upload a deployment workflow 5 | ============================ 6 | 7 | Fuel enables you to upload deployment workflows using the Fuel web UI or 8 | Fuel CLI. 9 | 10 | **To upload a deployment workflow using the Fuel web UI:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. Select the required OpenStack environment. 14 | #. Go to the :guilabel:`Workflows` tab. 15 | #. Click :guilabel:`Upload New Workflow`. 16 | #. In the :guilabel:`Upload New Workflow` dialog, specify the :guilabel:`Name` 17 | and :guilabel:`Type` of the workflow and select the deployment task file from 18 | your file system to upload. 19 | #. Click :guilabel:`Upload`. 20 | 21 | **To upload a deployment workflow using the Fuel CLI:** 22 | 23 | #. Log in to the Fuel Master node. 24 | #. Upload the required workflow using the :command:`fuel2 graph upload` command. 25 | 26 | **Example:** 27 | 28 | .. code-block:: console 29 | 30 | fuel2 graph upload -e 1 -t provision -f tasks.yaml 31 | 32 | .. seealso:: 33 | 34 | * :ref:`cli-workflows` -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq_intro.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_intro: 2 | 3 | System requirements 4 | ~~~~~~~~~~~~~~~~~~~ 5 | 6 | This section describes how to configure hardware nodes to 7 | accommodate your OpenStack workloads. Since there are many possible use cases 8 | for an OpenStack environment, the number and configurations of your servers 9 | will also vary. While this section provides clear hardware requirements for the 10 | Fuel Master node, it can only provide guidelines on how to configure the Fuel 11 | Slave nodes. For reference, a sample hardware configuration of 12 | a medium-sized OpenStack environment is described at the end of this section. 13 | 14 | This section includes the following topics: 15 | 16 | .. toctree:: 17 | :maxdepth: 3 18 | 19 | sysreq/sysreq_hw_intro 20 | sysreq/sysreq_fuel_master_node_hw_requirements 21 | sysreq/sysreq_fuel_slave_node_hw_recs 22 | sysreq/sysreq_network_requirements 23 | sysreq/sysreq_fuel_master_node_network_reqs 24 | sysreq/sysreq_storage_reqs 25 | sysreq/sysreq_additional_components 26 | sysreq/sysreq_ironic_prereq 27 | sysreq/sysreq_ironic_limitations 28 | sysreq/sysreq_sample_configuration 29 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_basic_usage.rst: -------------------------------------------------------------------------------- 1 | .. _cli_basic_usage: 2 | 3 | =========== 4 | Basic usage 5 | =========== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | Use the following usage pattern for Fuel commands: 10 | 11 | :: 12 | 13 | fuel [global optional args] [action] 14 | 15 | **Example:** 16 | 17 | :: 18 | 19 | fuel --env-id=1 node set --node-id=1,4,5 --role=controller 20 | 21 | .. list-table:: **Fuel commands parameters** 22 | :widths: 10 10 23 | :header-rows: 1 24 | 25 | * - Parameter 26 | - Description 27 | * - ``--env-id=1`` 28 | - A global argument pointing to a specific environment. This is an 29 | optional parameter. 30 | * - ``node`` 31 | - A namespace for all node control functions. 32 | * - ``set`` 33 | - An action that assigns nodes with defined roles to specific 34 | environments. 35 | 36 | To get the list of all global optional arguments and namespaces, run: 37 | 38 | :: 39 | 40 | fuel --help 41 | 42 | To get the list of actions and optional arguments for a namespace, run: 43 | 44 | :: 45 | 46 | fuel --help 47 | 48 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_deploy.rst: -------------------------------------------------------------------------------- 1 | .. _cli-deploy: 2 | 3 | =================== 4 | Deployment commands 5 | =================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes the usage of the :command:`fuel deployment` 10 | command available in the Fuel CLI. 11 | 12 | .. list-table:: **Deployment commands** 13 | :widths: 7 10 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | * - Delete current deployment data 19 | - ``fuel --env deployment --delete`` 20 | * - Download current deployment data 21 | - ``fuel --env deployment --download`` 22 | * - Download default deployment data 23 | - ``fuel --env deployment --default`` 24 | * - Get default deployment information for specific nodes 25 | - ``fuel --env deployment --default --node `` 26 | * - Upload provisioning deployment to a specific directory 27 | - ``fuel --env deployment -u --dir path/to/directory`` 28 | * - Download deployment information to a specific directory 29 | - ``fuel --env deployment -d --dir path/to/directory`` 30 | 31 | 32 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-structure/templates_for_node_role.rst: -------------------------------------------------------------------------------- 1 | .. _templates-for-node-role: 2 | 3 | templates_for_node_role 4 | ----------------------- 5 | 6 | **Description** 7 | 8 | List of network schemes for every node role used in the environment. 9 | The order of the template names is significant and must be provided 10 | according to your configuration requirements. For example, first 11 | the Puppet module must create a network bridge and then the 12 | corresponding sub-interface and not vice versa. While templates 13 | can be reused for different node roles, each template is executed 14 | once for every node. 15 | When several roles are mixed on one node and no priority is set, 16 | an alphabetical order of node roles is used to determine the final 17 | order of the templates. 18 | 19 | **Example** 20 | 21 | :: 22 | 23 | templates_for_node_role: 24 | controller: 25 | - public 26 | - private 27 | - storage 28 | - common 29 | compute: 30 | - common 31 | - private 32 | - storage 33 | ceph-osd: 34 | - common 35 | - storage 36 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/launchpad-project.rst: -------------------------------------------------------------------------------- 1 | .. _launchpad-project: 2 | 3 | Launchpad project 4 | ----------------- 5 | 6 | Launchpad is the bug tracking system that all OpenStack projects, 7 | including Fuel and Fuel plugins, use. You must create a Launchpad 8 | project as described in the official Launchpad documentation and 9 | use it as a single entry point for reporting issues on your plugin 10 | and tracking development progress. 11 | 12 | All Fuel plugins must follow the following conventions: 13 | 14 | * The project name must be in the ``fuel-plugin-`` 15 | format. 16 | * The project page must link to the source plugin repository and its 17 | entry in `DriverLog `_. 18 | * The project teams must incorporate all development team members. 19 | * The milestones must repeat the plugin release specified in the 20 | ``metadata.yaml file``. For example, ``1.0.0``, ``2.0.0``. 21 | 22 | .. seealso:: 23 | 24 | - `List of existing Launchpad projects `_ 25 | - `Launchpad documentation `_ 26 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/file-ref/engine-yaml.rst: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _engine-yaml-ref: 8 | 9 | engine.yaml 10 | ----------- 11 | 12 | Fuel Master Node: 13 | **/root/provisioning_1** 14 | 15 | The *engine.yaml* file defines 16 | the basic configuration of the target nodes 17 | that Fuel deploys for the OpenStack environment. 18 | Initially, it contains Fuel defaults; 19 | these are adjusted in response to configuration choices 20 | the user makes through the Fuel UI 21 | and then fed to Nailgun. 22 | 23 | Usage 24 | +++++ 25 | 26 | #. Dump provisioning information using the following 27 | fuel command: 28 | 29 | :: 30 | 31 | fuel --env 1 provisioning default 32 | 33 | where ``--env 1`` should be set to the specific environment 34 | (id=1 in this example). 35 | 36 | 37 | #. Edit file. 38 | 39 | 40 | #. Upload the modified file: 41 | :: 42 | 43 | fuel --env-1 provisioning upload 44 | 45 | 46 | Description 47 | +++++++++++ 48 | 49 | The *engine.yaml* file defines the provisioning engine 50 | being used 51 | along with the password and URLs used to access it. By default, 52 | Cobbler is specified as the provisioning engine. 53 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run/nfv-launch-vm.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-launch-vm: 2 | 3 | Launch a virtual machine with workload acceleration 4 | --------------------------------------------------- 5 | 6 | After you created a specific VM flavor as described in 7 | :ref:`nfv-create-flavor` and configured an SR-IOV port as 8 | described in :ref:`nfv-create-sriov-port` (for SR-IOV only), 9 | you can launch a virtual machine that supports DPDK and SR-IOV 10 | NFV features. 11 | 12 | **To launch a virtual machine with workload acceleration:** 13 | 14 | #. Log in to Horizon. 15 | #. On the :guilabel:`Source` screen, select a virtual machine template in 16 | QCOW2 format. 17 | #. On the :guilabel:`Flavor` screen, select a flavor that has 18 | workload-accelerated features enabled. 19 | #. Select from the following options: 20 | 21 | * If you want to use DPDK, on the :guilabel:`Networks` screen, select the 22 | ``admin_internal_net``. 23 | * If you want to use SR-IOV, on the :guilabel:`Network Ports` screen, 24 | select the SR-IOV port that you have created in 25 | :ref:`nfv-create-sriov-port`. 26 | #. Launch the instance. 27 | #. Proceed to :ref:`nfv-associate-floating-ip`. 28 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_network_template.rst: -------------------------------------------------------------------------------- 1 | .. _cli-network-template: 2 | 3 | ==================================== 4 | Network template management commands 5 | ==================================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes network template management commands 10 | available in the Fuel CLI. 11 | 12 | .. list-table:: **Network template management commands** 13 | :widths: 10 10 20 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | - Example 19 | * - Upload a network template. 20 | - ``fuel --env network-template --upload --dir `` 21 | - .. code-block:: console 22 | 23 | fuel --env 1 network-template --upload --dir /home/stack/ 24 | 25 | * - Download a network template to the current directory. 26 | - ``fuel --env network-template --download`` 27 | - .. code-block:: console 28 | 29 | fuel --env 1 network-template --download 30 | * - Delete a network template. 31 | - ``fuel --env network-template --delete`` 32 | - .. code-block:: console 33 | 34 | fuel --env 1 network-template --delete 35 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/repository-workflow.rst: -------------------------------------------------------------------------------- 1 | .. _repository-workflow: 2 | 3 | Repository workflow 4 | ------------------- 5 | 6 | As a plugin developer, your repository workflow must be the following: 7 | 8 | #. Start your plugin development in your own repository open to public. 9 | The repository can be any public Git hosting; for example, GitHub. 10 | 11 | #. When you are ready to put your developed plugin project to the official 12 | repository in the OpenStack namespace, you need to do the following: 13 | 14 | * Have your code reviewed by the `Fuel team `_. 15 | You can also request a review in the #fuel-dev channel in IRC. You are welcome 16 | to request peer review from the members of your development team. 17 | * Plan to set up a CI for the plugin. See :ref:`plugin-ci`. 18 | * Confirm that you are going to support the plugin for more than one 19 | version of Fuel. 20 | * Confirm that you are releasing your plugin code under the Apache 2.0 21 | license. 22 | * Confirm your plugin code has no binary files. 23 | * Request repository creation in the OpenStack namespace. 24 | See :ref:`plugin-repo`. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_provision.rst: -------------------------------------------------------------------------------- 1 | .. _cli-provision: 2 | 3 | ===================== 4 | Provisioning commands 5 | ===================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes the usage of the :command:`fuel provisioning` 10 | command available in the Fuel CLI usage. 11 | 12 | .. list-table:: **Provisioning commands** 13 | :widths: 7 10 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | * - Delete current provisioning data 19 | - ``fuel --env provisioning --delete`` 20 | * - Download current provisioning data 21 | - ``fuel --env provisioning --download`` 22 | * - Download default provisioning data 23 | - ``fuel --env provisioning --default`` 24 | * - Get default provisioning information for specific nodes 25 | - ``fuel --env provisioning --default --node `` 26 | * - Upload provisioning information to a specific directory 27 | - ``fuel --env provisioning -u --dir path/to/directory`` 28 | * - Download provisioning information to a specific directory 29 | - ``fuel --env provisioning -d --dir path/to/directory`` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst: -------------------------------------------------------------------------------- 1 | .. _deployment-information: 2 | 3 | =============================== 4 | Download deployment information 5 | =============================== 6 | 7 | Fuel stores detailed information about deployments in its database. 8 | You can download environment settings, network configuration, and serialized 9 | environment data, such as ``astute.yaml`` for all nodes used for a specific 10 | deployment. 11 | 12 | **To download the deployment information:** 13 | 14 | #. Log in to the Fuel Master node CLI. 15 | #. Obtain the ID of the deployment task using one of the following commands: 16 | 17 | .. code-block:: console 18 | 19 | fuel task 20 | fuel2 task list 21 | 22 | .. include:: /userdocs/snippets/notes/fuel2-task-list-filters.rst 23 | 24 | #. Download the deployment information: 25 | 26 | .. code-block:: console 27 | 28 | fuel2 task deployment-info download --file deployment-info.yaml 29 | fuel2 task settings download --file settings.yaml 30 | fuel2 task network-configuration download --file networks.yaml 31 | 32 | where ```` is the ID of the deployment task. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/file-ref/docker-template: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | 7 | .. _xxx-ref: 8 | 9 | xxx.yaml 10 | -------- 11 | 12 | Fuel Master Node: 13 | **/usr/lib/python2.6/site-packages/nailgun/fixtures* 14 | 15 | The *xxx.yaml* file defines 16 | the basic configuration of the target nodes 17 | that Fuel deploys for the OpenStack environment. 18 | Initially, it contains Fuel defaults; 19 | these are adjusted in response to configuration choices 20 | the user makes through the Fuel UI 21 | and then fed to :ref:`Nailgun`. 22 | 23 | Usage 24 | ~~~~~ 25 | 26 | #. Log into the nailgun :ref:`docker-term` container: 27 | :: 28 | 29 | dockerctl shell nailgun 30 | 31 | #. Edit file. 32 | 33 | #. Run the following commands to Nailgun 34 | to reread its settings and restart: 35 | :: 36 | 37 | manage.py dropdb && manage.py syncdb && manage.py loaddefault 38 | killall nailgund 39 | 40 | 41 | #. Exit the Nailgun docker container: 42 | :: 43 | 44 | exit 45 | 46 | #. Run the following commands to Nailgun 47 | to sync deployment tasks: 48 | :: 49 | 50 | fuel rel --sync-deployment-tasks --dir /etc/puppet 51 | 52 | File Format 53 | ~~~~~~~~~~~ 54 | 55 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/verify-networks.rst: -------------------------------------------------------------------------------- 1 | .. _verify-networks-ug: 2 | 3 | ============================ 4 | Verify network configuration 5 | ============================ 6 | 7 | After you configure network settings, verify your network configuration. 8 | Network verification tests connectivity between nodes through configured 9 | VLANs on the configured host interfaces. 10 | Additionally, Fuel verifies that no external DHCP servers interfere with 11 | the OpenStack environment deployment. 12 | If network verification fails, the possible reasons may include incorrect 13 | network configuration, hardware misconfiguration, such as VLAN tagging 14 | is disabled on the switch port, and so on. 15 | 16 | You must resolve all errors before you deploy an OpenStack environment. 17 | 18 | .. note:: 19 | Network verification does not test bond network interfaces. 20 | 21 | **To verify network configuration:** 22 | 23 | #. In the Fuel web UI, click :guilabel:`Networks`. 24 | #. Click :guilabel:`Connectivity Check`. 25 | #. Click :guilabel:`Verify Networks`. 26 | #. Resolve any network conflicts. 27 | #. Run the network verification again. 28 | 29 | .. seealso:: 30 | 31 | * :ref:`settings-ug` 32 | * :ref:`ug-network` 33 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_vip.rst: -------------------------------------------------------------------------------- 1 | .. _cli-vip: 2 | 3 | ============================== 4 | Virtual IP management commands 5 | ============================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes virtual IP management commands 10 | available in the Fuel CLI. 11 | 12 | .. list-table:: **Virtual IP management commands** 13 | :widths: 10 10 20 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | - Example 19 | * - Download a virtual IP (VIP) configuration for a specific environment 20 | to a specified file. 21 | 22 | Variables: 23 | 24 | * ```` - an environment ID 25 | * ```` - a name of the ``yaml`` file where to save a VIP 26 | configuration (optional). 27 | 28 | - ``fuel --env vip --download --file `` 29 | - .. code-block:: console 30 | 31 | fuel --env 1 vip --download --file vip.yaml 32 | * - Upload a VIP configuration for a specific environment from a 33 | specified file. 34 | - ``fuel --env vip --upload --file `` 35 | - .. code-block:: console 36 | 37 | fuel --env 1 vip --upload --file vip.yaml 38 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo/audit-enforce-changes.rst: -------------------------------------------------------------------------------- 1 | .. _audit-enforce-changes: 2 | 3 | Verify and enforce the changes 4 | ============================== 5 | 6 | You can check whether a file has been modified or not using 7 | the ``fuel2 audit`` command and then enforce application of 8 | the changed configuration if needed. 9 | 10 | Similarly to running a Fuel deployment workflows with the ``noop`` flag, 11 | the ``fuel2 audit`` command performs a dry-run of the applied 12 | changes and records Puppet resources that will be modified after 13 | applying the changes. 14 | 15 | **To verify and enforce the changes:** 16 | 17 | #. Verify the changes by performing a dry-run of the applied changes: 18 | 19 | :: 20 | 21 | fuel2 audit noop --env || --repo 22 | 23 | #. List the changes to Puppet resources: 24 | 25 | :: 26 | 27 | fuel2 audit list outofsync --task || --repo 28 | 29 | #. Redeploy (enforce) the environment with the new changes: 30 | 31 | :: 32 | 33 | fuel2 env redeploy 34 | 35 | #. Alternatively, you can perform a dry-run and redeployment 36 | in one go: 37 | 38 | :: 39 | 40 | fuel2 audit enforce --env || --repo 41 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/add-label.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _add-label-ug: 3 | 4 | Label an OpenStack node 5 | ----------------------- 6 | 7 | In large deployments, sorting nodes by roles may not be efficient. Therefore, 8 | Fuel provides the capability to add custom labels to OpenStack nodes and later 9 | sort and display the nodes with that label. For example, you can label nodes 10 | located in one rack as *rack #1* and so on. Labels can be added and removed 11 | before or after you deploy an OpenStack environment. 12 | 13 | **Label an OpenStack node:** 14 | 15 | #. Log in to the Fuel web UI. 16 | #. Click :guilabel:`Nodes`. 17 | #. Select a node or nodes that you want to label. 18 | #. Click the label icon. 19 | #. Click :guilabel:`Add label`. 20 | #. Type a :guilabel:`Name` and :guilabel:`Value`. 21 | 22 | **Example:** 23 | 24 | * **Name:** Row 25 | * **Value:** 1 26 | 27 | .. note:: 28 | You can have multiple labels with identical names and different 29 | values. However, you cannot assign labels with identical names 30 | and different values to one node. For example, you cannot assign 31 | label *Row 1* and *Row 2* to one node, but you can assign them to 32 | different nodes. 33 | #. Click :guilabel:`Apply`. 34 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/nfv/nfv-configure-sriov-nic.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-configure-sriov-nic: 2 | 3 | Configure SR-IOV network interface 4 | ---------------------------------- 5 | 6 | When configuring network for SR-IOV, you must place private network 7 | on a separate interface from the interface on which you enable SR-IOV. 8 | This enables VLAN network traffic to flow to Open vSwitch while having 9 | SR-IOV enabled. 10 | 11 | **To configure SR-IOV network interface:** 12 | 13 | #. Log in to the Fuel web UI. 14 | #. Click :guilabel:`Nodes`. 15 | #. Select the node on which you enable SR-IOV. 16 | #. Click :guilabel:`Configure Interfaces`. 17 | #. Drag and drop the Private network to a network interface. 18 | #. On a separate network interface, enable SR-IOV by clicking 19 | :guilabel:`Disabled` next to :guilabel:`SR-IOV`. 20 | #. Select the :guilabel:`Enabled` checkbox. 21 | #. Type the number of virtual functions that do not exceed the number 22 | provided by Fuel. 23 | #. Optionally, adjust the name of the physical network. 24 | #. Click :guilabel:`Apply`. 25 | #. Configure the rest of the environment settings as required and deploy 26 | the environment as described in :ref:`deploy-env`. 27 | 28 | .. seealso:: 29 | 30 | - :ref:`nfv-run-vm` 31 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/verify-environment/troubleshoot-health-checks.rst: -------------------------------------------------------------------------------- 1 | .. _troubleshoot-health-checks: 2 | 3 | Resolve a problem 4 | ----------------- 5 | 6 | If a test fails, there are several ways to investigate the problem. You can 7 | search for the information about the problem in the logs of each OpenStack 8 | component, as well as in the test logs. 9 | 10 | **To resolve a health check issue:** 11 | 12 | #. Verify that all OpenStack services are up and running. 13 | 14 | * In the Fuel web UI: 15 | 16 | #. Click :guilabel:`Health Check`. 17 | #. Run the Sanity tests. 18 | 19 | * In the Fuel CLI: 20 | 21 | #. View the list of services: 22 | 23 | :: 24 | 25 | nova-manage service list 26 | 27 | #. If any of the services have the *XXX* status, restart these 28 | services: 29 | 30 | :: 31 | 32 | service openstack- restart 33 | 34 | #. Analyze error messages in :guilabel:`Dashboard`, :guilabel:`Networks`, 35 | and other tabs, if any. 36 | 37 | For example, a test may fail for the following reasons: 38 | 39 | * A quota has been exceeded 40 | * Network configuration is incorrect 41 | * A general lack of resources, such as memory or disk space. 42 | 43 | #. Analyze the log files. 44 | 45 | -------------------------------------------------------------------------------- /devdocs/develop/nailgun/development/ui_dependencies.rst: -------------------------------------------------------------------------------- 1 | Managing UI Dependencies 2 | ======================== 3 | 4 | The dependencies of Fuel UI are managed by NPM_. 5 | 6 | Used NPM packages are listed in *dependencies* and *devDependencies* sections 7 | of a package.json file. To install all required packages, run:: 8 | 9 | npm install 10 | 11 | To use gulp_ you also need to install the gulp package globally:: 12 | 13 | sudo npm install -g gulp 14 | 15 | To add a new package, it is not enough just to add a new entry to a 16 | package.json file because npm-shrinkwrap_ is used to lock down package 17 | versions. First you need to install the clingwrap package globally: 18 | 19 | sudo npm install -g clingwrap 20 | 21 | Then install required package:: 22 | 23 | npm install --save some-package 24 | 25 | Then run:: 26 | 27 | clingwrap some-package 28 | 29 | to update npm-shrinkwrap.json. 30 | 31 | Alternatively, you can completely regenerate npm-shrinkwrap.json by running:: 32 | 33 | rm npm-shrinkwrap.json 34 | rm -rf node_modules 35 | npm install 36 | npm shrinkwrap --dev 37 | clingwrap npmbegone 38 | 39 | .. _npm: https://www.npmjs.org/ 40 | .. _gulp: http://gulpjs.com/ 41 | .. _npm-shrinkwrap: https://www.npmjs.org/doc/cli/npm-shrinkwrap.html 42 | -------------------------------------------------------------------------------- /_templates/openstackdocs/navigation.html: -------------------------------------------------------------------------------- 1 | 30 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/fuel-web-ui.rst: -------------------------------------------------------------------------------- 1 | ==================== 2 | Fuel web UI features 3 | ==================== 4 | 5 | Fuel Newton includes a number of enhancements related to the Fuel web UI. 6 | 7 | Custom deployment workflows management 8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9 | 10 | Extended the Fuel web UI with an ability to manage custom deployment 11 | workflows. Now, you can list, remove, upload, download, and execute custom 12 | deployment workflows in the :guilabel:`Dashboard` and :guilabel:`Workflows` 13 | tabs on the :guilabel:`Environments` page. 14 | 15 | See :ref:`workflows_manage` | `blueprint `__ 16 | 17 | Deployment details overview 18 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 19 | 20 | Enabled the capability to view details about deployments for specific 21 | OpenStack environments and their nodes in the Fuel web UI: 22 | 23 | * To view a deployment task in progress, click :guilabel:`Show Details` 24 | under the deployment progress bar on the :guilabel:`Dashboard` tab. 25 | * To view information about a deployed OpenStack environment, go to 26 | the :guilabel:`History` tab and select the required deployment. 27 | 28 | See :ref:`view_history` | `blueprint `__ -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows.rst: -------------------------------------------------------------------------------- 1 | .. _workflow-intro: 2 | 3 | Modify the deployment workflow 4 | ============================== 5 | 6 | A deployment workflow, or deployment graph, is an hierarchy of 7 | deployment tasks with dependencies that Fuel executes to deploy 8 | an OpenStack environment. 9 | A deployment graph enables you to execute complex orchestrated workflows, 10 | such as bugfixes application, reference architecture altering, or upgrades 11 | in a particular order. For example, you can enable specific 12 | network verification tasks for a Fuel plugin or change the default image 13 | delivering protocol (HTTP) for OpenStack nodes provisioning, and so on. 14 | 15 | .. warning:: 16 | This section describes advanced usage and requires the user to deeply 17 | understand Fuel internals. Do not modify deployment workflows if you are 18 | deploying an OpenStack environment for the first time. 19 | 20 | This section includes the following topics: 21 | 22 | .. toctree:: 23 | :maxdepth: 1 24 | 25 | workflows/workflows-overview.rst 26 | workflows/workflows-precedence.rst 27 | workflows/workflows-create.rst 28 | workflows/workflows-data-driven.rst 29 | 30 | .. seealso:: 31 | 32 | - :ref:`workflows_manage` 33 | - :ref:`cli-workflows` 34 | - :ref:`data-driven` 35 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/nfv-run/nfv-create-flavor.rst: -------------------------------------------------------------------------------- 1 | .. _nfv-create-flavor: 2 | 3 | Create a workload-accelerated instance flavor 4 | --------------------------------------------- 5 | 6 | If you have enabled such NFV features as SR-IOV or/and DPDK during the 7 | environment deployment, you can create workload-accelerated instance flavors 8 | and use them to deploy virtual machines with 9 | mission-crtitical applications. 10 | 11 | **To create a workload-accelerated instance flavor:** 12 | 13 | #. Log in to Horizon. 14 | #. Select :menuselection:`System --> Flavors`. 15 | #. Click :guilabel:`Create Flavor`. 16 | #. In the Create Flavor wizard, specify number of vCPUs, RAM, and Root 17 | Disk size. 18 | #. Click :guilabel:`Create Flavor`. 19 | #. On the :guilabel:`Flavors` screen, click :guilabel:`No` under 20 | metadata for the flavor you created in previous step. 21 | #. Add the required metadata parameters and values. 22 | 23 | **Example:** 24 | 25 | * ``hw:mem_page_size`` - large 26 | * ``hw:cpu_policy`` - dedicated 27 | 28 | #. If you plan to use DPDK, proceed to :ref:`nfv-launch-vm`. 29 | #. If you plan to use SR-IOV, proceed to :ref:`nfv-create-sriov-port`. 30 | 31 | .. seealso:: 32 | 33 | - `OpenStack Administrator Guide 34 | `_ 35 | -------------------------------------------------------------------------------- /userdocs/release-notes/new-features/vmware-certificate.rst: -------------------------------------------------------------------------------- 1 | ===================================================== 2 | Verification of the VMware vCenter server certificate 3 | ===================================================== 4 | 5 | Added a capability to specify a Certificate Authority (CA) bundle file 6 | to use for verifying the VMware vCenter server certificate for 7 | the OpenStack Compute service, OpenStack Block Storage service, and 8 | OpenStack Image service. 9 | 10 | Depending on the needs of your environment, you can configure the VMware 11 | vCenter server certificate verification on the :guilabel:`VMware` tab in 12 | the Fuel web UI: 13 | 14 | * If you plan to deploy an environment for testing purposes or want 15 | to speed up the deployment process, you can disable the certificate 16 | verification by checking 17 | :guilabel:`Bypass vCenter certificate verification`. 18 | 19 | * If VMware vCenter is using a self-signed certificate, upload a CA 20 | certificate in the :guilabel:`CA file` field. 21 | Leave :guilabel:`Bypass vCenter certificate verification` unchecked. 22 | 23 | * If a VMware vCenter server certificate is emitted by a known CA, 24 | for example, GeoTrust, leave the :guilabel:`CA file` field empty 25 | and :guilabel:`Bypass vCenter certificate verification` unchecked. 26 | 27 | See :ref:`configure-vmware-vcenter-settings` -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/upgrade/upgrade-liberty.rst: -------------------------------------------------------------------------------- 1 | .. _upgrade_liberty: 2 | 3 | ============================== 4 | Upgrade Fuel Liberty to Mitaka 5 | ============================== 6 | 7 | You can upgrade the Fuel Master node from Liberty to Mitaka. 8 | After you upgrade Fuel, you can only deploy new environments of the 9 | corresponding Fuel version. Environments deployed using older versions 10 | of Fuel will remain operational. 11 | 12 | **To upgrade the Fuel Master node:** 13 | 14 | #. Verify that no installations are in progress in any of your OpenStack 15 | environments. 16 | #. Back up the Fuel Master node as described in :ref:`back-up-fuel`. 17 | #. Power off the Fuel Master node. 18 | #. Restore the Fuel Master node as described in :ref:`restore-fuel`. 19 | #. If you want to use CentOS-based bootstrap, rebuild the bootstrap image: 20 | 21 | .. code-block:: console 22 | 23 | $ octane update-bootstrap-centos 24 | 25 | #. Reboot all nodes that are in the ``Discover`` status. 26 | 27 | When Fuel completes the upgrade procedure, the *New Release available* 28 | message appears in the :guilabel:`Releases` tab. 29 | 30 | Now, you can update to the latest Mitaka version that includes some features 31 | back-ported from Newton after the Mitaka release. 32 | 33 | .. seealso:: 34 | 35 | * :ref:`update_fuel` 36 | * :ref:`install_configure_bootstrap` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_management.rst: -------------------------------------------------------------------------------- 1 | .. _cli-management: 2 | 3 | ======================== 4 | Fuel management commands 5 | ======================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes basic management commands 10 | available in the Fuel CLI. 11 | 12 | .. list-table:: **Management and help commands** 13 | :widths: 10 10 20 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | - Example 19 | * - View the list of all global optional arguments and namespaces. 20 | - ``fuel --help`` 21 | - View the list of actions and optional arguments for a namespace: 22 | 23 | .. code-block:: console 24 | 25 | fuel --help 26 | * - View the list of all available releases 27 | - ``fuel release`` 28 | 29 | ``fuel rel`` 30 | - View the information about a specific release: 31 | 32 | .. code-block:: console 33 | 34 | fuel rel --rel 35 | 36 | * - Get the information about the Fuel version. 37 | - ``fuel fuel-version`` 38 | - 39 | * - Change the Fuel password. You can use the ``--user=admin`` and 40 | ``--password=test`` flags to provide user name and password with 41 | all Fuel CLI commands. 42 | - ``fuel user --change-password --new-pass=`` 43 | - 44 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates.rst: -------------------------------------------------------------------------------- 1 | .. _network-templates-intro: 2 | 3 | Deploy network configurations using network templates 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | By default, Fuel configures the following networks (Linux bridges): Public, 7 | Private, Storage, Admin (PXE), and Management. In addition, if you install the 8 | OpenStack Bare Metal service, Fuel creates the Baremetal network. If you need 9 | to add a custom network or do not need any of the default networks, you can 10 | configure or delete the required networks through network templates. 11 | 12 | Network templates enable you to: 13 | 14 | * Create a custom set of networks. 15 | * Create mappings of network roles to networks. 16 | * Use a network on a specific node only if a corresponding node role is 17 | configured on the node 18 | * Implement custom networking topologies, such as sub-interface bonding, 19 | and so on. 20 | 21 | This section includes the following topics: 22 | 23 | .. toctree:: 24 | :maxdepth: 1 25 | 26 | network-templates/network-templates-overview.rst 27 | network-templates/network-templates-limitations.rst 28 | network-templates/network-templates-structure.rst 29 | network-templates/network-templates-create.rst 30 | network-templates/network-templates-delete.rst 31 | network-templates/network-templates-examples.rst 32 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/select-bootable-device.rst: -------------------------------------------------------------------------------- 1 | .. _select-bootable-device: 2 | 3 | =================================== 4 | Select a bootable device for a node 5 | =================================== 6 | 7 | By default, Fuel boots the first disk it detects. 8 | 9 | **To select a bootable device:** 10 | 11 | * Using the Fuel web UI: 12 | 13 | #. Log in to the Fuel web UI. 14 | #. Click the :guilabel:`Nodes` tab. 15 | #. In :guilabel:`Disk Configuration`, select the required disk as bootable. 16 | 17 | * Using the Fuel CLI: 18 | 19 | #. Log in to the Fuel Master node CLI. 20 | #. Download the configuration file of the node: 21 | 22 | .. code-block:: console 23 | 24 | fuel node --node-id --disk --download 25 | 26 | #. In the ``disks.yaml``, set ``bootable: True`` for the required node's 27 | disk. For example: 28 | 29 | .. code-block:: yaml 30 | 31 | id: vda 32 | name: vda 33 | bootable: True 34 | size: 50380 35 | volumes: 36 | - keep_data: false 37 | 38 | .. note:: 39 | 40 | Only one disk can have the ``bootable: True`` attribute at the same 41 | time. Otherwise, an error will occur on the settings upload. 42 | 43 | #. Upload the changes: 44 | 45 | .. code-block:: console 46 | 47 | fuel node --node-id --disk --upload 48 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/install/install_before_you_install_fuel.rst: -------------------------------------------------------------------------------- 1 | .. _install_before_you_install_fuel: 2 | 3 | Before you install Fuel 4 | ----------------------- 5 | 6 | Before you install Fuel, verify that you have completed the following tasks: 7 | 8 | #. Read and complete the tasks described in the following sections: 9 | 10 | * :ref:`intro_install_overview` 11 | * :ref:`sysreq_intro` 12 | 13 | #. If you use bare-metal hardware, set up and connect all hardware. 14 | #. If you use virtual hardware, configure all required virtual machines, 15 | network, and storage parameters. 16 | #. Select a workflow: 17 | 18 | * If you install Fuel on a server with an Internet connection, follow this 19 | workflow: 20 | 21 | .. image:: /_images/deliverables/d_install_w_internet.png 22 | :width: 70% 23 | :align: center 24 | 25 | * If you install Fuel on a server without an Internet connection, you must 26 | configure a local repository and modify the default Fuel repositories, so 27 | that Fuel installs the operating system packages from the local 28 | repositories. Therefore, follow this workflow: 29 | 30 | .. image:: /_images/deliverables/d_install_wo_internet.png 31 | :width: 70% 32 | :align: center 33 | 34 | * If you install Fuel from on of RPM mirrors, follow this workflow: 35 | 36 | .. image:: /_images/deliverables/d_install_rpm.png 37 | :width: 70% 38 | :align: center 39 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/install_install_fuel.rst: -------------------------------------------------------------------------------- 1 | .. _install_intro: 2 | 3 | Install Fuel 4 | ============ 5 | 6 | This section describes how to install Fuel on virtual or 7 | bare-metal hardware. During the installation, you deploy the Fuel Master node 8 | on the selected hardware and boot the servers or virtual machines that are 9 | dedicated as Fuel Slave nodes. However, you do not install an operating 10 | system or OpenStack components on the Fuel Slave nodes just yet. After you 11 | deploy the Fuel Master node, you create an OpenStack environment using the 12 | Fuel web UI or Fuel CLI. The Fuel Master node provisions the dedicated Fuel 13 | Slave nodes with the selected operating system, OpenStack or other 14 | components and roles when you deploy an OpenStack environment. 15 | 16 | If you install Fuel on VMware vSphere, see: :ref:`vsphere_intro`. 17 | 18 | This section includes the following topics: 19 | 20 | .. toctree:: 21 | :maxdepth: 2 22 | 23 | install/install_before_you_install_fuel 24 | install/install_download_iso 25 | install/install_prepare_install_media 26 | install/install_install_fuel_master_node 27 | install/install_set_up_fuel 28 | install/install_change_network_interface 29 | install/install_login_fuel_master_node 30 | install/install_login_fuel_master_node_multiple_nics 31 | install/install_boot_slave_nodes 32 | 33 | .. seealso:: 34 | 35 | * :ref:`update_fuel` -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/config-drive-format.rst: -------------------------------------------------------------------------------- 1 | .. _config-drive-format: 2 | 3 | Change the configuration drive format 4 | ------------------------------------- 5 | 6 | For legacy reasons, Fuel uses the VFAT configuration drive format which is the 7 | default option for live migration. But as the default format of the 8 | configuration drive for OpenStack environments is ISO 9660, you can change the 9 | VFAT to the ISO 9660 format using the ``config_drive_format`` option. 10 | 11 | **To change the configuration drive format using Fuel CLI:** 12 | 13 | #. Log in to the Fuel Master node CLI. 14 | #. Download the configuration files: 15 | 16 | .. code-block:: console 17 | 18 | fuel --env= deployment --default 19 | 20 | The default deployment information is downloaded to 21 | ``//deployment_``. 22 | 23 | #. Edit *every* ``.yaml`` file: 24 | 25 | #. Find or add the ``compute`` section to the ``.yaml`` file. 26 | #. In this section, add the following parameter: 27 | 28 | .. code-block:: console 29 | 30 | compute: 31 | config_drive_format option: iso9660 32 | 33 | #. Upload the updated configuration files to the ``//deployment_`` 34 | directory: 35 | 36 | .. code-block:: console 37 | 38 | fuel --env= deployment --upload 39 | 40 | Now, you can proceed with the environment deployment. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows/workflows-create/examples/workflows-swap-task.rst: -------------------------------------------------------------------------------- 1 | .. _workloads-replace-task: 2 | 3 | Replace a task 4 | -------------- 5 | 6 | You can replace a task with a custom task in the 7 | ``task.yaml`` file by replacing the path to the executable 8 | file. 9 | 10 | **To replace a task:** 11 | 12 | #. Log in to Fuel CLI: 13 | #. Open the ``task.yaml`` file for editing. 14 | #. Replace the path to the path to the executable file: 15 | 16 | .. code-block:: console 17 | 18 | - id: netconfig 19 | type: puppet 20 | groups: [primary-controller, controller, cinder, compute, ceph-osd, 21 | zabbix-server, primary-mongo, mongo] 22 | required_for: [deploy_end] 23 | requires: [logging] 24 | parameters: 25 | # old puppet manifest 26 | # puppet_manifest: /etc/puppet/modules/osnailyfacter/netconfig.pp 27 | 28 | puppet manifest: 29 | /etc/puppet/modules/osnailyfacter/custom_network_configuration.pp 30 | puppet_modules: /etc/puppet/modules 31 | timeout: 3600 32 | 33 | #. Synchronize deployment tasks: 34 | 35 | .. code-block:: console 36 | 37 | fuel rel --sync-deployment-tasks --dir 38 | 39 | **Example:** 40 | 41 | .. code-block:: console 42 | 43 | fuel rel --sync-deployment-tasks --dir /etc/puppet/mitaka-9.0/ 44 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/intro/intro_planning_your_environment.rst: -------------------------------------------------------------------------------- 1 | .. _intro_planning: 2 | 3 | Planning your environment 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | Before you install Fuel and OpenStack, determine what type of 7 | configuration addresses your business needs. You must understand 8 | how OpenStack will integrate and communicate with existing components 9 | in your IT infrastructure, as well as calculate resources required to process 10 | estimated workloads. 11 | 12 | If you are testing Fuel and OpenStack in a lab environment, you can 13 | skip the planning and deploy the default configuration. However, for a 14 | production environment, you must decide on the following: 15 | 16 | * Network topology and IP address management plan 17 | * Storage 18 | * Number, type, and flavor of compute, controller, storage, and other nodes 19 | * Monitoring facilities 20 | * Additional components: Sahara and Murano 21 | * Fuel plug-ins 22 | 23 | This guide explains what OpenStack configurations you can deploy using Fuel, 24 | as well as briefly describes guidelines and examples on how to plan resources 25 | for your environment. However, we recommend that you read `OpenStack 26 | Architecture Design Guide `__, 27 | so you can better estimate your network, storage, and compute requirements. 28 | 29 | .. seealso:: 30 | 31 | - :ref:`System requirements ` 32 | 33 | 34 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/cgroups/cgroups-modify-single-node.rst: -------------------------------------------------------------------------------- 1 | .. _cgroups-modify-single-node: 2 | 3 | Modify control groups for a single node 4 | +++++++++++++++++++++++++++++++++++++++ 5 | 6 | If you want to change the control group settings on a single node, you must 7 | edit the control groups configuration file ``/etc/cgconfig.conf``, as well 8 | as create, if needed, and configure the ``/etc/cgrules.conf`` file. 9 | You can modify control groups before or after you deploy an OpenStack 10 | environment. 11 | 12 | **To modify control groups for a single node:** 13 | 14 | #. Log in to the CLI of corresponding node. 15 | #. Open the ``/etc/cgconfig.conf`` file for editing. 16 | #. Apply the required changes. 17 | #. Save and exit. 18 | #. Add the corresponding parameters to the ``/etc/cgrules.conf`` file. 19 | 20 | **Example:** 21 | 22 | .. code-block:: console 23 | 24 | * :keystone-api cpu keystone-api 25 | * :mysqld cpu mysqld 26 | 27 | #. Restart ``cgconfigparser``: 28 | 29 | .. code-block:: console 30 | 31 | service cgconfigparser restart 32 | 33 | #. For each running process, type: 34 | 35 | .. code-block:: console 36 | 37 | cgclassify 'pidof -x ' 38 | 39 | #. Restart ``cgrulesengd``: 40 | 41 | .. code-block:: console 42 | 43 | service cgrulesengd restart 44 | 45 | .. seealso:: 46 | 47 | - :ref:`cgroups-example` 48 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/vsphere/vsphere_configure_network.rst: -------------------------------------------------------------------------------- 1 | .. _vsphere_configure_network: 2 | 3 | Configure networks 4 | ------------------ 5 | 6 | To enable inter-node communication, you must configure networks on 7 | VMware vCenter. 8 | 9 | Configure a network for Fuel Admin (PXE) traffic 10 | ++++++++++++++++++++++++++++++++++++++++++++++++ 11 | 12 | You must configure a network for the Fuel Admin (PXE) traffic 13 | and enable Promiscuous mode. 14 | 15 | **To configure a network for the Fuel Admin (PXE) traffic:** 16 | 17 | #. Go to the vCenter screen. 18 | #. Choose **Hosts**. 19 | #. Select the host on which you want to run the Fuel Master node. 20 | #. Click the **Networking** button. 21 | #. Click the **Add Host Networking** icon. 22 | 23 | Create a vCenter Port Group network 24 | +++++++++++++++++++++++++++++++++++ 25 | 26 | You must create a Port Group with Promiscuous mode. 27 | 28 | **To create a vCenter Port Group network:** 29 | 30 | #. Choose a Port Group connection type. 31 | #. Choose a switch. 32 | #. Name your network and set the VLAN number. This is optional 33 | and depends on your underlying network infrastructure. 34 | #. After the network is created, select the network on the network map; 35 | then click the **Edit Settings** icon. 36 | #. Click **Security**. 37 | #. Verify that the **Promiscuous mode** is set to **Accept**. 38 | #. Click "OK". 39 | #. Proceed to :ref:`vsphere_create_vm`. 40 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/network-templates/network-templates-examples.rst: -------------------------------------------------------------------------------- 1 | .. _network-templates-examples: 2 | 3 | Network template examples 4 | ========================= 5 | 6 | This section provides examples of network configurations 7 | using network templates. You can use the default template 8 | and modify it for your requirements or use any of the templates provided 9 | in the `network templates folder `_. 10 | 11 | The following table describes network template examples: 12 | 13 | .. list-table:: **Examples of network templates** 14 | :widths: 10 10 15 | :header-rows: 1 16 | 17 | * - Template 18 | - Description 19 | * - ``default.yaml`` 20 | - The default network template deploys the basic configuration that you 21 | can deploy using the Fuel web UI. You can use this template to create 22 | your own network template. Additional information about network 23 | configuration using network templates provided in the file. 24 | * - ``one_network.yaml`` 25 | - A network template that describes a configuration in which one network 26 | serves all traffic. 27 | * - ``two_networks.yaml`` 28 | - A network template that describes a configuration in which all traffic 29 | is served by two networks. 30 | 31 | .. toctree:: 32 | :maxdepth: 1 33 | 34 | examples/one-network.rst 35 | examples/two-networks.rst 36 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst: -------------------------------------------------------------------------------- 1 | .. _run_workflows: 2 | 3 | ========================= 4 | Run a deployment workflow 5 | ========================= 6 | 7 | Fuel enables you to execute deployment workflows using the Fuel web UI 8 | or Fuel CLI. 9 | 10 | **To execute a deployment workflow using the Fuel web UI:** 11 | 12 | #. Log in to the Fuel web UI. 13 | #. Select the required OpenStack environment. 14 | #. Verify that online nodes are added to the environment. 15 | #. Select from the following options: 16 | 17 | * To run the default deployment workflow: 18 | 19 | #. Go to the :guilabel:`Dashboard` tab. 20 | #. Click :guilabel:`Deploy changes`. 21 | 22 | * To run a custom deployment workflow: 23 | 24 | #. Upload a custom deployment workflow as described in 25 | :ref:`upload_workflows`. 26 | #. Go to the :guilabel:`Dashboard` tab. 27 | #. Change the deployment mode to :guilabel:`Custom Workflow` 28 | #. Select a particular workflow to run and specify the nodes 29 | the workflow should be executed on. 30 | 31 | **To execute a deployment workflow using the Fuel CLI:** 32 | 33 | #. Log in to the Fuel CLI. 34 | #. Execute the required workflow using the :command:`fuel2 graph execute` 35 | command. 36 | 37 | **Example:** 38 | 39 | .. code-block:: console 40 | 41 | fuel2 graph execute --env 1 42 | 43 | .. seealso:: 44 | 45 | * :ref:`cli-workflows` -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/how-plugins-work.rst: -------------------------------------------------------------------------------- 1 | .. _how-plugins-work: 2 | 3 | About Fuel plugins 4 | ================== 5 | 6 | You can extend the functionality of your OpenStack environment through Fuel 7 | plugins. Some Fuel plugins eliminate the need to install drivers and patches 8 | manually after Fuel deploys an OpenStack environment, while others 9 | enable users to configure additional capabilities, such as additional storage 10 | types and networking functionality. For example, the 11 | `Load Balancing as a Service (LBaaS) `_ 12 | plugin allows you to add network load balancing functionality to your cloud, 13 | so that incoming traffic can be spread across multiple nodes. You can use the 14 | `Nova NFS plugin `_ 15 | so that you can use `NFS `_ 16 | as a storage backend for Nova ephemeral volumes. There is a number of Fuel 17 | plugins available to download for free 18 | in `DriverLog `_. 19 | 20 | In addition, Fuel offers an open source framework that enables developers to 21 | create their own plugins and extend their environment functionalities as 22 | required. For example, hardware vendors can benefit from using the plugin 23 | framework by creating plugins that deploy custom drivers and enable OpenStack 24 | to run on custom hardware. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/cgroups/cgroups-modify-multiple-nodes.rst: -------------------------------------------------------------------------------- 1 | .. _cgroups-modify-multiple-nodes: 2 | 3 | Modify control groups for multiple nodes 4 | ++++++++++++++++++++++++++++++++++++++++ 5 | 6 | You can modify ``cgroups`` for a particular process on multiple nodes by 7 | creating a separate file with the ``cgroups`` configuration, uploading 8 | the new configuration file to fuel, and restarting the ``cgroups`` task. 9 | You can modify control groups before or after you deploy an OpenStack 10 | environment. 11 | 12 | **To modify control groups for multiple nodes:** 13 | 14 | #. Log in to the Fuel Master node CLI. 15 | #. Download the Fuel configuration: 16 | 17 | .. code-block:: console 18 | 19 | fuel settings --env-id --download 20 | 21 | #. Open the ``settings.yaml`` file for editing. 22 | #. Copy the ``cgroups`` section. 23 | #. Create a ``.yaml`` file with the same name as the ``.yaml`` 24 | file that you have downloaded in step 2. 25 | #. Paste the copied ``cgroups`` configuration into the file. 26 | #. Edit as required.. 27 | 28 | #. Upload the new configuration file to Fuel: 29 | 30 | .. code-block:: console 31 | 32 | fuel settings --dir --env-id --upload 33 | 34 | #. Restart the ``cgroups`` task: 35 | 36 | .. code-block:: console 37 | 38 | fuel node --node-id --tasks cgroups 39 | 40 | .. seealso:: 41 | 42 | - :ref:`cgroups-example` 43 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/deploy-environment/provision-environment.rst: -------------------------------------------------------------------------------- 1 | .. _provision-environment: 2 | 3 | ================================== 4 | Provision an OpenStack environment 5 | ================================== 6 | 7 | Fuel enables you to provision all your OpenStack environment nodes or 8 | a particular set of nodes before you deploy an OpenStack environment. 9 | You can start a separate provisioning task for on-line discovered (not 10 | provisioned and not deployed) environment nodes. 11 | 12 | After you successfully provision the environment nodes, run a separate 13 | deployment as described in :ref:`deploy-changes`. Such deployment 14 | affects all on-line provisioned and not yet deployed OpenStack environment 15 | nodes. Nodes with the ``error`` status are also considered as not deployed. 16 | 17 | **To provision an OpenStack environment:** 18 | 19 | #. In the Fuel web UI, click the :guilabel:`Dashboard` tab. 20 | #. Verify you have added nodes to your OpenStack environment as described 21 | in :ref:`add-nodes-ug`. 22 | #. Set the :guilabel:`Deployment mode` to :guilabel:`Provisioning Only`. 23 | #. Proceed with one of the following options to start the provisioning: 24 | 25 | * If you want to provision all nodes, click :guilabel:`Provision Nodes`. 26 | * If you want to provision specific nodes: 27 | 28 | #. Unfold :guilabel:`Choose nodes for provisioning` and 29 | select nodes. 30 | For example, controller, compute, or other nodes. 31 | #. Click :guilabel:`Provision Nodes`. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_change_ip_range.rst: -------------------------------------------------------------------------------- 1 | .. _cli_change_ip_range: 2 | 3 | ================== 4 | Add network ranges 5 | ================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | To add network ranges, edit the network configuration file: 10 | add the IP network range to ``ip_ranges`` and change 11 | ``notation`` from ``cidr`` to ``ip_ranges``. 12 | 13 | Step-by-step: 14 | 15 | #. On the Fuel Master node, download the network configuration file:: 16 | 17 | fuel network --env -d 18 | 19 | where is the ID of the environment (a number) that you can 20 | get by issuing the ``fuel env`` command. 21 | 22 | For example:: 23 | 24 | fuel network --env 1 -d 25 | 26 | #. Open the downloaded **/root/network_.yaml** file for editing. 27 | #. Add your list of IP network ranges under the ``ip_ranges`` 28 | parameter. 29 | 30 | Sample:: 31 | 32 | ip_ranges: 33 | - - 192.168.0.1 34 | - 192.168.0.90 35 | - - 192.168.0.100 36 | - 192.168.0.254 37 | 38 | #. In the same network configuration file, change ``notation: cidr`` 39 | to ``notation: ip_ranges``. 40 | 41 | Sample:: 42 | 43 | meta: 44 | cidr: 192.168.0.0/24 45 | configurable: true 46 | map_priority: 2 47 | name: management 48 | notation: ip_ranges 49 | render_addr_mask: internal 50 | 51 | #. Upload the edited network configuration file:: 52 | 53 | fuel network --env -u 54 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/manage-environment/cgroups/cgroups-example.rst: -------------------------------------------------------------------------------- 1 | .. _cgroups-example: 2 | 3 | Example of the control groups configuration 4 | ------------------------------------------- 5 | 6 | The following text is an example of the section 7 | in the ``settings.yaml`` file that describes the ``cgroups`` 8 | configuration: 9 | 10 | .. code-block:: console 11 | 12 | editable: 13 | cgroups: 14 | mysqld: 15 | label: mysqld 16 | type: text 17 | value: '{"memory":{"memory.swappiness":0, "memory.limit_in_bytes":"%95, 18 | 2048, 4096"}, , "cpu":{"cpu.shares":100}}' 19 | beam.smp: 20 | label: rabbitmq 21 | type: text 22 | value: '{"memory":{"memory.swappiness":0}, "cpu":{"cpu.shares":400, 23 | "cpu.cfs_quota_us":25000}}' 24 | cinder-volume: 25 | label: cinder-volume 26 | type: text 27 | value: '{"blkio":{"blkio.weight":1000}}' 28 | nova-api: 29 | label: nova-api 30 | type: text 31 | value: '{"cpu":{"cpu.shares":700}}' 32 | neutron-server: 33 | label: neutron-server 34 | type: text 35 | value: '{"cpuset":{"cpuset.sched_load_balance":0,"cpuset.cpus":1, 36 | "cpuset.mems":0}}' 37 | metadata: 38 | always_editable: true 39 | group: general 40 | label: Cgroups conguration for services 41 | restrictions: 42 | - action: hide 43 | condition: 'true' 44 | weight: 90 45 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/create-environment/autotests/autotests-files.rst: -------------------------------------------------------------------------------- 1 | .. _autotests-files: 2 | 3 | Automation test files 4 | --------------------- 5 | 6 | Main files and modules: 7 | 8 | * ``system_tests.sh`` - The file where tests start execution. This file processes 9 | the parameters specified from the command line and invokes ``run_tests.py``. 10 | * ``run_tests.py`` - Used to import your test files inside this file to run your 11 | test. 12 | * ``settings.py`` - Contains environment variables used for environment 13 | customization. With this file, you can set such variables as path to ISO, 14 | nodes quantity, etc. 15 | * ``environment.py`` - Contains methods for environment deploying, virtual machines 16 | creation and networking, installation of Fuel on the Fuel Master node, etc. 17 | * ``nailgun_client.py`` - Contains functionality for nailgun handlers, methods and 18 | API that are supported by the nailgun client. The nailgun client uses the 19 | HTTP client that located in the ``helpers`` folder. The nailgun client is 20 | used in the Fuel web client. 21 | * ``checkers.py`` - Has methods for the SSH client to verify nodes access. 22 | * ``common.py`` - Has methods for OpenStack API access, instances creation, etc. 23 | * ``decorators.py`` - Has different decorators; the most usable is 24 | ‘’log_snapshot_on_error’’; it is recommended to use this decorator for all 25 | tests, if any error diagnostic and environment snapshots will be created. 26 | * ``os_actions.py`` - Has methods to work with OpenStack. -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/post-deployment-conf/modify-os-env-settings.rst: -------------------------------------------------------------------------------- 1 | .. _modify-os-env-settings: 2 | 3 | Modify the OpenStack environment settings 4 | ========================================= 5 | 6 | Fuel enables you to change the configuration of an OpenStack environment 7 | that is currently in the ``operational``, ``error``, ``stopped``, or 8 | ``partially_deployed`` states for further redeployment of the OpenStack 9 | environment with new parameters. 10 | 11 | **To redeploy the OpenStack environment settings:** 12 | 13 | #. In the Fuel web UI, click the :guilabel:`Settings` tab. 14 | #. Reconfigure the OpenStack settings as required: 15 | 16 | * To modify the OpenStack environment settings, see :ref:`settings-ug`. 17 | * To modify network settings, see :ref:`network-settings-ug`. 18 | 19 | .. seealso:: 20 | 21 | * :ref:`ug-network` 22 | 23 | #. Click :guilabel:`Save Settings`. 24 | 25 | .. note:: 26 | 27 | To restore the last deployed OpenStack settings for your environment, 28 | click :guilabel:`Load Deployed`. Fuel displays the :guilabel:`Load Deployed` 29 | button only for the successfully deployed OpenStack environments. 30 | 31 | #. In the :guilabel:`Dashboard` tab, view :guilabel:`List of changes` 32 | to deploy. 33 | 34 | #. Click :guilabel:`Deploy Changes` to redeploy the OpenStack environment 35 | with the new configuration. 36 | Or click :guilabel:`Discard` to discard the changes and load the last 37 | successfully deployed OpenStack environment configuration. 38 | -------------------------------------------------------------------------------- /plugindocs/fuel-plugin-sdk-guide/reference/files/environment_config.rst: -------------------------------------------------------------------------------- 1 | .. _environment_config.yaml: 2 | 3 | ======================= 4 | environment_config.yaml 5 | ======================= 6 | 7 | Fuel uses the ``environment_config.yaml`` file for the additional attributes 8 | that will appear on the :guilabel:`Settings` tab of the Fuel web UI. 9 | 10 | When Fuel deploys the environment, these attributes pass to the task executor 11 | so that the data is available in the ``/etc/astute.yaml`` file on each target 12 | node and can be accessed from your bash or Puppet scripts. 13 | 14 | Example: 15 | 16 | .. code-block:: ini 17 | 18 | attributes: 19 | metadata: 20 | group: 'other' 21 | restrictions: 22 | - "settings:common.libvirt_type.value == 'kvm'" 23 | fuel_plugin_name_attr1: 24 | value: 'Set default value' 25 | label: 'Text field 1' 26 | description: 'Description for text field 1' 27 | weight: 25 28 | type: 'text' 29 | fuel_plugin_name_attr2: 30 | value: 'Set default value' 31 | label: 'Text field 2' 32 | description: 'Description for text field 2' 33 | weight: 25 34 | type: 'text' 35 | 36 | The file should consist of the``attributes`` keywords, followed by ``metadata`` 37 | and the list of atttributes. The ``metadata`` keyword may contain ``group`` 38 | and ``restrictions``. 39 | 40 | For descriptions of the fields, refer to `this section`_ in Fuel Developer Guide. 41 | 42 | .. _this section: http://docs.openstack.org/developer/fuel-docs/devdocs/develop/nailgun/customization/settings.html 43 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/workflows/workflows-create/examples/workflows-skip-task.rst: -------------------------------------------------------------------------------- 1 | .. _workflows-skip-task: 2 | 3 | Skip a deployment task 4 | ---------------------- 5 | 6 | You can skip a deployment task using the type or condition parameter 7 | of the task, or through an API request. 8 | 9 | When using API requests, you can specify the list of tasks to skip or 10 | indicate the first and the last task to skip. 11 | 12 | **To skip a deployment task:** 13 | 14 | #. Select from the following options: 15 | 16 | * Specify the ``type`` parameter: 17 | 18 | **Example:** 19 | 20 | .. code-block:: console 21 | 22 | - id: horizon 23 | type: skipped 24 | role: [primary-controller] 25 | requires: [post_deployment_start] 26 | required_for: [post_deployment_end] 27 | 28 | * Specify a ``false`` condition: 29 | 30 | **Example:** 31 | 32 | .. code-block:: console 33 | 34 | - id: horizon 35 | type: puppet 36 | role: [primary-controller] 37 | requires: [post_deployment_start] 38 | required_for: [post_deployment_end] 39 | condition: 'true != false' 40 | 41 | #. Synchronize deployment tasks: 42 | 43 | .. code-block:: console 44 | 45 | fuel rel --sync-deployment-tasks --dir 46 | 47 | **Example:** 48 | 49 | .. code-block:: console 50 | 51 | fuel rel --sync-deployment-tasks --dir /etc/puppet/mitaka-9.0/ 52 | 53 | .. seealso:: 54 | 55 | - :ref:`data-driven` 56 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/deploy-environment/deploy-changes.rst: -------------------------------------------------------------------------------- 1 | .. _deploy-changes: 2 | 3 | ============== 4 | Deploy changes 5 | ============== 6 | 7 | When you have completed configuration as described in :ref:`create-env-ug`, 8 | and :ref:`configure-env-ug`, you can deploy your OpenStack environment. 9 | 10 | Depending on the environment configuration, deployment may take from thirty 11 | minutes to an hour. 12 | 13 | **To run a standard deployment of the entire OpenStack environment:** 14 | 15 | #. In the Fuel web UI, select the :guilabel:`Dashboard` tab. 16 | #. Set the :guilabel:`Deployment mode` to :guilabel:`Provisioning + Deployment`. 17 | #. Click :guilabel:`Deploy Changes` to run both provisioning 18 | and deployment for the entire environment. Such deployment affects 19 | the OpenStack environment nodes as follows: 20 | 21 | * Not provisioned discovered nodes are provisioned and deployed. 22 | * Provisioned and not deployed nodes are deployed. 23 | * Already deployed nodes are re-deployed. 24 | 25 | **To run a separate deployment for the OpenStack environment nodes:** 26 | 27 | #. In the Fuel web UI, select the :guilabel:`Dashboard` tab. 28 | #. Set the :guilabel:`Deployment mode` to :guilabel:`Deployment Only`. 29 | 30 | * If you want to deploy all nodes, click :guilabel:`Deploy Nodes`. 31 | * If you want to deploy specific nodes: 32 | 33 | #. Unfold :guilabel:`Choose nodes for deployment` and 34 | select nodes. 35 | #. Click :guilabel:`Deploy Nodes`. 36 | 37 | .. seealso:: 38 | 39 | * :ref:`view_workflows` -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/intro/intro_install_overview.rst: -------------------------------------------------------------------------------- 1 | .. _intro_install_overview: 2 | 3 | Overview of the installation process 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | Deployment of an OpenStack environment requires extensive planning. 7 | To ensure a successful deployment, review and understand the following 8 | requirements and sequence of tasks that you must complete. 9 | 10 | #. Plan your OpenStack environment according to the official OpenStack 11 | guidelines and :ref:`Planning your environment `. 12 | 13 | #. Verify that your environment meets the recommendations in 14 | :ref:`System requirements `. 15 | 16 | #. Verify your hardware using the 17 | :ref:`Hardware checklist `. 18 | 19 | #. Determine whether the server on which you plan to install the Fuel 20 | Master node is connected to the Internet. 21 | 22 | * If the server does not have an Internet 23 | connection, then you must configure a local repository. For more 24 | information, see: :ref:`Set up a local repository `. 25 | 26 | #. If you plan to install Fuel on VMware vSphere, verify that your environment 27 | meets the :ref:`VMware vSphere prerequisites ` 28 | 29 | #. Download and install Fuel as described in :ref:`Install Fuel ` 30 | or if you are installing on VMware vSphere in 31 | :ref:`Install Fuel on VMware vSphere `. 32 | 33 | #. Install the Fuel plug-ins, if needed. See: :ref:`Plug-ins `. 34 | 35 | 36 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_audit_enforce.rst: -------------------------------------------------------------------------------- 1 | .. _cli-audit-enforce: 2 | 3 | ======================== 4 | Fuel IaC: Audit commands 5 | ======================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes the usage of the :command:`fuel2 audit` 10 | command available in the Fuel CLI. This command is available after you install 11 | the Fuel Infrastructure-as-Code extension. For more information, see: 12 | :ref:`lcm-git-repo`. 13 | 14 | .. list-table:: **Audit commands** 15 | :widths: 7 10 16 | :header-rows: 1 17 | 18 | * - Description 19 | - Command 20 | * - Run an audit in an OpenStack environment. 21 | - ``fuel2 audit noop --env || --repo `` 22 | * - List changes in an OpenStack environment. 23 | - ``fuel2 audit list outofsync --task || --env `` 24 | * - Perform an audit, verify changes, and enforce new configuration. 25 | - ``fuel2 audit enforce --env || --repo `` 26 | * - Display the white list for an OpenStack environment. 27 | - ``fuel2 audit whitelist show `` 28 | * - Add a rule to the white list of a specific OpenStack environment. 29 | - ``fuel2 audit whitelist add --task --rule `` 30 | * - Delete a rule or a set of rules from a white list. 31 | - ``fuel2 audit whitelist delete [ ... ]`` 32 | * - Add rules to a white list from a specific ``.yaml`` file. 33 | - ``fuel2 audit whitelist load fromfile `` 34 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/configure-vmware-vcenter-settings.rst: -------------------------------------------------------------------------------- 1 | .. _configure-vmware-vcenter-settings: 2 | 3 | ================================= 4 | Configure VMware vCenter settings 5 | ================================= 6 | 7 | If your environment is integrated with VMware vCenter, you can specify a 8 | Certificate Authority (CA) bundle file to use for verifying the VMware vCenter 9 | server certificate for the OpenStack Compute service, OpenStack Block Storage 10 | service, and OpenStack Image service. 11 | 12 | **To configure the VMware vCenter certificate verification:** 13 | 14 | #. Log in to the Fuel web UI. 15 | #. Navigate to the :guilabel:`VMware` tab. 16 | #. Configure the VMware vCenter certificate verification depending on your 17 | environment needs: 18 | 19 | * If you plan to deploy an environment for testing purposes or want to 20 | speed up the deployment process, disable the certificate 21 | verification by selecting 22 | :guilabel:`Bypass vCenter certificate verification` in the 23 | :guilabel:`VMware vCenter Settings` section. 24 | * If VMware vCenter is using a self-signed certificate: 25 | 26 | #. In the :guilabel:`CA file` section, upload a custom CA certificate. 27 | #. Leave :guilabel:`Bypass vCenter certificate verification` unchecked. 28 | * To use a VMware vCenter server certificate emitted by a known CA, for 29 | example, GeoTrust, leave the :guilabel:`CA file` section empty and the 30 | :guilabel:`Bypass vCenter certificate verification` unchecked. 31 | #. Click :guilabel:`Save Changes`. -------------------------------------------------------------------------------- /_templates/fuel.style: -------------------------------------------------------------------------------- 1 | #embeddedFonts: [ [ "PT Sans" ], [ "PT Mono" ], [ "PT Serif" ] ] 2 | # ["PT_Sans-CaptionBold.ttf", "PT_Sans-Bold.ttf", PT_Sans-Italic.ttf, PTF75F.ttf, PT_Sans-BoldItalic.ttf, 3 | # PT_Sans-Narrow.ttf, PTF76F.ttf, PT_Sans-Bold_0.ttf, PT_Sans-NarrowBold.ttf, 4 | # PTZ55F.ttf, PT_Sans-Caption.ttf, PT_Sans-Regular.ttf] 5 | 6 | fontsAlias: 7 | stdBold: PT Sans Bold 8 | stdBoldItalic: PT Sans Bold Italic 9 | stdFont: PT Sans 10 | stdItalic: PT Sans Italic 11 | stdMono: PT Mono 12 | stdMonoBold: PT Mono Bold 13 | stdMonoBoldItalic: PT Mono Bold 14 | stdMonoItalic: PT Mono 15 | stdSans: PT Sans 16 | stdSansBold: PT Sans Bold 17 | stdSansBoldItalic: PT Sans BoldItalic 18 | stdSansItalic: PT Sans Italic 19 | stdSerif: PT Serif 20 | 21 | pageSetup: 22 | firstTemplate: coverPage 23 | # size: LETTER 24 | 25 | pageTemplates: 26 | coverPage: 27 | frames: [] 28 | [0cm, 0cm, 100%, 100%] 29 | background : _images/title-page.png 30 | showHeader : false 31 | showFooter : false 32 | oneColumn: 33 | frames: [] 34 | [0cm, 0cm, 100%, 100%] 35 | showHeader : true 36 | showFooter : true 37 | 38 | styles: 39 | seealso: 40 | backColor: transparent 41 | borderColor: transparent 42 | parent: admonition 43 | 44 | seealso-heading: 45 | parent: heading 46 | fontName: PT Sans 47 | fontSize: 150% 48 | keepWithNext: true 49 | spaceBefore: 0 50 | spaceAfter: 10 51 | -------------------------------------------------------------------------------- /index.rst: -------------------------------------------------------------------------------- 1 | .. _contents: 2 | 3 | ============================== 4 | Welcome to Fuel Documentation! 5 | ============================== 6 | 7 | Fuel is an open-source tool that enables you to easily and quickly 8 | provision multiple OpenStack environments, as well as manage your environments 9 | after deployment. You can install Fuel and deploy your OpenStack environment 10 | on a virtual platform such as Oracle VirtualBox or VMware vSphere for testing 11 | purposes, as well as on bare-metal hardware for production. 12 | 13 | This page provides Fuel developer and user documentation. 14 | 15 | User documentation 16 | ~~~~~~~~~~~~~~~~~~ 17 | 18 | Learn how to install and configure Fuel, as well as how to deploy your 19 | OpenStack environments and manage them after deployment. 20 | 21 | .. toctree:: 22 | :maxdepth: 1 23 | 24 | userdocs/fuel-install-guide 25 | userdocs/fuel-user-guide 26 | userdocs/release-notes 27 | 28 | Developer documentation 29 | ~~~~~~~~~~~~~~~~~~~~~~~ 30 | 31 | Learn about Fuel internals, software architecture, and how Fuel components 32 | interact with each other. 33 | 34 | .. toctree:: 35 | :maxdepth: 1 36 | 37 | devdocs/develop 38 | devdocs/devops 39 | devdocs/buildsystem 40 | devdocs/infra 41 | devdocs/packaging 42 | 43 | Plugin documentation 44 | ~~~~~~~~~~~~~~~~~~~~ 45 | 46 | Learn how to develop and work with Fuel plugins 47 | 48 | .. toctree:: 49 | :maxdepth: 1 50 | 51 | plugindocs/fuel-plugin-sdk-guide 52 | 53 | Glossary 54 | ~~~~~~~~ 55 | 56 | Fuel documentation glossary 57 | 58 | .. toctree:: 59 | :maxdepth: 1 60 | 61 | glossary/glossary.rst -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/change-hostname-slave-nodes.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _change-hostname-slave-nodes: 3 | 4 | Modify the Fuel Slave node host name 5 | ------------------------------------ 6 | 7 | You can modify host names of the Fuel Slave nodes before you deploy an 8 | OpenStack environment. This functionality enables you to assign host names 9 | that match your corporate standards or a naming convention of your choice. 10 | You cannot change a host name of a Fuel Slave node after you deploy an 11 | OpenStack environment. 12 | 13 | **To modify the Fuel Slave node host name using Fuel web UI:** 14 | 15 | #. Log in to the Fuel web UI. 16 | #. Click the :guilabel:`Nodes` tab. 17 | #. Click the settings icon next to the corresponding node. 18 | #. Click the edit icon: 19 | 20 | .. image:: /_images/deliverables/scr_change_hostname.png 21 | :width: 60% 22 | 23 | #. Type the new host name. 24 | #. Click :guilabel:`Close`. 25 | 26 | **To modify the Fuel Slave node host name using Fuel CLI:** 27 | 28 | #. Log in to the Fuel Master node CLI. 29 | #. Type: 30 | 31 | .. code-block:: console 32 | 33 | fuel node --node --hostname 34 | 35 | .. list-table:: 36 | :widths: 10 25 37 | :header-rows: 1 38 | 39 | * - Value 40 | - Description 41 | * - 42 | - A specific node indentificator. You can get the information about the 43 | node ID by typing: 44 | 45 | .. code-block:: console 46 | 47 | fuel nodes 48 | 49 | * - 50 | - A new host name for the selected node. 51 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/configure-environment/selectable-offload.rst: -------------------------------------------------------------------------------- 1 | 2 | .. raw:: pdf 3 | 4 | PageBreak 5 | 6 | .. _selectable-offload: 7 | 8 | Edit the offloading mode 9 | ------------------------ 10 | 11 | Fuel assigns the default offloading mode to all network interfaces 12 | automatically. You may want to modify this setting to meet your 13 | network requirements. The number of available offloading types 14 | depends on network hardware and the kernel version that you use. 15 | 16 | Fuel automatically detects offloading modes for any physical network 17 | interface. 18 | 19 | **To edit the offloading mode using Fuel web UI:** 20 | 21 | #. Log in to the Fuel web UI. 22 | #. Click :guilabel:`Nodes`. 23 | #. Select a node. 24 | #. Click :guilabel:`Interface configuration`. 25 | #. Click :guilabel:`Offloading Modes: Default` to disable offloading. 26 | 27 | **To edit the offloading mode using CLI:** 28 | 29 | #. Log in to the Fuel Master node CLI. 30 | #. Verify the node ID: 31 | 32 | .. code-block:: console 33 | 34 | fuel nodes 35 | 36 | #. Download the information about network interfaces: 37 | 38 | .. code-block:: console 39 | 40 | fuel node --node --network --download 41 | 42 | #. Open the ``/root/node_/interfaces.yaml`` file for editing. 43 | #. Disable or leave the default value next to the ``state`` field: 44 | 45 | * true - enable offloading modes 46 | * false - disable offloading modes 47 | * null - default offloading modes 48 | 49 | #. Upload the modified file: 50 | 51 | .. code-block:: console 52 | 53 | fuel node --node --network --upload 54 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_client_config_file.rst: -------------------------------------------------------------------------------- 1 | .. _cli-client-config-file: 2 | 3 | ====================================== 4 | Modify the Fuel CLI configuration file 5 | ====================================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The Fuel CLI uses the ``fuel_client.yaml`` file as a source for default 10 | settings. By default, Fuel stores the ``fuel_client.yaml`` file in the 11 | ``~/.config/`` directory. 12 | 13 | **To change the default directory:** 14 | 15 | #. Log in to the Fuel CLI. 16 | #. Set the required directory path: 17 | 18 | :: 19 | 20 | $ export XDG_CONFIG_HOME=/path/to/fuel_client.yaml/ 21 | 22 | where ``XDG_CONFIG_HOME`` points to the ``fuel_client.yaml`` file directory. 23 | 24 | **To specify custom settings:** 25 | 26 | #. Log in to the Fuel CLI. 27 | #. Edit the ``fuel_client.yaml`` file. 28 | 29 | Alternatively, create a new YAML-formatted file: 30 | 31 | #. Create a ``.yaml`` file with the required settings. 32 | #. Export the ``FUELCLIENT_CUSTOM_SETTINGS`` variable: 33 | 34 | :: 35 | 36 | $ export FUELCLIENT_CUSTOM_SETTINGS="~/custom.conf" 37 | 38 | where ``"~/custom.conf"`` is the path to the new configuration file. 39 | 40 | #. Optionally, add the export to the ``.bashrc`` file: 41 | 42 | :: 43 | 44 | $ echo 'export FUELCLIENT_CUSTOM_SETTINGS="~/custom.conf"' >> ~/.bashrc 45 | 46 | .. note:: 47 | 48 | Custom settings override the default ones. Top-level values may also be set 49 | as environment variables. 50 | 51 | **Example:** 52 | 53 | :: 54 | 55 | $ export SERVER_PORT=8080 -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/cli/cli_environment.rst: -------------------------------------------------------------------------------- 1 | .. _cli-environment: 2 | 3 | ==================== 4 | Environment commands 5 | ==================== 6 | 7 | .. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst 8 | 9 | The following table describes environment management commands 10 | available in the Fuel CLI. 11 | 12 | .. list-table:: **Environment commands** 13 | :widths: 10 10 20 14 | :header-rows: 1 15 | 16 | * - Description 17 | - Command 18 | - Example 19 | * - View the list of environments. 20 | - ``fuel env`` 21 | - 22 | * - Create an environment. 23 | - ``fuel env create --name --rel `` 24 | - By default, Fuel creates an OpenStack environment in the 25 | ``multinode`` mode, and the ``nova`` network mode. 26 | To specify other modes, you can add optional arguments: 27 | 28 | .. code-block:: console 29 | 30 | fuel env create --name --rel \ 31 | --mode ha --network-mode neutron --net-segment-type vlan 32 | 33 | Use the ``set`` action to change the name, mode, or network mode 34 | for an OpenStack environment: 35 | 36 | .. code-block:: console 37 | 38 | fuel --env env set --name --mode ha_compact 39 | 40 | * - Delete an OpenStack environment. 41 | - ``fuel --env env delete`` 42 | - 43 | * - Update the OpenStack environment to a newer version. To roll back a 44 | failed update, use the same command with the previous release number. 45 | - ``fuel env --update --env --rel `` 46 | - 47 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/redeploy-node.rst: -------------------------------------------------------------------------------- 1 | .. _redeploy-node: 2 | 3 | =============== 4 | Redeploy a node 5 | =============== 6 | 7 | Redeploying a node refers to the process of changing the roles that are 8 | assigned to a node. For example, you want to redeploy some compute and storage 9 | nodes to be MongoDB nodes. 10 | 11 | **To redeploy a node:** 12 | 13 | #. Prepare your environment: 14 | 15 | #. Live migrate instances from the compute nodes. For more information, 16 | see `Configure migrations `_. 17 | #. Back up or copy information from the Operating System nodes being 18 | redeployed. 19 | 20 | #. Log in to the Fuel web UI. 21 | #. In the :guilabel:`Nodes` tab, select the node(s) that you want to remove 22 | and click :guilabel:`Delete`. 23 | 24 | The deployed node will be marked as :guilabel:`PENDING DELETION`. 25 | 26 | #. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. 27 | 28 | #. Wait for the node to become available in the list of :guilabel:`Discovered` 29 | nodes in the :guilabel:`Nodes` tab. 30 | #. Assign a new role to the node being redeployed. 31 | #. Adjust the settings of your environment as required. 32 | #. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. 33 | #. Wait for the environment to be redeployed. 34 | 35 | .. caution:: After redeploying an Operating System node, you will have to 36 | manually apply any configuration changes you made and reinstall the software 37 | that was running on the node or restore the system from the backup you made 38 | before redeploying the node. 39 | -------------------------------------------------------------------------------- /userdocs/fuel-install-guide/sysreq/sysreq_storage_reqs.rst: -------------------------------------------------------------------------------- 1 | .. _sysreq_storge_reqs: 2 | 3 | Storage requirements 4 | -------------------- 5 | 6 | When planning storage for your OpenStack environment, understand the 7 | difference between the two types of storage that OpenStack uses: 8 | persistent and ephemeral. 9 | 10 | The nova-compute service manages ephemeral storage that is used as temporary 11 | storage for the operating system of virtual machine instances. When you 12 | delete an instance, nova-compute deletes the ephemeral storage as well. 13 | If you do not select any additional storage options, the virtual machine 14 | volumes will be stored on the local disks of the compute nodes, in the 15 | virtual storage partition. However, if you enable Ceph RBD back end for 16 | ephemeral volumes, nova-compute stores virtual machine volumes in Ceph. 17 | 18 | Persistent storage is the storage that exists outside an instance, in contrast 19 | to ephemeral storage. 20 | 21 | Fuel deploys storage for the following types of persistent data: 22 | 23 | * Glance, for image data, which can use either Swift or Ceph RBD as a 24 | storage back end. 25 | * Cinder, for block data, which can use either LVM or Ceph RBD as a 26 | storage back end. 27 | * Ceph RadosGW, for object storage, with Ceph RBD as storage back end. 28 | 29 | .. note:: 30 | Fuel plugins may provide additional storage options. For more information, 31 | see the 32 | `OpenStack Driverlog for the Fuel project `_. 33 | 34 | .. seealso:: 35 | 36 | - `Storage Decisions 37 | `_ 38 | -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/maintain-environment/rollback-compute-node.rst: -------------------------------------------------------------------------------- 1 | .. _rollback-compute-node: 2 | 3 | ======================= 4 | Rollback a compute node 5 | ======================= 6 | 7 | You can rollback a compute node to its original state, for example, the state 8 | before it failed. 9 | 10 | **To rollback a compute node**: 11 | 12 | #. SSH to one of the controller nodes. 13 | 14 | #. Put the node into maintenance mode to prevent scheduling of new VMs by 15 | disabling the nova-compute service: 16 | 17 | .. code-block:: console 18 | 19 | $ nova service-disable nova-compute 20 | 21 | #. Power off all the VMs running on the node to be re-installed: 22 | 23 | .. code-block:: console 24 | 25 | $ nova stop [vm-uuid] 26 | 27 | 28 | Alternatively, live migrate the VMs: 29 | 30 | #. Get a list of all VMs running on a host: 31 | 32 | .. code-block:: console 33 | 34 | $ nova list --host --all-tenants 35 | 36 | #. Manually live migrate instances to other hosts: 37 | 38 | .. code-block:: console 39 | 40 | $ nova live-migration 41 | 42 | #. Reinstall the node as described in :ref:`reinstall-node`. 43 | 44 | #. Enable the nova-compute service: 45 | 46 | .. code-block:: console 47 | 48 | $ nova service-enable nova-compute 49 | 50 | #. If you did not perform the live migration, start the VMs that are in the 51 | ``SHUTOFF`` status: 52 | 53 | .. code-block:: console 54 | 55 | $ nova start [vm-uuid] 56 | 57 | .. seealso:: 58 | 59 | * :ref:`access_shell` 60 | * `Planned Maintenance `_ -------------------------------------------------------------------------------- /userdocs/fuel-user-guide/post-deployment-conf/lcm-git-repo/set-up-git-repo.rst: -------------------------------------------------------------------------------- 1 | .. _set-up-git-repo: 2 | 3 | Set up a Git repository 4 | ======================= 5 | 6 | You need to create a Git repository to store and modify the required 7 | configuration files, as well as configure the repository to work with 8 | the Fuel Nailgun configuration service. 9 | 10 | .. note:: 11 | 12 | Fuel can work with multiple Git repositories. 13 | However, limit one repository and one branch per an OpenStack environment. 14 | 15 | **To set up a Git repository:** 16 | 17 | #. Create a Git repository in any Git repository management system 18 | or web-based service, such as GitHub. 19 | 20 | #. Add the public SSH key located in ``.ssh/id_rsa.pub`` to your 21 | Git repository. 22 | 23 | #. Create a repository object within Nailgun and register the 24 | repository with Nailgun: 25 | 26 | :: 27 | 28 | fuel2 gitrepo create --name \ 29 | --url --ref --key \ 30 | 31 | 32 | **Example:** 33 | 34 | :: 35 | 36 | fuel2 gitrepo create --env 1 --name oscnf1 --url \ 37 | git@github.com:dukov/oscnf.git --ref master --key .ssh/id_rsa 38 | 39 | #. Create a repository structure similar to the one described in 40 | :ref:`repo-structure` by adding the required 41 | files in the repository and committing the changes. 42 | 43 | #. Optionally, configure the Git repository to track changes in your 44 | OpenStack environment in a separate branch: 45 | 46 | :: 47 | 48 | fuel2 gitrepo get configs --env 49 | 50 | You must have write permissions to the Git repository. 51 | 52 | --------------------------------------------------------------------------------