├── .gitignore ├── .gitreview ├── .zuul.yaml ├── CONTRIBUTING.rst ├── LICENSE ├── README.rst ├── bindep.txt ├── doc-tools-check-languages.conf ├── doc ├── api-quick-start │ └── source │ │ ├── api-quick-start.rst │ │ ├── conf.py │ │ ├── index.rst │ │ └── locale │ │ ├── de │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ ├── eo │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ ├── id │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ ├── ko_KR │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ ├── tr_TR │ │ └── LC_MESSAGES │ │ │ └── api-quick-start.po │ │ └── zh_CN │ │ └── LC_MESSAGES │ │ └── api-quick-start.po ├── common │ ├── app-support.rst │ ├── appendix.rst │ ├── conventions.rst │ ├── figures │ │ ├── SCH_5002_V00_NUAC-Keystone.png │ │ ├── SCH_5002_V00_NUAC-Keystone.svg │ │ ├── demo_multiple_dhcp_agents.png │ │ ├── horizon-screenshot.png │ │ └── osog_0001.png │ ├── glossary.rst │ └── source │ │ ├── conf.py │ │ └── locale │ │ ├── de │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── id │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── ja │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── ko_KR │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── ru │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── tr_TR │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ ├── vi_VN │ │ └── LC_MESSAGES │ │ │ └── common.po │ │ └── zh_CN │ │ └── LC_MESSAGES │ │ └── common.po ├── doc-contrib-guide │ └── source │ │ ├── additional-git-workflow.rst │ │ ├── additional-git-workflow │ │ └── rebase.rst │ │ ├── api-guides.rst │ │ ├── blueprints-and-specs.rst │ │ ├── common │ │ ├── conf.py │ │ ├── diagram-guidelines.rst │ │ ├── diagram-guidelines │ │ ├── diagram-usage.rst │ │ ├── files.rst │ │ ├── general-guidelines.rst │ │ └── tools.rst │ │ ├── doc-bugs.rst │ │ ├── doc-impact.rst │ │ ├── doc-index.rst │ │ ├── doc-tag.rst │ │ ├── doc-tools.rst │ │ ├── doc-tools │ │ ├── contributing.rst │ │ ├── installation.rst │ │ ├── scripts.rst │ │ └── template-generator.rst │ │ ├── docs-builds.rst │ │ ├── docs-review-guidelines.rst │ │ ├── docs-review.rst │ │ ├── figures │ │ └── doc-logo-fox.jpg │ │ ├── index.rst │ │ ├── json-conv.rst │ │ ├── non-native-english-speakers.rst │ │ ├── project-deploy-guide.rst │ │ ├── project-guides.rst │ │ ├── project-install-guide.rst │ │ ├── quickstart.rst │ │ ├── quickstart │ │ ├── developers.rst │ │ └── first-timers.rst │ │ ├── redirects.rst │ │ ├── release.rst │ │ ├── release │ │ ├── release-tools.rst │ │ ├── taskdetail.rst │ │ └── taskoverview.rst │ │ ├── rst-conv.rst │ │ ├── rst-conv │ │ ├── comment.rst │ │ ├── decorations.rst │ │ ├── figures.rst │ │ ├── file-naming.rst │ │ ├── general-guidelines.rst │ │ ├── inline-markups.rst │ │ ├── lists.rst │ │ ├── profiling.rst │ │ ├── references.rst │ │ ├── source-code.rst │ │ ├── specific-info.rst │ │ ├── tables.rst │ │ └── titles.rst │ │ ├── team-structure.rst │ │ ├── team-vision.rst │ │ ├── topic-structure.rst │ │ ├── topic-tags.rst │ │ ├── user-guidelines.rst │ │ ├── ux-ui-guidelines │ │ ├── figures │ │ │ ├── gui-actions.png │ │ │ ├── gui-actions.svg │ │ │ ├── gui-cancelbutton.png │ │ │ ├── gui-cancelbutton.svg │ │ │ ├── gui-errors.png │ │ │ ├── gui-errors.svg │ │ │ ├── gui-modalerror.png │ │ │ ├── gui-modalerror.svg │ │ │ ├── gui-search.png │ │ │ ├── gui-search.svg │ │ │ ├── gui-wizards.png │ │ │ ├── gui-wizards.svg │ │ │ ├── persona-ecosystem.png │ │ │ ├── persona-ecosystem.svg │ │ │ └── ui-text-cheatsheet.jpg │ │ ├── gui-guidelines.rst │ │ ├── ui-text-guidelines.rst │ │ ├── ui-text-guidelines │ │ │ ├── ui-action-labels.rst │ │ │ ├── ui-error-messages.rst │ │ │ ├── ui-panel-formatting.rst │ │ │ └── ui-text-capitalization.rst │ │ ├── ux-personas.rst │ │ └── ux-personas │ │ │ ├── app-developer.rst │ │ │ ├── cloud-ops.rst │ │ │ ├── domain-operator.rst │ │ │ ├── infrastructure-arch.rst │ │ │ ├── model-companies.rst │ │ │ └── project-owner.rst │ │ ├── writing-docs.rst │ │ ├── writing-style.rst │ │ └── writing-style │ │ ├── code-conventions.rst │ │ ├── general-writing-guidelines.rst │ │ ├── headings.rst │ │ ├── lists.rst │ │ ├── num_and_units_of_measure.rst │ │ ├── openstack-components.rst │ │ ├── punctuation.rst │ │ ├── release-names.rst │ │ ├── ui-terminology.rst │ │ ├── urls.rst │ │ └── word-choice.rst ├── glossary │ └── source │ │ ├── common │ │ ├── conf.py │ │ ├── index.rst │ │ └── locale │ │ ├── de │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ ├── fi_FI │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ ├── id │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ ├── ko_KR │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ ├── ru │ │ └── LC_MESSAGES │ │ │ └── glossary.po │ │ └── zh_CN │ │ └── LC_MESSAGES │ │ └── glossary.po ├── image-guide │ └── source │ │ ├── common │ │ ├── conf.py │ │ ├── convert-images.rst │ │ ├── create-images-automatically.rst │ │ ├── create-images-manually-example-centos-image.rst │ │ ├── create-images-manually-example-fedora-image.rst │ │ ├── create-images-manually-example-freebsd-image.rst │ │ ├── create-images-manually-example-ubuntu-image.rst │ │ ├── create-images-manually-example-windows-image.rst │ │ ├── create-images-manually-tools-libvirt.rst │ │ ├── create-images-manually.rst │ │ ├── figures │ │ ├── centos-complete.png │ │ ├── centos-install.png │ │ ├── centos-tcpip.png │ │ ├── centos-url-setup.png │ │ ├── freebsd-partitions.png │ │ ├── ubuntu-finished.png │ │ ├── ubuntu-grub.png │ │ ├── ubuntu-install.png │ │ ├── ubuntu-software-selection.png │ │ └── virt-manager.png │ │ ├── index.rst │ │ ├── introduction.rst │ │ ├── locale │ │ ├── de │ │ │ └── LC_MESSAGES │ │ │ │ └── image-guide.po │ │ ├── en_GB │ │ │ └── LC_MESSAGES │ │ │ │ └── image-guide.po │ │ ├── id │ │ │ └── LC_MESSAGES │ │ │ │ └── image-guide.po │ │ ├── ja │ │ │ └── LC_MESSAGES │ │ │ │ └── image-guide.po │ │ └── tr_TR │ │ │ └── LC_MESSAGES │ │ │ └── image-guide.po │ │ ├── modify-images.rst │ │ ├── obtain-images.rst │ │ ├── openstack-images.rst │ │ └── share-images.rst └── install-guide │ └── source │ ├── common │ ├── conf.py │ ├── environment-etcd-rdo.rst │ ├── environment-etcd-ubuntu.rst │ ├── environment-etcd.rst │ ├── environment-memcached-rdo.rst │ ├── environment-memcached-ubuntu.rst │ ├── environment-memcached.rst │ ├── environment-messaging-rdo.rst │ ├── environment-messaging-ubuntu.rst │ ├── environment-messaging.rst │ ├── environment-networking-compute.rst │ ├── environment-networking-controller.rst │ ├── environment-networking-storage-cinder.rst │ ├── environment-networking-verify.rst │ ├── environment-networking.rst │ ├── environment-ntp-controller.rst │ ├── environment-ntp-other.rst │ ├── environment-ntp-verify.rst │ ├── environment-ntp.rst │ ├── environment-packages-rdo.rst │ ├── environment-packages-ubuntu.rst │ ├── environment-packages.rst │ ├── environment-security.rst │ ├── environment-sql-database-rdo.rst │ ├── environment-sql-database-ubuntu.rst │ ├── environment-sql-database.rst │ ├── environment.rst │ ├── figures │ ├── debconf-screenshots │ │ ├── api-endpoint_1_register_endpoint.png │ │ ├── api-endpoint_2_keystone_server_ip.png │ │ ├── api-endpoint_3_keystone_authtoken.png │ │ ├── api-endpoint_4_service_endpoint_ip_address.png │ │ ├── api-endpoint_5_region_name.png │ │ ├── dbconfig-common_1_configure-with-dbconfig-yes-no.png │ │ ├── dbconfig-common_2_db-types.png │ │ ├── dbconfig-common_3_connection_method.png │ │ ├── dbconfig-common_4_mysql_root_password.png │ │ ├── dbconfig-common_5_mysql_app_password.png │ │ ├── dbconfig-common_6_mysql_app_password_confirm.png │ │ ├── dbconfig-common_keep_admin_pass.png │ │ ├── dbconfig-common_used_for_remote_db.png │ │ ├── glance-common_pipeline_flavor.png │ │ ├── keystone_1_admin_token.png │ │ ├── keystone_2_register_admin_tenant_yes_no.png │ │ ├── keystone_3_admin_user_name.png │ │ ├── keystone_4_admin_user_email.png │ │ ├── keystone_5_admin_user_pass.png │ │ ├── keystone_6_admin_user_pass_confirm.png │ │ ├── keystone_7_register_endpoint.png │ │ ├── neutron_1_plugin_selection.png │ │ ├── rabbitmq-host.png │ │ ├── rabbitmq-password.png │ │ ├── rabbitmq-user.png │ │ ├── service_keystone_authtoken_admin_password.png │ │ ├── service_keystone_authtoken_admin_tenant_name.png │ │ ├── service_keystone_authtoken_server_hostname.png │ │ └── service_keystone_authtoken_tenant_admin_user.png │ ├── hwreqs.graffle │ ├── hwreqs.png │ ├── hwreqs.svg │ ├── installguide-neutron-initialnetworks.graffle │ ├── installguide-neutron-initialnetworks.png │ ├── installguide-neutron-initialnetworks.svg │ ├── network1-connectivity.graffle │ ├── network1-connectivity.png │ ├── network1-connectivity.svg │ ├── network1-overview.graffle │ ├── network1-overview.png │ ├── network1-overview.svg │ ├── network1-services.png │ ├── network1-services.svg │ ├── network2-connectivity.graffle │ ├── network2-connectivity.png │ ├── network2-connectivity.svg │ ├── network2-overview.graffle │ ├── network2-overview.png │ ├── network2-overview.svg │ ├── network2-services.png │ ├── network2-services.svg │ ├── networklayout.graffle │ ├── networklayout.png │ ├── networklayout.svg │ ├── openstack-arch-kilo-logical-v1.png │ ├── openstack-arch-kilo-logical-v1.svg │ ├── openstack_kilo_conceptual_arch.png │ └── openstack_kilo_conceptual_arch.svg │ ├── firewalls-default-ports.rst │ ├── get-started-conceptual-architecture.rst │ ├── get-started-logical-architecture.rst │ ├── get-started-with-openstack.rst │ ├── index.rst │ ├── launch-instance-cinder.rst │ ├── launch-instance-networks-provider.rst │ ├── launch-instance-networks-selfservice.rst │ ├── launch-instance-provider.rst │ ├── launch-instance-selfservice.rst │ ├── launch-instance.rst │ ├── locale │ ├── bn_IN │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── de │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── fr │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── id │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── ja │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── ko_KR │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── ru │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ ├── tr_TR │ │ └── LC_MESSAGES │ │ │ └── install-guide.po │ └── zh_CN │ │ └── LC_MESSAGES │ │ └── install-guide.po │ ├── openstack-services.rst │ ├── overview.rst │ ├── preface.rst │ └── shared │ ├── edit_hosts_file.txt │ └── note_configuration_vary_by_distribution.rst ├── projects.txt ├── releasenotes └── source │ ├── conf.py │ ├── index.rst │ ├── locale │ ├── de │ │ └── LC_MESSAGES │ │ │ └── releasenotes.po │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ └── releasenotes.po │ ├── id │ │ └── LC_MESSAGES │ │ │ └── releasenotes.po │ ├── ja │ │ └── LC_MESSAGES │ │ │ └── releasenotes.po │ ├── ko_KR │ │ └── LC_MESSAGES │ │ │ └── releasenotes.po │ └── zh_CN │ │ └── LC_MESSAGES │ │ └── releasenotes.po │ ├── mitaka.rst │ ├── newton.rst │ ├── ocata.rst │ ├── pike.rst │ ├── queens.rst │ ├── rocky.rst │ └── train.rst ├── test-requirements.txt ├── tools ├── README-USE-openstack-doc-tools.txt ├── build-all-rst.sh ├── build-rst.sh ├── generatepot-rst.sh ├── glossary-sort.sh ├── publishdocs.sh ├── sync-projects.sh ├── test.sh └── www-generator.py ├── tox.ini └── www ├── .htaccess ├── 2023.1 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── 2023.2 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── 2024.1 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── 2024.2 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── 2025.1 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── 2025.2 ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── austin ├── badge.html └── index.html ├── bexar ├── badge.html └── index.html ├── cactus ├── badge.html └── index.html ├── de └── index.html ├── diablo ├── badge.html └── index.html ├── errorpage.html ├── essex ├── badge.html └── index.html ├── folsom ├── badge.html └── index.html ├── fr └── index.html ├── grizzly ├── badge.html └── index.html ├── havana ├── badge.html └── index.html ├── icehouse └── index.html ├── id └── index.html ├── ja └── index.html ├── juno ├── badge.html └── index.html ├── kilo ├── badge.html └── index.html ├── ko_KR └── index.html ├── latest └── badge.html ├── liberty ├── badge.html └── index.html ├── master └── badge.html ├── mitaka ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── de │ └── index.html ├── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── newton ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── de │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── ocata ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── de │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ ├── index.html │ ├── obs-services.html │ ├── rdo-services.html │ └── ubuntu-services.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── pike ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── project-data ├── 2023.1.yaml ├── 2023.2.yaml ├── 2024.1.yaml ├── 2024.2.yaml ├── 2025.1.yaml ├── README.rst ├── latest.yaml ├── mitaka.yaml ├── newton.yaml ├── ocata.yaml ├── pike.yaml ├── queens.yaml ├── rocky.yaml ├── schema.yaml ├── stein.yaml ├── train.yaml ├── ussuri.yaml ├── victoria.yaml ├── wallaby.yaml ├── xena.yaml ├── yoga.yaml └── zed.yaml ├── pt_BR └── index.html ├── queens ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── redirect-tests.txt ├── rocky ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── static ├── common │ ├── css │ │ ├── bootstrap.css │ │ ├── bootstrap.min.css │ │ ├── combined.css │ │ ├── deprecated-badge.css │ │ ├── font-awesome-additions.css │ │ ├── main-landing.css │ │ └── search.css │ ├── images │ │ ├── ATT00001.png │ │ ├── OpenSUSE_Logo.svg │ │ ├── arch-guide-cover.png │ │ ├── centos-logo-light-vertical.svg │ │ ├── docs │ │ │ ├── superuser1.png │ │ │ ├── superuser2.png │ │ │ ├── superuser3.png │ │ │ └── superuser4.png │ │ ├── footer-facebook-hover.png │ │ ├── footer-facebook.png │ │ ├── footer-linkedin-hover.png │ │ ├── footer-linkedin.png │ │ ├── footer-twitter-hover.png │ │ ├── footer-twitter.png │ │ ├── footer-youtube-hover.png │ │ ├── footer-youtube.png │ │ ├── loading.gif │ │ ├── openlogo-100.png │ │ ├── openstack-arch-guide-team.png │ │ ├── openstack-logo-full.png │ │ ├── openstack-logo-vert.png │ │ └── search-icon.png │ └── js │ │ ├── bootstrap.js │ │ ├── bootstrap.min.js │ │ ├── deprecated-badge.js │ │ ├── doc-characters.json │ │ ├── docs.js │ │ ├── jquery-3.1.1.js │ │ ├── navigation.js │ │ └── webui-popover.js ├── favicon.ico ├── robots.txt └── sitemap.xml ├── stein ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── templates ├── api_guides.tmpl ├── base.tmpl ├── contributor_guides.tmpl ├── css.tmpl ├── default.tmpl ├── deprecated_badge.tmpl ├── dropdown_languages.tmpl ├── footer.tmpl ├── google_analytics.tmpl ├── header.tmpl ├── indexbase.tmpl ├── navigation.tmpl ├── ops_and_admin_guides.tmpl ├── os_search.tmpl ├── os_search_install.tmpl ├── os_search_mobile.tmpl ├── project_deprecated_badge.tmpl ├── project_guides.tmpl ├── project_list.tmpl ├── script_footer.tmpl ├── script_search.tmpl ├── series_status.tmpl ├── switch_releases.tmpl ├── training_guides.tmpl └── user_guides.tmpl ├── tr_TR └── index.html ├── train ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── ussuri ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── victoria ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── wallaby ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── xena ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── yoga ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html ├── zed ├── admin │ └── index.html ├── api │ └── index.html ├── badge.html ├── configuration │ └── index.html ├── deploy │ └── index.html ├── index.html ├── install │ └── index.html ├── language-bindings.html ├── projects.html └── user │ └── index.html └── zh_CN └── index.html /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.xpr 3 | .idea 4 | 5 | # Build results 6 | /publish-docs/ 7 | .doctrees 8 | build/ 9 | /build-*.log.gz 10 | *.mo 11 | 12 | # Python compiled files 13 | *.pyc 14 | 15 | # Ignore Vagrant Related Files 16 | acceptance_config.yml 17 | boxes/* 18 | /.vagrant 19 | 20 | # Testenvironment 21 | .tox/ 22 | 23 | # Editors 24 | *~ 25 | .*.swp 26 | .*.swo 27 | .bak 28 | /.project 29 | OS_GOVERNANCE_DATA_CACHE 30 | 31 | -------------------------------------------------------------------------------- /.gitreview: -------------------------------------------------------------------------------- 1 | [gerrit] 2 | host=review.opendev.org 3 | port=29418 4 | project=openstack/openstack-manuals.git 5 | -------------------------------------------------------------------------------- /CONTRIBUTING.rst: -------------------------------------------------------------------------------- 1 | ================= 2 | How to contribute 3 | ================= 4 | 5 | Our community welcomes all people interested in open source cloud 6 | computing, and encourages you to join the `Open Infrastructure Foundation 7 | `_. 8 | 9 | The best way to get involved with the community is to talk with others 10 | online or at a meet up and offer contributions through our processes, 11 | the `OpenStack wiki `_, blogs, or on IRC at 12 | ``#openstack`` on ``irc.oftc.net``. 13 | 14 | We welcome all types of contributions, from blueprint designs to 15 | documentation to testing to deployment scripts. 16 | 17 | If you would like to contribute to the documents, please see the 18 | `OpenStack Documentation Contributor Guide 19 | `_. 20 | 21 | If you would like to contribute to the development of OpenStack, you must 22 | follow the steps in this page: 23 | 24 | https://docs.opendev.org/opendev/infra-manual/latest/developers.html 25 | 26 | If you already have a good understanding of how the system works and your 27 | OpenStack accounts are set up, you can skip to the development workflow 28 | section of this documentation to learn how changes to OpenStack should be 29 | submitted for review via the Gerrit tool: 30 | 31 | https://docs.opendev.org/opendev/infra-manual/latest/developers.html#development-workflow 32 | 33 | Pull requests submitted through GitHub will be ignored. 34 | 35 | Bugs should be filed on Launchpad, not GitHub: 36 | 37 | https://bugs.launchpad.net/openstack-manuals 38 | -------------------------------------------------------------------------------- /bindep.txt: -------------------------------------------------------------------------------- 1 | # This is a cross-platform list tracking distribution packages needed by tests; 2 | # see https://docs.openstack.org/infra/bindep/ for additional information. 3 | 4 | fonts-lmodern [platform:dpkg] 5 | fonts-liberation [platform:dpkg] 6 | fonts-nanum [platform:dpkg] 7 | fonts-takao [platform:dpkg] 8 | freetype-devel [platform:rpm] 9 | gettext 10 | libfreetype6-dev [platform:dpkg] 11 | libjpeg-dev [platform:dpkg] 12 | libjpeg-turbo-devel [platform:rpm] 13 | python3-all [platform:dpkg] 14 | python3-all-dev [platform:dpkg] 15 | python3-devel [platform:fedora] 16 | python34-devel [platform:centos] 17 | zlib-devel [platform:rpm] 18 | zlib1g-dev [platform:dpkg] 19 | inkscape 20 | tex-gyre [platform:dpkg] 21 | texlive-latex-base [platform:dpkg] 22 | texlive-latex-extra [platform:dpkg] 23 | texlive-xetex [platform:dpkg] 24 | texlive-fonts-recommended [platform:dpkg] 25 | fonts-freefont-otf [platform:dpkg] 26 | xindy [platform:dpkg] 27 | latexmk [platform:dpkg] 28 | gcc [platform:dpkg] 29 | pcre-devel [platform:rpm] 30 | libpcre3-dev [platform:dpkg] 31 | texlive [platform:rpm] 32 | texlive-fncychap [platform:rpm] 33 | texlive-gnu-freefont [platform:rpm] 34 | texlive-titlesec [platform:rpm] 35 | texlive-tabulary [platform:rpm] 36 | texlive-framed [platform:rpm] 37 | texlive-wrapfig [platform:rpm] 38 | texlive-upquote [platform:rpm] 39 | texlive-capt-of [platform:rpm] 40 | texlive-needspace [platform:rpm] 41 | texlive-polyglossia [platform:rpm] 42 | texlive-xindy [platform:rpm] 43 | latexmk [platform:rpm] 44 | -------------------------------------------------------------------------------- /doc-tools-check-languages.conf: -------------------------------------------------------------------------------- 1 | # directories to be set up 2 | declare -A DIRECTORIES=( 3 | ) 4 | 5 | # books to be built 6 | declare -A BOOKS=( 7 | ["bn_IN"]="install-guide" 8 | ["de"]="api-quick-start image-guide install-guide" 9 | ["eo"]="api-quick-start" 10 | ["fr"]="install-guide" 11 | ["id"]="api-quick-start image-guide install-guide" 12 | ["ja"]="image-guide install-guide" 13 | ["ko_KR"]="api-quick-start install-guide" 14 | ["ru"]="install-guide" 15 | ["tr_TR"]="api-quick-start image-guide install-guide" 16 | ["zh_CN"]="api-quick-start install-guide" 17 | ) 18 | 19 | # Location of doc dir 20 | DOC_DIR="doc/" 21 | 22 | # Books with special handling. 23 | # Values need to match content in 24 | # project-config/jenkins/scripts/common_translation_update.sh 25 | declare -A SPECIAL_BOOKS=( 26 | # This needs special handling, handle it with the RST tools. 27 | ["common"]="RST" 28 | ["glossary"]="RST" 29 | ["api-quick-start"]="RST" 30 | ["image-guide"]="RST" 31 | ["install-guide"]="RST" 32 | # Do not translate 33 | ["doc-contrib-guide"]="skip" 34 | ["releasenotes"]="skip" 35 | ) 36 | -------------------------------------------------------------------------------- /doc/common/appendix.rst: -------------------------------------------------------------------------------- 1 | Appendix 2 | ~~~~~~~~ 3 | 4 | .. toctree:: 5 | :maxdepth: 1 6 | 7 | app-support.rst 8 | glossary.rst 9 | -------------------------------------------------------------------------------- /doc/common/conventions.rst: -------------------------------------------------------------------------------- 1 | .. ## WARNING ########################################################## 2 | .. This file is synced from openstack/openstack-manuals repository to 3 | .. other related repositories. If you need to make changes to this file, 4 | .. make the changes in openstack-manuals. After any change merged to, 5 | .. openstack-manuals, automatically a patch for others will be proposed. 6 | .. ##################################################################### 7 | 8 | =========== 9 | Conventions 10 | =========== 11 | 12 | The OpenStack documentation uses several typesetting conventions. 13 | 14 | Notices 15 | ~~~~~~~ 16 | 17 | Notices take these forms: 18 | 19 | .. note:: A comment with additional information that explains a part of the 20 | text. 21 | 22 | .. important:: Something you must be aware of before proceeding. 23 | 24 | .. tip:: An extra but helpful piece of practical advice. 25 | 26 | .. caution:: Helpful information that prevents the user from making mistakes. 27 | 28 | .. warning:: Critical information about the risk of data loss or security 29 | issues. 30 | 31 | Command prompts 32 | ~~~~~~~~~~~~~~~ 33 | 34 | .. code-block:: console 35 | 36 | $ command 37 | 38 | Any user, including the ``root`` user, can run commands that are 39 | prefixed with the ``$`` prompt. 40 | 41 | .. code-block:: console 42 | 43 | # command 44 | 45 | The ``root`` user must run commands that are prefixed with the ``#`` 46 | prompt. You can also prefix these commands with the :command:`sudo` 47 | command, if available, to run them. 48 | -------------------------------------------------------------------------------- /doc/common/figures/SCH_5002_V00_NUAC-Keystone.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/common/figures/SCH_5002_V00_NUAC-Keystone.png -------------------------------------------------------------------------------- /doc/common/figures/demo_multiple_dhcp_agents.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/common/figures/demo_multiple_dhcp_agents.png -------------------------------------------------------------------------------- /doc/common/figures/horizon-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/common/figures/horizon-screenshot.png -------------------------------------------------------------------------------- /doc/common/figures/osog_0001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/common/figures/osog_0001.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/additional-git-workflow.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _git_workflow: 3 | 4 | ======================= 5 | Additional Git workflow 6 | ======================= 7 | 8 | This section contains additional workflow instructions that you may need 9 | while contributing to OpenStack documentation. 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | 14 | additional-git-workflow/rebase.rst 15 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/additional-git-workflow/rebase.rst: -------------------------------------------------------------------------------- 1 | .. _git-rebase: 2 | 3 | Resolving merge conflicts 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | If the change that you submitted has a merge conflict, 7 | you need to manually resolve it using :command:`git rebase`. 8 | 9 | Rebasing is used to integrate changes from one branch into another to 10 | resolve conflicts when multiple commits happen on the same file. 11 | 12 | .. warning:: 13 | 14 | Never do a rebase on public (master) branches. 15 | 16 | #. You submit a change. 17 | 18 | #. Somebody else submits a change and that change merges. 19 | Now your change has a merge conflict. 20 | 21 | #. Update your local repository: 22 | 23 | .. code-block:: console 24 | 25 | $ git remote update 26 | $ git pull --ff-only origin master 27 | 28 | #. Download your change: 29 | 30 | .. code-block:: console 31 | 32 | $ git review -d $PARENT_CHANGE_NUMBER 33 | 34 | #. Rebase your change: 35 | 36 | .. code-block:: console 37 | 38 | $ git rebase origin/master 39 | 40 | 41 | #. Resolve conflicts manually: 42 | 43 | Conflicts are marked in a file with clear line breaks: 44 | 45 | .. code-block:: console 46 | 47 | <<<<<<< HEAD 48 | Second line. 49 | ======= 50 | Third line. 51 | >>>>>>> feature/topic branch. 52 | 53 | <<<<<<<: Indicates the start of the lines that had a merge conflict. 54 | 55 | =======: Indicates separation of the two conflicting changes. 56 | 57 | >>>>>>>: Indicates the end of the lines that had a merge conflict. 58 | 59 | You need to resolve a conflict by manually editing the file. 60 | You also need to delete the '<<<<<<<', '=======', and'>>>>>>>' 61 | in the file. 62 | 63 | #. Add the files to the stage: 64 | 65 | .. code-block:: console 66 | 67 | $ git add $FILENAME 68 | 69 | #. Complete the rebase process: 70 | 71 | .. code-block:: console 72 | 73 | $ git rebase --continue 74 | 75 | #. Send the rebased patch again for review: 76 | 77 | .. code-block:: console 78 | 79 | $ git review 80 | 81 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/blueprints-and-specs.rst: -------------------------------------------------------------------------------- 1 | .. _content-specs: 2 | 3 | ============================= 4 | Blueprints and specifications 5 | ============================= 6 | 7 | The Documentation team uses specifications in the `docs-specs repository 8 | `_ to maintain large 9 | changes. Approved specifications are published at `Documentation Program 10 | Specifications `_. 11 | For tracking purposes, a blueprint is created for each specification. 12 | 13 | Use blueprints and specifications: 14 | 15 | * For any large reorganization of a deliverable or set of deliverables. 16 | * For infrastructure or automation work that needs to be designed prior to 17 | proposing a patch. 18 | * When adding an entirely new deliverable to the docs project. 19 | * When adding large sections to an existing document to ensure involvement 20 | of the docs core team. 21 | * For any work that requires both content and tooling changes, such as 22 | addition of the API reference site. 23 | * For work that should definitely be discussed at a project teams gathering. 24 | 25 | A specification needs two +2 votes from the docs core team. See the current 26 | list of `docs core team members 27 | `_. 28 | 29 | Use bugs against a particular repository with documentation: 30 | 31 | * For known content issues, even if you have to do multiple patches to close 32 | the bug. 33 | * To add content that is just missing. 34 | * For known errors in a document. 35 | 36 | For more information, see :ref:`doc_bugs`. 37 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/common: -------------------------------------------------------------------------------- 1 | ../../common -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/diagram-guidelines.rst: -------------------------------------------------------------------------------- 1 | .. _diagramguidelines: 2 | 3 | ================== 4 | Diagram guidelines 5 | ================== 6 | 7 | Diagram guidelines are 8 | intended for designers, developers, or reviewers 9 | contributing illustrations to OpenStack documentation. 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | 14 | diagram-guidelines/diagram-usage.rst 15 | diagram-guidelines/tools.rst 16 | diagram-guidelines/files.rst 17 | diagram-guidelines/general-guidelines.rst 18 | 19 | In addition to these resources, ensure you 20 | review the :ref:`stg_writing_style` section. The general 21 | writing style guidelines also apply to content in 22 | diagrams. 23 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/diagram-guidelines/diagram-usage.rst: -------------------------------------------------------------------------------- 1 | .. _diagramusage: 2 | 3 | ====================== 4 | Use diagrams sparingly 5 | ====================== 6 | 7 | Diagrams can be useful tools to help orient users visualize complex 8 | processes. However, diagrams can sometimes be too simplistic, confusing 9 | the user instead of helping. The decision about whether a diagram is 10 | useful depends on the context of each project and the discretion 11 | of each contributor and reviewer. 12 | 13 | When to use diagrams 14 | ~~~~~~~~~~~~~~~~~~~~ 15 | 16 | Include diagrams in OpenStack documentation in the following 17 | situations: 18 | 19 | * If there is evidence of a process, whether the process is 20 | automated or manual 21 | 22 | Example: Basic setup workflow 23 | 24 | * If you need to clarify configurations and reference architectures 25 | 26 | Example: Code review, upstream versus local environment 27 | 28 | 29 | When not to use diagrams 30 | ~~~~~~~~~~~~~~~~~~~~~~~~ 31 | 32 | Do not include diagrams in the following situations: 33 | 34 | * When a workflow is too simplistic 35 | * When there is no interaction with an OpenStack project 36 | * When a configuration can be easily explained through text 37 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/diagram-guidelines/files.rst: -------------------------------------------------------------------------------- 1 | .. _dg_files: 2 | 3 | ============================ 4 | Use recommended file formats 5 | ============================ 6 | 7 | Each diagram should include files in the following formats: 8 | 9 | * Raster, always Portable Network Graphics (``.png``). 10 | The documentation build process uses these files. 11 | * Vector, typically Scalable Vector Graphics (``.svg``). 12 | Most illustration tools support editing these files. 13 | * Original, typically the native format of the tool. 14 | 15 | At a minimum, each diagram must include a ``.png`` and ``.svg`` file. 16 | 17 | Furthermore, any outside stencils or objects added to a diagram 18 | should also be ``.svg`` files, so that reviewers can edit individual elements 19 | of the diagram. 20 | 21 | .. Note:: Using ``.svg`` files for individual elements may cause rendering 22 | issues when editing the diagram in a different tool than the one 23 | from which the diagram was originally created. 24 | 25 | File names 26 | ~~~~~~~~~~ 27 | 28 | Contributors must create unique and meaningful file names to 29 | differentiate between diagrams. An example of this is the name 30 | ``cg-workflow-digram.png``. ``cg`` indicates that this diagram belongs 31 | in the contributor guidelines, the acronym created by taking 32 | the first letters of the OpenStack book name. ``workflow-diagram.png`` 33 | provides a description of what the diagram is about, as well as the 34 | file type extension. 35 | 36 | Other file guidelines 37 | ~~~~~~~~~~~~~~~~~~~~~ 38 | 39 | * Files must be saved with a transparent background. 40 | * Files must be saved in a landscape document style. 41 | * Diagram width and height should be no more than 900pt. 42 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/diagram-guidelines/tools.rst: -------------------------------------------------------------------------------- 1 | .. _dg_tools: 2 | 3 | ===== 4 | Tools 5 | ===== 6 | 7 | There are many tools you can use to create a diagram, 8 | and contributors are free to use the tool of their choice. 9 | 10 | However, elements within a diagram must be easily edited or 11 | easy to reproduce with a different tool. Follow the file saving 12 | conventions outlined in :ref:`dg_files`. 13 | This ensures that a diagram can be reviewed and edited as OpenStack 14 | projects continue to change. 15 | 16 | Open source tools can help streamline the review process by making 17 | diagrams easy to edit. Many open-source tools contain shapes and 18 | stencils that can be used in OpenStack. The following is a list of 19 | recommended open-source tools: 20 | 21 | * `Draw.io `_: Draw.io contains most of the 22 | customization options needed to make diagrams. Diagrams can also 23 | be saved as a ``.svg`` file, which allows contributors to edit 24 | individual elements of each diagram. 25 | 26 | .. I have left this space for other contributors to recommend 27 | any other open source diagram tools. 28 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/doc-index.rst: -------------------------------------------------------------------------------- 1 | =================================== 2 | Landing pages on docs.openstack.org 3 | =================================== 4 | 5 | The main index pages on docs.openstack.org are part of the 6 | ``openstack-manuals`` repository in the ``www`` folder. These are 7 | generated by a template generator as described in 8 | :doc:`doc-tools/template-generator`. 9 | 10 | Official OpenStack projects hosted on the ``docs.openstack.org`` site 11 | should add their links to the main index pages as explained at 12 | :doc:`doc-tools/template-generator`. 13 | 14 | For projects with many subprojects, like deployment projects or 15 | plug-in lists of networking or bare metal, the main project page 16 | should be linked and the project should have links to their 17 | subprojects or plug-ins that they maintain themselves. 18 | 19 | Note that these projects can add additional entries to the global 20 | redirect list in the file ``www/.htaccess``. 21 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/doc-tools.rst: -------------------------------------------------------------------------------- 1 | .. _doc-tools: 2 | 3 | ========================= 4 | Using documentation tools 5 | ========================= 6 | 7 | The OpenStack documentation toolkit includes a number of scripts used 8 | for performing automated tasks to maintain the OpenStack documentation 9 | project. For example, there are tools that generate a sitemap, check niceness, 10 | synchronize files used across multiple repositories, and others. 11 | 12 | This section provides an overview of the documentation tools and their 13 | location, explains how to install, configure, use, and contribute to them. 14 | 15 | .. toctree:: 16 | :maxdepth: 2 17 | 18 | doc-tools/scripts.rst 19 | doc-tools/template-generator.rst 20 | doc-tools/installation.rst 21 | doc-tools/contributing.rst 22 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/doc-tools/contributing.rst: -------------------------------------------------------------------------------- 1 | =========================================== 2 | Contribute to OpenStack documentation tools 3 | =========================================== 4 | 5 | If you would like to contribute to OpenStack documentation tools, you are 6 | welcome to submit a patch or file a bug against the toolkit. 7 | 8 | Contribute to the tool development 9 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 10 | 11 | To contribute to the development of ``openstack-doc-tools``, proceed with 12 | the following steps: 13 | 14 | #. Complete the procedures described 15 | in the `Developers Guide `_. 16 | 17 | #. Follow `OpenStack Style Commandments `_ 18 | while developing improvements for the tool. 19 | 20 | #. Run tests before you submit your change request. 21 | 22 | For now, the documentation toolkit is tested with basic ``flake8`` 23 | and ``bashate`` tests. A test suite would be welcome. 24 | 25 | #. Submit your change for review through the Gerrit tool as described 26 | in the `gerrit workflow `_. 27 | 28 | .. warning:: 29 | 30 | Pull requests submitted through GitHub will be ignored. 31 | 32 | .. note:: 33 | 34 | To be able to run ``"tox -e py27"`` successfully locally, add 35 | ``jinja2`` and ``markupsafe`` to your local ``test-requirements.txt`` 36 | file to have them installed in your local virtual environment. 37 | 38 | 39 | File a bug against the tools 40 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41 | 42 | If you experience an issue while using the tools, 43 | file a bug on Launchpad in the `openstack-doc-tools project 44 | `_. Do not file issues on 45 | GitHub. 46 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/doc-tools/installation.rst: -------------------------------------------------------------------------------- 1 | .. _doc-toolsd-installation: 2 | 3 | ===================================== 4 | Install OpenStack documentation tools 5 | ===================================== 6 | 7 | To install the documentation toolkit: 8 | 9 | #. Verify that you have installed 10 | the `prerequisites `_. 11 | 12 | #. Install the ``openstack-doc-tools`` package: 13 | 14 | .. code-block:: console 15 | 16 | $ pip install openstack-doc-tools 17 | 18 | If you have ``virtualenvwrapper`` installed, run: 19 | 20 | .. code:: 21 | 22 | $ mkvirtualenv openstack-doc-tools 23 | $ pip install openstack-doc-tools 24 | 25 | #. To use ``openstack-doc-tools``, import the tools to a project: 26 | 27 | .. code-block:: console 28 | 29 | import os_doc_tools 30 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/figures/doc-logo-fox.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/figures/doc-logo-fox.jpg -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/index.rst: -------------------------------------------------------------------------------- 1 | ========================================= 2 | OpenStack Documentation Contributor Guide 3 | ========================================= 4 | 5 | .. figure:: figures/doc-logo-fox.jpg 6 | :alt: Documentation Logo 7 | :scale: 40% 8 | :align: center 9 | 10 | Abstract 11 | ~~~~~~~~ 12 | 13 | This guide provides detailed instructions on the contribution workflow and 14 | conventions to be considered by all documentation contributors. Please 15 | follow these guidelines to keep the documentation structure, style, and 16 | syntax consistent. 17 | 18 | Contents 19 | ~~~~~~~~ 20 | 21 | .. toctree:: 22 | :maxdepth: 2 23 | 24 | quickstart.rst 25 | team-structure.rst 26 | team-vision.rst 27 | non-native-english-speakers.rst 28 | blueprints-and-specs.rst 29 | project-guides 30 | doc-index.rst 31 | doc-tag.rst 32 | api-guides.rst 33 | doc-bugs.rst 34 | writing-docs.rst 35 | writing-style.rst 36 | user-guidelines.rst 37 | rst-conv.rst 38 | json-conv.rst 39 | diagram-guidelines.rst 40 | docs-review.rst 41 | docs-builds.rst 42 | redirects.rst 43 | doc-tools.rst 44 | release.rst 45 | 46 | Glossary 47 | ~~~~~~~~ 48 | 49 | .. toctree:: 50 | :maxdepth: 1 51 | 52 | common/glossary.rst 53 | 54 | Search 55 | ~~~~~~ 56 | 57 | * :ref:`search` 58 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/json-conv.rst: -------------------------------------------------------------------------------- 1 | .. _json_conv: 2 | 3 | ================ 4 | JSON conventions 5 | ================ 6 | 7 | OpenStack uses JSON format. Use the following JSON formatting conventions: 8 | 9 | * Format JSON files to be human readable. 10 | * Use four spaces for indentation (matching OpenStack conventions used in 11 | Python and shell scripts). Do not use tab characters in the code, always 12 | use spaces. 13 | * Use one space after the name-separator (colon). 14 | * Obey the formal JSON format; in particular, wrap strings in double 15 | (not single) quotes. 16 | * Sample files may have their keys ordered if that makes the file easier 17 | to understand. Automatic reformatting tools preserve the order of keys. 18 | 19 | Example: 20 | 21 | .. code-block:: json 22 | 23 | { 24 | "uuid": "d8e02d56-2648-49a3-bf97-6be8f1204f38", 25 | "availability_zone": "nova", 26 | "hostname": "test.novalocal", 27 | "launch_index": 0, 28 | "array0": [], 29 | "array1": [ 30 | "low" 31 | ], 32 | "array3": [ 33 | "low", 34 | "high", 35 | "mid" 36 | ], 37 | "object0": {}, 38 | "object1": { 39 | "value": "low", 40 | "role": "some" 41 | }, 42 | "name": "test" 43 | } 44 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/quickstart.rst: -------------------------------------------------------------------------------- 1 | .. _quickstart: 2 | 3 | ========== 4 | Quickstart 5 | ========== 6 | 7 | There are several reasons why you might consider contributing to OpenStack 8 | documentation. This chapter addresses the main reasons why you might 9 | contribute, and gives specific information about how to get started in each 10 | use case. 11 | 12 | .. toctree:: 13 | :maxdepth: 2 14 | 15 | quickstart/first-timers.rst 16 | quickstart/developers.rst 17 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/release.rst: -------------------------------------------------------------------------------- 1 | .. _doc-release: 2 | 3 | ================================== 4 | Publishing a documentation release 5 | ================================== 6 | 7 | This section describes the tasks that need to be completed to publish the 8 | documentation for an OpenStack release. It is intended to be used by the 9 | PTL and release managers. 10 | 11 | The current release manager for Documentation is listed on the 12 | `Cross Project Liaisons wiki page 13 | `_. 14 | 15 | .. toctree:: 16 | :maxdepth: 2 17 | 18 | release/taskoverview.rst 19 | release/taskdetail.rst 20 | release/release-tools.rst 21 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/release/release-tools.rst: -------------------------------------------------------------------------------- 1 | =============== 2 | Releasing tools 3 | =============== 4 | 5 | The ``openstackdocstheme``, ``openstack-doc-tools``, and 6 | ``os-api-ref`` repositories need to be released as packages to the 7 | `Python Packaging Index `__. 8 | 9 | The release is done by the OpenStack release team but needs to be triggered by 10 | the documentation team. For details, see `Release management 11 | `_. 12 | For the steps required to trigger a release, see the openstack/releases `README 13 | `_ file. 14 | 15 | For a review example triggering a new package release, see 16 | `Change 448891: Release openstackdocstheme 1.7.0 17 | `_. 18 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/release/taskoverview.rst: -------------------------------------------------------------------------------- 1 | ====================== 2 | Release tasks overview 3 | ====================== 4 | 5 | This section provides an overview of the tasks that need to be completed 6 | for a documentation release, and a rough schedule of when to complete 7 | each task. The schedule is expressed in terms of `time before release day`. 8 | Release day is usually 1300UTC on the `initial release date` listed on the 9 | `release schedule `_. 10 | 11 | *Two to four weeks* 12 | Ping subteam leads to review and update release notes for openstack-manuals. 13 | 14 | *At RC1* 15 | When projects create their branches and land the first patch, they will 16 | automatically have branch-specific documentation. 17 | 18 | *Before or on release day* 19 | Create a project data file in the ``openstack-manuals`` repository for the 20 | new series. Update the series settings in the template generator and add the 21 | landing page for the next series by copying the templates from the 22 | current release to the new release directory. 23 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv.rst: -------------------------------------------------------------------------------- 1 | .. _rst_conv: 2 | 3 | =============== 4 | RST conventions 5 | =============== 6 | 7 | OpenStack documentation uses reStructuredText (RST) markup syntax 8 | with Sphinx extensions. 9 | 10 | RST is a powerful and straightforward markup language that, in combination 11 | with Sphinx, provides a wide range of facilities for intelligent and 12 | appealing documentation creation. It uses simple and implicit 13 | syntax to introduce a variety of content elements such as titles, 14 | code blocks, vertical lists, and many others. All the source content formatted 15 | using RST is stored in files with the ``.rst`` extension. 16 | 17 | To keep the documentation format consistent, follow the guidelines 18 | included in this chapter for all the RST source content. When in doubt, 19 | use simpler formatting. 20 | 21 | .. note:: 22 | 23 | All the examples provided in this chapter are for illustration purposes 24 | only and cannot be regarded as pieces of true technical information. 25 | 26 | .. toctree:: 27 | :maxdepth: 2 28 | 29 | rst-conv/general-guidelines.rst 30 | rst-conv/file-naming.rst 31 | rst-conv/titles.rst 32 | rst-conv/inline-markups.rst 33 | rst-conv/lists.rst 34 | rst-conv/specific-info.rst 35 | rst-conv/source-code.rst 36 | rst-conv/references.rst 37 | rst-conv/tables.rst 38 | rst-conv/figures.rst 39 | rst-conv/profiling.rst 40 | rst-conv/comment.rst 41 | rst-conv/decorations.rst 42 | 43 | Useful links 44 | ~~~~~~~~~~~~ 45 | 46 | * `Sphinx documentation `_ 47 | * `reStructuredText: Markup Syntax and Parser Component of Docutils 48 | `_ 49 | * `Quick reStructuredText `_ 50 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/comment.rst: -------------------------------------------------------------------------------- 1 | ======== 2 | Comments 3 | ======== 4 | 5 | Indicate a comment by means of the ``..`` marker. 6 | 7 | **Input** 8 | 9 | .. code-block:: none 10 | 11 | .. This is a comment. It is not visible in the documentation build. 12 | Generally, use it to include TODO within the content followed 13 | by the initials of the person who is to perform the action. 14 | 15 | For example: 16 | 17 | .. TODO(OG): add a link to the Decorations section when it is available. 18 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/decorations.rst: -------------------------------------------------------------------------------- 1 | =========== 2 | Decorations 3 | =========== 4 | 5 | Sometimes, the documentation build does not look perfect. To improve 6 | readability and, therefore, understanding of the content, you can use 7 | some visual decorations. 8 | 9 | This section contains a number of bells and whistles that are neither 10 | conventions nor even recommendations, but extra features of RST markup 11 | syntax for general educational purposes. 12 | 13 | Adding a horizontal line 14 | ~~~~~~~~~~~~~~~~~~~~~~~~ 15 | 16 | You can create a horizontal line to visually separate content elements 17 | by typing four ``-`` (hyphen) in a row adding blank lines before and after. 18 | 19 | **Input** 20 | 21 | .. code-block:: none 22 | 23 | Paragraph 1 24 | 25 | ---- 26 | 27 | Paragraph 2 28 | 29 | **Output** 30 | 31 | Paragraph 1 32 | 33 | ---- 34 | 35 | Paragraph 2 36 | 37 | Starting a new line 38 | ~~~~~~~~~~~~~~~~~~~ 39 | 40 | Use ``|`` (vertical bar) followed by a single white space to start a new line. 41 | 42 | **Input** 43 | 44 | .. code-block:: none 45 | 46 | | The first line of text. 47 | | The second line of text (new line). 48 | | ... 49 | 50 | **Output** 51 | 52 | | The first line of text. 53 | | The second line of text (new line). 54 | | ... 55 | 56 | Adding extra space between two content elements 57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 58 | 59 | Use ``|`` (vertical bar) adding blank lines before and after it to add extra 60 | space between two content elements. 61 | 62 | **Input** 63 | 64 | .. code-block:: none 65 | 66 | Paragraph 1 67 | 68 | | 69 | 70 | Paragraph 2 71 | 72 | **Output** 73 | 74 | Paragraph 1 75 | 76 | | 77 | 78 | Paragraph 2 79 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/figures.rst: -------------------------------------------------------------------------------- 1 | .. _rst_figures: 2 | 3 | ======= 4 | Figures 5 | ======= 6 | 7 | Use the ``figure`` directive to include an image, figure, or screenshot into 8 | the documentation. 9 | 10 | The PNG image format is preferred over other image formats for all image 11 | files. If available the source files (SVG, OmniGraffle, ..) of generated 12 | image files should be provided. Formats editable by open sources tools are 13 | preferred. 14 | 15 | **Syntax** 16 | 17 | .. code-block:: none 18 | 19 | .. figure:: file_name.file_extension 20 | :option: option_value 21 | 22 | The figure directive supports the following options: 23 | 24 | * alt 25 | * height 26 | * figwidth 27 | * scale 28 | * align 29 | * target 30 | * figclass 31 | 32 | For descriptions of the options and their possible values, refer to the 33 | `Docutils documentation `_. 34 | 35 | .. seealso:: 36 | 37 | For the style guidelines on figure titles, see :ref:`figure_table_titles`. 38 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/file-naming.rst: -------------------------------------------------------------------------------- 1 | .. _filename-conv: 2 | 3 | ========================= 4 | File naming and structure 5 | ========================= 6 | 7 | File naming conventions 8 | ~~~~~~~~~~~~~~~~~~~~~~~ 9 | 10 | To indicate the hierarchical type of files for filenames: 11 | 12 | * Follow a page-based, topical approach to file naming and do not apply 13 | any special prefixes. 14 | * Use hyphens as space delimiters for `search optimization `_. 15 | 16 | For example, ``technical-considerations-multi-site.rst``. 17 | 18 | Directory structure 19 | ~~~~~~~~~~~~~~~~~~~ 20 | 21 | For better organization, use subdirectories to organize the files 22 | by a particular grouping such as project or topic. 23 | 24 | Common practices include: 25 | 26 | * Figure subdirectory includes images (both PNG and SVG source files). 27 | * Sample subdirectory contains samples of source code and configuration files. 28 | * Chapter subdirectory stores all sections included in one chapter with the 29 | parent file located in the top-level directory. 30 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/general-guidelines.rst: -------------------------------------------------------------------------------- 1 | ================== 2 | General guidelines 3 | ================== 4 | 5 | Lines length 6 | ~~~~~~~~~~~~ 7 | 8 | Wrap source lines so that lines length does not exceed 79 characters. 9 | This requirement matches PEP8 standards (from Python) and helps with 10 | side-by-side diffs on reviews. 11 | 12 | .. note:: 13 | 14 | An exception to this rule is the content of code-block elements and links 15 | within the references. 16 | 17 | When formatting a table that presupposes long lines of text, give 18 | preference to one of the following methods over the ``table`` directive: 19 | 20 | * Format a table using the ``list-table`` directive. 21 | * Format a table using the ``csv-table`` directive. 22 | * Format information as definition lists to avoid tables where possible. 23 | 24 | Space and tab characters 25 | ~~~~~~~~~~~~~~~~~~~~~~~~ 26 | 27 | * Do not use tab characters within the code, use space characters instead. 28 | 29 | * Do not place space characters at the end of lines. If used, 30 | the linters test will fail because of trailing whitespaces. 31 | 32 | Indentation 33 | ~~~~~~~~~~~ 34 | 35 | Use indentation very carefully and keep it consistent since it is significant 36 | for content nesting. Any indentation that differs from the previous 37 | one in length, terminates the current level of content either introducing 38 | a new content sublevel, or shifting to an upper content level. 39 | 40 | Use indentation to format the nested content within: 41 | 42 | * Definition lists 43 | * Admonitions (notes, warnings, and so on) 44 | * Code blocks 45 | * List and CSV tables 46 | 47 | For more information on how to format elements from the list above, 48 | see the related section of this chapter. 49 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/profiling.rst: -------------------------------------------------------------------------------- 1 | ========= 2 | Profiling 3 | ========= 4 | 5 | Installation Guides have content that depends upon the operating 6 | systems. 7 | 8 | Use separate files to specify content that is operating-system specific. Each 9 | file should have the same name but with an additional suffix. The following 10 | suffixes should be used: 11 | 12 | * ``ubuntu`` for Ubuntu 13 | * ``debian`` for Debian 14 | * ``rdo`` for Red Hat Enterprise Linux and CentOS 15 | * ``obs`` for openSUSE and SUSE Linux Enterprise 16 | 17 | .. note:: 18 | 19 | Previously, ``.. only`` directive was used to generate conditional output. 20 | This required multiple builds and has since been phased out. 21 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/specific-info.rst: -------------------------------------------------------------------------------- 1 | =========================== 2 | Specific information blocks 3 | =========================== 4 | 5 | Use special markups to emphasize specific information within your document. 6 | Depending on specific semantic meaning of the message, you can use: 7 | 8 | * **note** - for a message of generic meaning. 9 | 10 | * **warning** or **important** - includes details that can be easily missed, 11 | but should not be ignored by a user and are valuable before proceeding. 12 | 13 | * **caution** - delivers information that prevents a user from mistakes 14 | and undesirable consequences when following the procedures. 15 | 16 | * **tip** or **seealso** - wraps extra but helpful information. 17 | 18 | Here is the example of the note directive usage; these can be applied to all 19 | the admonition directives described above. 20 | 21 | **Input** 22 | 23 | .. code-block:: none 24 | 25 | .. note:: 26 | 27 | This is the text of a generic admonition. 28 | This line is the continuation of the first line. 29 | 30 | A note may contain bulleted or enumerated lists, 31 | as well as code blocks: 32 | 33 | * First option, 34 | * ... 35 | 36 | **Output** 37 | 38 | .. note:: 39 | 40 | This is the text of a note admonition. 41 | This line is the continuation of the first line. 42 | 43 | A note may contain bulleted or enumerated lists, 44 | as well as code blocks: 45 | 46 | * First option, 47 | * ... 48 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/rst-conv/titles.rst: -------------------------------------------------------------------------------- 1 | .. _cg_titles: 2 | 3 | ====== 4 | Titles 5 | ====== 6 | 7 | Each RST source file has the tree structure. Define up to three heading 8 | levels within one file using the following non-alphanumeric characters: 9 | 10 | * **Heading 1** - underline and overline with equal signs; 11 | 12 | * **Heading 2** - underline with dashes; 13 | 14 | * **Heading 3** - underline with tildes. 15 | 16 | **Input** 17 | 18 | .. code:: 19 | 20 | ========= 21 | Heading 1 22 | ========= 23 | 24 | Body of the first level section that includes general overview 25 | of the subject to be covered by the whole section. 26 | Can include several focused Heading-2-sections. 27 | 28 | Heading 2 29 | --------- 30 | 31 | Body of the second level section that gives detailed explanation of one 32 | of the aspects of the subject. Can include several Heading-3-sections. 33 | 34 | Within user guides, it is mostly used to entitle a procedure with a set 35 | of actions targeted at a single task performance. 36 | For example, "Associate floating IP addresses". 37 | 38 | Heading 3 39 | ~~~~~~~~~ 40 | 41 | Body of the third level section. 42 | It includes very specific content, and occurs mainly in guides containing 43 | technical information for advanced users. 44 | 45 | .. note:: 46 | 47 | Under- and overlines should be of the same length 48 | as that of the heading text. 49 | 50 | Avoid using lower heading levels by rewriting and reorganizing the 51 | information. 52 | 53 | .. seealso:: 54 | 55 | General :ref:`guidelines for headings and titles ` 56 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/team-structure.rst: -------------------------------------------------------------------------------- 1 | .. _team_structure: 2 | 3 | ============================ 4 | Documentation team structure 5 | ============================ 6 | 7 | The Documentation project provides documentation for various OpenStack 8 | projects to promote OpenStack, develop and maintain tools and processes 9 | to ensure quality and accuracy of documentation. 10 | 11 | The OpenStack community has merged the Documentation team (also know as 12 | 'Technical Writing' SIG ) into the OpenStack Technical Committee: 13 | https://review.opendev.org/c/openstack/governance/+/815869 If you have 14 | any question regarding the documentation or training guides please feel 15 | free to contact `the OpenStack Technical Committee 16 | `_ 17 | 18 | The current list of docs cores for openstack-manuals, openstackdocstheme, 19 | and openstack-doc-tools repositories can be found at 20 | https://review.opendev.org/#/admin/groups/30,members. 21 | 22 | The api-site, contributor-guide, security-doc, and training-guides 23 | repositories have separate core teams but also include the 24 | docs core team. 25 | 26 | The cross-project liaisons (CPLs) assist with subject matter questions, 27 | reviews, doc bug triaging, and patching docs. 28 | Refer to `documentation cross-project liaisons 29 | `_ 30 | for the list of people, and if you are interested in becoming a CPL 31 | for docs, contact the Documentation PTL. 32 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/topic-tags.rst: -------------------------------------------------------------------------------- 1 | .. _topic_tags: 2 | 3 | ========== 4 | Topic tags 5 | ========== 6 | 7 | When changing or discussing the contents of the openstack-manuals repository, 8 | we recommend that you add the tags in the head of the git commit message or 9 | email subject line to show the topic explicitly. Based on the topic you refer 10 | to, use the following tags: 11 | 12 | [common] 13 | Common contents for several guides in the common directory 14 | 15 | [doc-contrib] 16 | OpenStack Documentation Contributor Guide 17 | 18 | [image-guide] 19 | OpenStack Virtual Machine Image Guide 20 | 21 | [install] 22 | OpenStack Installation Guides 23 | 24 | [WIP] 25 | A marker that means the commit is a work in progress 26 | 27 | [www] 28 | Web page contents 29 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/user-guidelines.rst: -------------------------------------------------------------------------------- 1 | .. _user-guidelines: 2 | 3 | ======================================================= 4 | OpenStack user experience and user interface guidelines 5 | ======================================================= 6 | 7 | This section describes :abbr:`UX (User eXperience)`, :abbr:`UI (User 8 | Interface)`, and :abbr:`GUI (Graphic User Interface)` guidelines. It intends 9 | to improve OpenStack user experience by suggesting non-prescriptive methods 10 | and techniques in the following sections: 11 | 12 | #. UX Personas: The UX personas are intended as referential use-cases that 13 | designers and developers can use when building content. 14 | #. GUI Guidelines: The GUI guidelines are intended for designers and 15 | developers contributing content to GUI projects. 16 | #. UI Text Guidelines: The UI text guidelines are intended for designers, 17 | developers, or reviewers contributing content within OpenStack user 18 | interfaces. 19 | 20 | .. toctree:: 21 | :maxdepth: 2 22 | 23 | ux-ui-guidelines/ux-personas.rst 24 | ux-ui-guidelines/gui-guidelines.rst 25 | ux-ui-guidelines/ui-text-guidelines.rst 26 | 27 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-actions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-actions.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-cancelbutton.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-cancelbutton.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-errors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-errors.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-modalerror.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-modalerror.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-search.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-wizards.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/gui-wizards.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/persona-ecosystem.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/persona-ecosystem.png -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/figures/ui-text-cheatsheet.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/doc-contrib-guide/source/ux-ui-guidelines/figures/ui-text-cheatsheet.jpg -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/ui-text-guidelines.rst: -------------------------------------------------------------------------------- 1 | .. _uitextguidelines: 2 | 3 | ================== 4 | UI text guidelines 5 | ================== 6 | 7 | User interface (UI) text guidelines are 8 | intended for designers, developers, or reviewers 9 | contributing content within OpenStack user interfaces. 10 | Use these text guidelines to ensure that the OpenStack interface 11 | is usable, consistent, and concise. 12 | 13 | 14 | .. toctree:: 15 | :maxdepth: 2 16 | 17 | ui-text-guidelines/ui-text-capitalization.rst 18 | ui-text-guidelines/ui-action-labels.rst 19 | ui-text-guidelines/ui-error-messages.rst 20 | ui-text-guidelines/ui-panel-formatting.rst 21 | 22 | In addition to these resources, ensure you 23 | review the :ref:`stg_writing_style` section. The general 24 | writing style guidelines also apply to content in 25 | the user interface. 26 | 27 | Top Tips 28 | ~~~~~~~~ 29 | 30 | Use these tips and quick links to access UI text guidance reminders. 31 | 32 | * Avoid abbreviations, acronyms, and slang. Unless the abbreviation 33 | is better known than the word it stands for or space savings is 34 | critical. 35 | * :ref:`Write in active voice` 36 | * :ref:`Be clear and concise` 37 | * :ref:`Write objectively` 38 | * :ref:`Do not use contractions` 39 | * :ref:`Eliminate needless politeness` 40 | * :ref:`Use consistent terminology` 41 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/ui-text-guidelines/ui-action-labels.rst: -------------------------------------------------------------------------------- 1 | .. _uiactionlabels: 2 | 3 | ================================ 4 | Use recommended UI action labels 5 | ================================ 6 | 7 | It is important to use consistent labels across an action. 8 | 9 | .. In progress...please add, remove, edit based on 10 | what is applicable to OpenStack. 11 | 12 | .. list-table:: Common action labels 13 | :header-rows: 1 14 | 15 | * - Action label 16 | - Typical Usage 17 | * - ``Create`` 18 | - Creates a new object. 19 | * - ``Delete`` 20 | - Destroys an existing object. Label can 21 | include the object being deleted, 22 | such as Delete Image. 23 | * - ``Download`` 24 | - Transfers a file to a user's local system. 25 | * - ``Edit`` 26 | - Allows data or values to be modified. Edit 27 | does not imply the object is automatically 28 | updated. In most cases, you still must update 29 | in order for the change to occur. 30 | * - ``Filter`` 31 | - Changes view to only include objects that 32 | match the filter criteria. 33 | * - ``Import`` 34 | - Includes objects from an external source. 35 | * - ``Manage`` 36 | - Modifies existing object settings or options. 37 | * - ``Save`` 38 | - Saves data entered when you create an object. 39 | * - ``Update`` 40 | - Automatically changes the data of an existing object. 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/ui-text-guidelines/ui-error-messages.rst: -------------------------------------------------------------------------------- 1 | .. _uierrormessages: 2 | 3 | ========================== 4 | Follow UI alert guidelines 5 | ========================== 6 | 7 | Alerts, or messages, are important to inform users about progress 8 | that they make or problems that they encounter in the user interface. 9 | 10 | Use the following alert types: 11 | 12 | * Success 13 | * Info 14 | * Warning 15 | * Danger (Error) 16 | 17 | General alert guidelines 18 | ~~~~~~~~~~~~~~~~~~~~~~~~ 19 | 20 | When writing alerts, follow these rules: 21 | 22 | * Be courteous and do not blame the user 23 | * Use present tense to describe conditions that currently exist, or 24 | use past tense to describe a specific event that occurred in the 25 | past 26 | * Keep sentences short but helpful 27 | * Adhere to the guidelines in the :ref:`stg_writing_style` section 28 | 29 | Alert structure for new danger (error) conditions 30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 31 | 32 | A danger alert, or error message, should help the user resolve the 33 | problem quickly so that they can continue making progress. Do not 34 | include an error if you can avoid publishing the alert by enhancing 35 | the code. 36 | 37 | #. State the problem clearly and briefly. 38 | #. If appropriate, explain why the user encountered the error. 39 | #. If possible, tell the user how to fix the problem. If further 40 | information is needed, consider whether the documentation should 41 | be enhanced. 42 | 43 | .. note:: 44 | 45 | API returns might not be specific enough to adhere to these 46 | structure guidelines. Be as explicit as you can in stating the 47 | problem and resolution. 48 | 49 | Alert examples 50 | ~~~~~~~~~~~~~~ 51 | 52 | Success 53 | * Successfully created key pair %(name)s. 54 | * Image successfully updated. 55 | 56 | Info 57 | * Updating volume snapshot "%s" 58 | * Creating volume "%s" 59 | 60 | Warning 61 | * Policy check failed. 62 | * Insufficient privilege level exists to view user information. 63 | 64 | Danger 65 | * Unable to create the volume. 66 | * Unable to retrieve the image. 67 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/ux-ui-guidelines/ui-text-guidelines/ui-panel-formatting.rst: -------------------------------------------------------------------------------- 1 | .. _uipanelformatting: 2 | 3 | =================================== 4 | Use recommended UI panel formatting 5 | =================================== 6 | 7 | It is important to use consistent style and 8 | placement for text and icons in the UI. 9 | 10 | .. In progress. please edit, add, etc... 11 | 12 | Workflow navigation text 13 | ~~~~~~~~~~~~~~~~~~~~~~~~ 14 | 15 | Use default values for page or window title bars, 16 | side navigation, fonts, and text size. 17 | For example, tab titles must be a smaller 18 | text size than the section heading. 19 | 20 | Similarly, the node item title must be a smaller 21 | font than the page or window title. If necessary, 22 | you might have to shorten the node item title 23 | in order to maintain the default width. 24 | 25 | .. note:: 26 | 27 | The image below is not to scale. It is 28 | only intended as a reference for the 29 | various UI elements mentioned. 30 | 31 | .. image:: ../figures/ui-text-cheatsheet.jpg 32 | :alt: UI text cheat sheet 33 | 34 | Icons 35 | ~~~~~ 36 | 37 | Be selective when deciding to use icons instead 38 | of text. It is often difficult for users to 39 | understand the intent of an icon. New icons 40 | should be thoroughly reviewed and tested by 41 | the user experience project. That said, icons 42 | can improve usability in specific instances. 43 | 44 | For example: 45 | 46 | * You have limited space. 47 | * The icon is quickly recognizable. 48 | 49 | .. note:: 50 | 51 | Consider global audiences and whether the 52 | icon is recognizable across cultural differences. 53 | 54 | * The icon enhances design appeal. 55 | 56 | If you decide to use an icon, follow these tips: 57 | 58 | * Keep the design simple and consistent. 59 | * Keep the location of individual icons 60 | consistent. 61 | Users recognize and expect patterns 62 | which help to establish meaning and function. 63 | * Ensure the icon is quickly recognizable and 64 | memorable. For help, work with the UX 65 | project. 66 | * If there is space, consider adding a text 67 | label to the icon. 68 | 69 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-docs.rst: -------------------------------------------------------------------------------- 1 | ===================== 2 | Writing documentation 3 | ===================== 4 | 5 | This chapter describes what documentation contributors should follow 6 | to ensure consistency throughout all technical publications. 7 | 8 | You need to understand :doc:`blueprints-and-specs` before you start 9 | writing. When writing documentation, follow: 10 | 11 | * :doc:`writing-style` 12 | * :doc:`rst-conv` 13 | * :doc:`json-conv` 14 | 15 | You can :doc:`build your documentation locally ` 16 | to determine if your change renders properly. 17 | 18 | .. toctree:: 19 | :maxdepth: 2 20 | 21 | topic-structure.rst 22 | topic-tags.rst 23 | additional-git-workflow.rst 24 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _stg_writing_style: 3 | 4 | ============= 5 | Writing style 6 | ============= 7 | 8 | This section describes general writing style guidelines that 9 | documentation contributors should follow to ensure consistency 10 | throughout all technical publications. 11 | 12 | .. toctree:: 13 | :maxdepth: 2 14 | 15 | writing-style/general-writing-guidelines.rst 16 | writing-style/word-choice.rst 17 | writing-style/punctuation.rst 18 | writing-style/headings.rst 19 | writing-style/lists.rst 20 | writing-style/urls.rst 21 | writing-style/num_and_units_of_measure.rst 22 | writing-style/openstack-components.rst 23 | writing-style/release-names.rst 24 | writing-style/ui-terminology.rst 25 | writing-style/code-conventions.rst 26 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/code-conventions.rst: -------------------------------------------------------------------------------- 1 | .. _code_conventions: 2 | 3 | Code conventions 4 | ~~~~~~~~~~~~~~~~ 5 | 6 | Follow these guidelines: 7 | 8 | * **Do not use "-y" for package install** 9 | 10 | When you describe package installation, do not use the ``-y`` option. 11 | Instead, use ``apt-get install package``, ``yum install package``, or 12 | ``zypper install package``. 13 | 14 | * **Use "--option ARGUMENT"** 15 | 16 | The OpenStack CLI supports both ``--option ARGUMENT`` and 17 | ``--option=ARGUMENT``. In technical publications, use ``--option ARGUMENT``. 18 | 19 | * **Use capital letters with underscores for parameters** 20 | 21 | When you write parameters in an example command, 22 | use capital letters for the parameters, with underscore as a delimiter. 23 | For example: 24 | 25 | .. code-block:: console 26 | 27 | $ openstack user create --project PROJECT_A --password PASSWORD USERNAME 28 | 29 | If necessary, describe the parameters immediately after the example 30 | command block. For example, for the ``PASSWORD`` parameter: 31 | 32 | .. code-block:: none 33 | 34 | Replace ``PASSWORD`` with a suitable password. 35 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/lists.rst: -------------------------------------------------------------------------------- 1 | ===== 2 | Lists 3 | ===== 4 | 5 | When reading a document for the first time, users scan through pages stopping 6 | only on the content that stands out, such as titles, lists, links, diagrams, 7 | and so on. Lists help to organize options, as well as help readers to find 8 | information easily. 9 | 10 | When listing items, follow these guidelines: 11 | 12 | * Use a **bulleted list** for options. Create a bulleted list when you need 13 | to describe more than three options. 14 | * Use a **numbered list** for steps. 15 | * Use a **definition list** to explain terms or describe command-line 16 | parameters, options, or arguments. 17 | * Use a colon at the end of the sentence that introduces a list. 18 | * Use the same grammatical structure (aka parallel structure) for all items 19 | in a list. 20 | * Start each option with a capital letter. 21 | 22 | When listing options in a paragraph, add *and* or *or* before the last item 23 | in a list. Use a serial (Oxford) comma before these conjunctions if they 24 | connect three or more items. 25 | 26 | Punctuation in lists 27 | ~~~~~~~~~~~~~~~~~~~~ 28 | 29 | In bulleted lists: 30 | 31 | * If you list individual words or phrases, do not add a period at the end 32 | of each list item. 33 | 34 | * If you use full sentences, add a period at the end of each sentence. 35 | 36 | * If your list includes both individual words or phrases and full sentences, 37 | be consistent and either add or do not add periods to all items. 38 | 39 | In numbered lists: 40 | 41 | * Add periods at the end of steps. 42 | 43 | * If an item of a numbered list is followed by a code block that illustrates 44 | how to perform the step, use a colon at the end. 45 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/num_and_units_of_measure.rst: -------------------------------------------------------------------------------- 1 | ============================ 2 | Numbers and units of measure 3 | ============================ 4 | 5 | When using numbers in running text, follow these guidelines: 6 | 7 | * Spell out numbers from one to nine. However, use numerals for units 8 | of measure. 9 | * Use Arabic numerals for numbers above ten. 10 | * If a numeral starts a sentence, spell it out. For example: *Five thousand 11 | environments have been deployed during the last six months.* 12 | * In one sentence, use either a spelled-out number or a numeral, not both. 13 | * Use a comma if a numeral includes more than 4 digits. For example: *50,000*. 14 | 15 | In mathematical expressions: 16 | 17 | * Use the *x* symbol for multiplication. 18 | * Add a space between numbers and operators. For example: *256 x 2 = 512*. 19 | 20 | When using units of measure in running text, follow these guidelines: 21 | 22 | * Use the corresponding unit symbol if a unit of measure comes immediately 23 | after a numeral. 24 | 25 | * **Kb** for kilobit 26 | * **KB** for kilobyte 27 | * **kbps** for kilobits per second 28 | * **GB** for gigabyte 29 | * **Gbit** for gigabit 30 | * **MB** for megabyte 31 | 32 | * Do not pluralize an abbreviated unit of measure. 33 | * Add a space between a numeral and a unit of measure. 34 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/openstack-components.rst: -------------------------------------------------------------------------------- 1 | .. _openstack_term: 2 | 3 | OpenStack service and project names 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | Use uppercase when you refer to a service name. For example, use 7 | *Compute service*, *Image service*, or *Identity service* instead 8 | of *nova*, *glance*, or *keystone*. 9 | 10 | Use lowercase when you refer to: 11 | 12 | * project names 13 | * project team names 14 | * command-line interface (CLI) 15 | 16 | For more information, see `Service and Project Naming 17 | `_ 18 | in OpenStack Technical Committee governance documents. 19 | 20 | The official source for services and project names is in the 21 | `projects.yaml `_ 22 | file in the ``openstack/governance`` repository. 23 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/punctuation.rst: -------------------------------------------------------------------------------- 1 | =========== 2 | Punctuation 3 | =========== 4 | 5 | Use standard U.S. English rules of punctuation. The table includes some 6 | general recommendations on the punctuation marks usage based on common 7 | mistakes made by contributors. 8 | 9 | .. list-table:: 10 | :header-rows: 1 11 | :widths: 10 25 15 12 | 13 | * - Punctuation mark 14 | - How to use 15 | - Example 16 | 17 | * - Serial (Oxford) comma 18 | - Use comma before the *and* and *or* conjunctions that connect items 19 | in series of three or more. 20 | - You can create, update, and delete roles. 21 | 22 | * - Semicolon 23 | - Avoid using semicolons in sentences. Use periods or a commas instead. 24 | Use semicolons only to separate series of words separated by commas. 25 | - Large, medium, or small; soft or hard; black, gray, or white. 26 | 27 | * - Colon 28 | - Use colons to introduce lists and code examples or tables where 29 | needed. Do not use colons in headings if this is not explicitly 30 | required. Typically, use lowercase letters after colons 31 | in running text. 32 | - The configuration values are: 33 | 34 | * ``certfile`` 35 | * ... 36 | 37 | * - Quotation marks 38 | - Generally, avoid using quotation marks, use the corresponding markup 39 | instead. 40 | 41 | Though, if the quotation marks are required, place commas and periods 42 | inside closing quotation marks. 43 | This applies to both words-as-words and sentence fragments. 44 | - The screen displays, "Hello, world." 45 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/release-names.rst: -------------------------------------------------------------------------------- 1 | .. _release_names: 2 | 3 | Release names 4 | ~~~~~~~~~~~~~ 5 | 6 | Use the names of the OpenStack releases as described on 7 | the `OpenStack Releases `_ 8 | page 9 | 10 | **Example:** 11 | 12 | Icehouse - a single word with only the first initial capitalized. 13 | 14 | -------------------------------------------------------------------------------- /doc/doc-contrib-guide/source/writing-style/urls.rst: -------------------------------------------------------------------------------- 1 | ==== 2 | URLs 3 | ==== 4 | 5 | Use the following example URL as a guideline for the use of example URLs. 6 | 7 | .. note:: 8 | 9 | Example.org is reserved by IANA for example URLs. 10 | 11 | Use the convention `project_name`, then `openstack`, followed by `example.org`. 12 | For example: 13 | 14 | ``http://glance.openstack.example.org/`` 15 | -------------------------------------------------------------------------------- /doc/glossary/source/common: -------------------------------------------------------------------------------- 1 | ../../common -------------------------------------------------------------------------------- /doc/glossary/source/index.rst: -------------------------------------------------------------------------------- 1 | ================== 2 | OpenStack Glossary 3 | ================== 4 | 5 | Abstract 6 | ~~~~~~~~ 7 | 8 | This document is a glossary of terms relevant to OpenStack. 9 | 10 | Contents 11 | ~~~~~~~~ 12 | 13 | .. toctree:: 14 | :maxdepth: 2 15 | 16 | common/glossary.rst 17 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/de/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # Frank Kloeker , 2017. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: Glossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2017-09-14 12:53+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2017-09-14 09:16+0000\n" 11 | "Last-Translator: Frank Kloeker \n" 12 | "Language-Team: German\n" 13 | "Language: de\n" 14 | "X-Generator: Zanata 3.9.6\n" 15 | "Plural-Forms: nplurals=2; plural=(n != 1)\n" 16 | 17 | msgid "Abstract" 18 | msgstr "Übersicht" 19 | 20 | msgid "Contents" 21 | msgstr "Inhalt" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "OpenStack Glossar" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "Dieses Dokument ist ein Glossar mit relevanten Begriffen zu OpenStack" 28 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/en_GB/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # Andi Chandler , 2017. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: Glossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2018-02-26 18:51+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2017-10-06 08:01+0000\n" 11 | "Last-Translator: Andi Chandler \n" 12 | "Language-Team: English (United Kingdom)\n" 13 | "Language: en_GB\n" 14 | "X-Generator: Zanata 4.3.3\n" 15 | "Plural-Forms: nplurals=2; plural=(n != 1)\n" 16 | 17 | msgid "Abstract" 18 | msgstr "Abstract" 19 | 20 | msgid "Contents" 21 | msgstr "Contents" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "OpenStack Glossary" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "This document is a glossary of terms relevant to OpenStack." 28 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/fi_FI/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # Jori Kuusinen , 2018. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: openstackdocumentationglossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2018-09-21 02:59+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2018-09-20 09:24+0000\n" 11 | "Last-Translator: Jori Kuusinen \n" 12 | "Language-Team: Finnish (Finland)\n" 13 | "Language: fi_FI\n" 14 | "X-Generator: Zanata 4.3.3\n" 15 | "Plural-Forms: nplurals=2; plural=(n != 1)\n" 16 | 17 | msgid "Abstract" 18 | msgstr "Yhteenveto" 19 | 20 | msgid "Contents" 21 | msgstr "Sisältö" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "OpenStack sanasto" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "Tämä dokumentti on OpenStackiin liittyvä sanasto." 28 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/id/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # suhartono , 2017. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: Glossary 15.0\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2017-08-10 04:26+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2017-08-10 03:45+0000\n" 11 | "Last-Translator: suhartono \n" 12 | "Language-Team: Indonesian\n" 13 | "Language: id\n" 14 | "X-Generator: Zanata 3.9.6\n" 15 | "Plural-Forms: nplurals=1; plural=0\n" 16 | 17 | msgid "Abstract" 18 | msgstr "Abstrak" 19 | 20 | msgid "Contents" 21 | msgstr "Isi" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "Daftar Istilah OpenStack" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "Dokumen ini adalah glosarium istilah yang relevan dengan OpenStack." 28 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/ko_KR/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # minwook-shin , 2017. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: Glossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2018-02-26 18:51+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2017-08-21 02:07+0000\n" 11 | "Last-Translator: minwook-shin \n" 12 | "Language-Team: Korean (South Korea)\n" 13 | "Language: ko_KR\n" 14 | "X-Generator: Zanata 4.3.3\n" 15 | "Plural-Forms: nplurals=1; plural=0\n" 16 | 17 | msgid "Abstract" 18 | msgstr "요약" 19 | 20 | msgid "Contents" 21 | msgstr "내용" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "오픈스택 용어집" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "이 문서는 OpenStack과 관련된 용어집입니다." 28 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/ru/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # Ilya Alekseyev , 2018. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: openstackdocumentationglossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2018-10-26 01:41+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2018-10-26 12:51+0000\n" 11 | "Last-Translator: Ilya Alekseyev \n" 12 | "Language-Team: Russian\n" 13 | "Language: ru\n" 14 | "X-Generator: Zanata 4.3.3\n" 15 | "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n" 16 | "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n" 17 | 18 | msgid "Abstract" 19 | msgstr "Введение" 20 | 21 | msgid "Contents" 22 | msgstr "Содержание" 23 | 24 | msgid "OpenStack Glossary" 25 | msgstr "Глоссарий OpenStack" 26 | 27 | msgid "This document is a glossary of terms relevant to OpenStack." 28 | msgstr "Этот документ содержит глоссарий терминов относящихся к OpenStack." 29 | -------------------------------------------------------------------------------- /doc/glossary/source/locale/zh_CN/LC_MESSAGES/glossary.po: -------------------------------------------------------------------------------- 1 | # TigerFang , 2018. #zanata 2 | msgid "" 3 | msgstr "" 4 | "Project-Id-Version: openstackdocumentationglossary\n" 5 | "Report-Msgid-Bugs-To: \n" 6 | "POT-Creation-Date: 2018-05-31 12:22+0000\n" 7 | "MIME-Version: 1.0\n" 8 | "Content-Type: text/plain; charset=UTF-8\n" 9 | "Content-Transfer-Encoding: 8bit\n" 10 | "PO-Revision-Date: 2018-06-01 08:02+0000\n" 11 | "Last-Translator: TigerFang \n" 12 | "Language-Team: Chinese (China)\n" 13 | "Language: zh_CN\n" 14 | "X-Generator: Zanata 4.3.3\n" 15 | "Plural-Forms: nplurals=1; plural=0\n" 16 | 17 | msgid "Abstract" 18 | msgstr "摘要" 19 | 20 | msgid "Contents" 21 | msgstr "目录" 22 | 23 | msgid "OpenStack Glossary" 24 | msgstr "OpenStack术语" 25 | 26 | msgid "This document is a glossary of terms relevant to OpenStack." 27 | msgstr "此文档是OpenStack相关术语的一个列表。" 28 | -------------------------------------------------------------------------------- /doc/image-guide/source/common: -------------------------------------------------------------------------------- 1 | ../../common -------------------------------------------------------------------------------- /doc/image-guide/source/create-images-manually.rst: -------------------------------------------------------------------------------- 1 | ====================== 2 | Create images manually 3 | ====================== 4 | 5 | Creating a new image is a step done outside of your 6 | OpenStack installation. You create the new image manually on 7 | your own system and then upload the image to your cloud. 8 | 9 | To create a new image, you will need the installation CD or 10 | DVD ISO file for the guest operating system. You will also need 11 | access to a virtualization tool. You can use KVM for this. Or, 12 | if you have a GUI desktop virtualization tool (such as, VMware 13 | Fusion or VirtualBox), you can use that instead. 14 | Convert the file to raw once you are done. 15 | 16 | When you create a new virtual machine image, you will need 17 | to connect to the graphical console of the hypervisor, which 18 | acts as the virtual machine's display and allows you to interact 19 | with the guest operating system's installer using your keyboard 20 | and mouse. KVM can expose the graphical console using the 21 | `VNC `_ 22 | (Virtual Network Computing) protocol or the newer 23 | `SPICE `_ protocol. 24 | We will use the VNC protocol here, since you are more likely 25 | to find a VNC client that works on your local desktop. 26 | 27 | To create an image for the Database service, 28 | see `Building Guest Images for OpenStack Trove 29 | `_. 30 | 31 | Tools 32 | ----- 33 | 34 | .. toctree:: 35 | :maxdepth: 1 36 | 37 | create-images-manually-tools-libvirt.rst 38 | 39 | Examples 40 | -------- 41 | 42 | .. toctree:: 43 | :maxdepth: 1 44 | 45 | create-images-manually-example-centos-image.rst 46 | create-images-manually-example-fedora-image.rst 47 | create-images-manually-example-freebsd-image.rst 48 | create-images-manually-example-windows-image.rst 49 | create-images-manually-example-ubuntu-image.rst 50 | -------------------------------------------------------------------------------- /doc/image-guide/source/figures/centos-complete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/centos-complete.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/centos-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/centos-install.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/centos-tcpip.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/centos-tcpip.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/centos-url-setup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/centos-url-setup.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/freebsd-partitions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/freebsd-partitions.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/ubuntu-finished.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/ubuntu-finished.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/ubuntu-grub.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/ubuntu-grub.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/ubuntu-install.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/ubuntu-install.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/ubuntu-software-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/ubuntu-software-selection.png -------------------------------------------------------------------------------- /doc/image-guide/source/figures/virt-manager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/image-guide/source/figures/virt-manager.png -------------------------------------------------------------------------------- /doc/image-guide/source/index.rst: -------------------------------------------------------------------------------- 1 | ===================================== 2 | OpenStack Virtual Machine Image Guide 3 | ===================================== 4 | 5 | Abstract 6 | ~~~~~~~~ 7 | 8 | This guide describes how to obtain, create, and modify virtual 9 | machine images that are compatible with OpenStack. 10 | 11 | Contents 12 | ~~~~~~~~ 13 | 14 | .. toctree:: 15 | :maxdepth: 2 16 | 17 | common/conventions.rst 18 | introduction.rst 19 | obtain-images.rst 20 | openstack-images.rst 21 | modify-images.rst 22 | create-images-manually.rst 23 | create-images-automatically.rst 24 | convert-images.rst 25 | share-images.rst 26 | common/appendix.rst 27 | -------------------------------------------------------------------------------- /doc/install-guide/source/common: -------------------------------------------------------------------------------- 1 | ../../common -------------------------------------------------------------------------------- /doc/install-guide/source/environment-etcd-rdo.rst: -------------------------------------------------------------------------------- 1 | ======================== 2 | Etcd for RHEL and CentOS 3 | ======================== 4 | 5 | OpenStack services may use Etcd, a distributed reliable key-value store 6 | for distributed key locking, storing configuration, keeping track of service 7 | live-ness and other scenarios. 8 | 9 | The etcd service runs on the controller node. 10 | 11 | Install and configure components 12 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 13 | 14 | #. Install the package: 15 | 16 | .. code-block:: console 17 | 18 | # dnf install etcd 19 | 20 | 2. Edit the ``/etc/etcd/etcd.conf`` file and set the ``ETCD_INITIAL_CLUSTER``, 21 | ``ETCD_INITIAL_ADVERTISE_PEER_URLS``, ``ETCD_ADVERTISE_CLIENT_URLS``, 22 | ``ETCD_LISTEN_CLIENT_URLS`` to the management IP address of the controller 23 | node to enable access by other nodes via the management network: 24 | 25 | .. code-block:: ini 26 | 27 | #[Member] 28 | ETCD_DATA_DIR="/var/lib/etcd/default.etcd" 29 | ETCD_LISTEN_PEER_URLS="http://10.0.0.11:2380" 30 | ETCD_LISTEN_CLIENT_URLS="http://10.0.0.11:2379" 31 | ETCD_NAME="controller" 32 | #[Clustering] 33 | ETCD_INITIAL_ADVERTISE_PEER_URLS="http://10.0.0.11:2380" 34 | ETCD_ADVERTISE_CLIENT_URLS="http://10.0.0.11:2379" 35 | ETCD_INITIAL_CLUSTER="controller=http://10.0.0.11:2380" 36 | ETCD_INITIAL_CLUSTER_TOKEN="etcd-cluster-01" 37 | ETCD_INITIAL_CLUSTER_STATE="new" 38 | 39 | 40 | Finalize installation 41 | ~~~~~~~~~~~~~~~~~~~~~ 42 | 43 | #. Enable and start the etcd service: 44 | 45 | .. code-block:: console 46 | 47 | # systemctl enable etcd 48 | # systemctl start etcd 49 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-etcd-ubuntu.rst: -------------------------------------------------------------------------------- 1 | =============== 2 | Etcd for Ubuntu 3 | =============== 4 | 5 | OpenStack services may use Etcd, a distributed reliable key-value store 6 | for distributed key locking, storing configuration, keeping track of service 7 | live-ness and other scenarios. 8 | 9 | The etcd service runs on the controller node. 10 | 11 | Install and configure components 12 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 13 | 14 | #. Install the ``etcd`` package: 15 | 16 | .. code-block:: console 17 | 18 | # apt install etcd 19 | 20 | .. note:: 21 | 22 | As of Ubuntu 18.04, the ``etcd`` package is no longer 23 | available from the default repository. To install successfully, 24 | enable the ``Universe`` repository on Ubuntu. 25 | 26 | As for Ubuntu 24.04 install the package with following name: 27 | 28 | .. code-block:: console 29 | 30 | # apt install etcd-server 31 | 32 | #. Edit the ``/etc/default/etcd`` file and set the ``ETCD_INITIAL_CLUSTER``, 33 | ``ETCD_INITIAL_ADVERTISE_PEER_URLS``, ``ETCD_ADVERTISE_CLIENT_URLS``, 34 | ``ETCD_LISTEN_CLIENT_URLS`` to the management IP address of the 35 | controller node to enable access by other nodes via the management 36 | network: 37 | 38 | .. code-block:: none 39 | 40 | ETCD_NAME="controller" 41 | ETCD_DATA_DIR="/var/lib/etcd" 42 | ETCD_INITIAL_CLUSTER_STATE="new" 43 | ETCD_INITIAL_CLUSTER_TOKEN="etcd-cluster-01" 44 | ETCD_INITIAL_CLUSTER="controller=http://10.0.0.11:2380" 45 | ETCD_INITIAL_ADVERTISE_PEER_URLS="http://10.0.0.11:2380" 46 | ETCD_ADVERTISE_CLIENT_URLS="http://10.0.0.11:2379" 47 | ETCD_LISTEN_PEER_URLS="http://0.0.0.0:2380" 48 | ETCD_LISTEN_CLIENT_URLS="http://10.0.0.11:2379" 49 | 50 | Finalize installation 51 | ~~~~~~~~~~~~~~~~~~~~~ 52 | 53 | #. Enable and restart the etcd service: 54 | 55 | .. code-block:: console 56 | 57 | # systemctl enable etcd 58 | # systemctl restart etcd 59 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-etcd.rst: -------------------------------------------------------------------------------- 1 | ==== 2 | Etcd 3 | ==== 4 | 5 | OpenStack services may use Etcd, a distributed reliable key-value store 6 | for distributed key locking, storing configuration, keeping track of service 7 | live-ness and other scenarios. 8 | 9 | .. toctree:: 10 | :glob: 11 | 12 | environment-etcd-* 13 | 14 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-memcached-rdo.rst: -------------------------------------------------------------------------------- 1 | Memcached for RHEL and CentOS 2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3 | 4 | The Identity service authentication mechanism for services uses Memcached 5 | to cache tokens. The memcached service typically runs on the controller 6 | node. For production deployments, we recommend enabling a combination of 7 | firewalling, authentication, and encryption to secure it. 8 | 9 | Install and configure components 10 | -------------------------------- 11 | 12 | #. Install the packages: 13 | 14 | .. code-block:: console 15 | 16 | # dnf install memcached python3-memcached 17 | 18 | 2. Edit the ``/etc/sysconfig/memcached`` file and complete the 19 | following actions: 20 | 21 | * Configure the service to use the management IP address of the 22 | controller node. This is to enable access by other nodes via 23 | the management network: 24 | 25 | .. code-block:: none 26 | 27 | OPTIONS="-l 127.0.0.1,::1,controller" 28 | 29 | .. note:: 30 | 31 | Change the existing line ``OPTIONS="-l 127.0.0.1,::1"``. 32 | 33 | Finalize installation 34 | --------------------- 35 | 36 | * Start the Memcached service and configure it to start when the system 37 | boots: 38 | 39 | .. code-block:: console 40 | 41 | # systemctl enable memcached.service 42 | # systemctl start memcached.service 43 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-memcached-ubuntu.rst: -------------------------------------------------------------------------------- 1 | Memcached for Ubuntu 2 | ~~~~~~~~~~~~~~~~~~~~ 3 | 4 | The Identity service authentication mechanism for services uses Memcached 5 | to cache tokens. The memcached service typically runs on the controller 6 | node. For production deployments, we recommend enabling a combination of 7 | firewalling, authentication, and encryption to secure it. 8 | 9 | Install and configure components 10 | -------------------------------- 11 | 12 | #. Install the packages: 13 | 14 | For Ubuntu versions prior to 18.04 use: 15 | 16 | .. code-block:: console 17 | 18 | # apt install memcached python-memcache 19 | 20 | For Ubuntu 18.04 and newer versions use: 21 | 22 | .. code-block:: console 23 | 24 | # apt install memcached python3-memcache 25 | 26 | 2. Edit the ``/etc/memcached.conf`` file and configure the 27 | service to use the management IP address of the controller node. 28 | This is to enable access by other nodes via the management network: 29 | 30 | .. code-block:: none 31 | 32 | -l 10.0.0.11 33 | 34 | .. note:: 35 | 36 | Change the existing line that had ``-l 127.0.0.1``. 37 | 38 | Finalize installation 39 | --------------------- 40 | 41 | * Restart the Memcached service: 42 | 43 | .. code-block:: console 44 | 45 | # service memcached restart 46 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-memcached.rst: -------------------------------------------------------------------------------- 1 | Memcached 2 | ~~~~~~~~~ 3 | 4 | The Identity service authentication mechanism for services uses Memcached 5 | to cache tokens. The memcached service typically runs on the controller 6 | node. For production deployments, we recommend enabling a combination of 7 | firewalling, authentication, and encryption to secure it. 8 | 9 | .. toctree:: 10 | :glob: 11 | 12 | environment-memcached-* 13 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-messaging-rdo.rst: -------------------------------------------------------------------------------- 1 | Message queue for RHEL and CentOS 2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3 | 4 | OpenStack uses a :term:`message queue` to coordinate operations and 5 | status information among services. The message queue service typically 6 | runs on the controller node. OpenStack supports several message queue 7 | services including `RabbitMQ `__ and 8 | `Qpid `__. 9 | However, most distributions that package OpenStack support a particular 10 | message queue service. This guide implements the RabbitMQ message queue 11 | service because most distributions support it. If you prefer to 12 | implement a different message queue service, consult the documentation 13 | associated with it. 14 | 15 | The message queue runs on the controller node. 16 | 17 | Install and configure components 18 | -------------------------------- 19 | 20 | 1. Install the package: 21 | 22 | .. code-block:: console 23 | 24 | # dnf install rabbitmq-server 25 | 26 | 2. Start the message queue service and configure it to start when the 27 | system boots: 28 | 29 | .. code-block:: console 30 | 31 | # systemctl enable rabbitmq-server.service 32 | # systemctl start rabbitmq-server.service 33 | 34 | 3. Add the ``openstack`` user: 35 | 36 | .. code-block:: console 37 | 38 | # rabbitmqctl add_user openstack RABBIT_PASS 39 | 40 | Creating user "openstack" ... 41 | 42 | Replace ``RABBIT_PASS`` with a suitable password. 43 | 44 | 4. Permit configuration, write, and read access for the 45 | ``openstack`` user: 46 | 47 | .. code-block:: console 48 | 49 | # rabbitmqctl set_permissions openstack ".*" ".*" ".*" 50 | 51 | Setting permissions for user "openstack" in vhost "/" ... 52 | 53 | .. note:: 54 | 55 | Sometimes it's necessary to increase the file descriptor limit for RabbitMQ to 56 | handle a large number of connections properly. 57 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-messaging-ubuntu.rst: -------------------------------------------------------------------------------- 1 | Message queue for Ubuntu 2 | ~~~~~~~~~~~~~~~~~~~~~~~~ 3 | 4 | OpenStack uses a :term:`message queue` to coordinate operations and 5 | status information among services. The message queue service typically 6 | runs on the controller node. OpenStack supports several message queue 7 | services including `RabbitMQ `__ and 8 | `Qpid `__. 9 | However, most distributions that package OpenStack support a particular 10 | message queue service. This guide implements the RabbitMQ message queue 11 | service because most distributions support it. If you prefer to 12 | implement a different message queue service, consult the documentation 13 | associated with it. 14 | 15 | The message queue runs on the controller node. 16 | 17 | Install and configure components 18 | -------------------------------- 19 | 20 | 1. Install the package: 21 | 22 | .. code-block:: console 23 | 24 | # apt install rabbitmq-server 25 | 26 | 2. Add the ``openstack`` user: 27 | 28 | .. code-block:: console 29 | 30 | # rabbitmqctl add_user openstack RABBIT_PASS 31 | 32 | Creating user "openstack" ... 33 | 34 | Replace ``RABBIT_PASS`` with a suitable password. 35 | 36 | 3. Permit configuration, write, and read access for the 37 | ``openstack`` user: 38 | 39 | .. code-block:: console 40 | 41 | # rabbitmqctl set_permissions openstack ".*" ".*" ".*" 42 | 43 | Setting permissions for user "openstack" in vhost "/" ... 44 | 45 | .. note:: 46 | 47 | Sometimes it's necessary to increase the file descriptor limit for RabbitMQ to 48 | handle a large number of connections properly. 49 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-messaging.rst: -------------------------------------------------------------------------------- 1 | Message queue 2 | ~~~~~~~~~~~~~ 3 | 4 | OpenStack uses a :term:`message queue` to coordinate operations and 5 | status information among services. The message queue service typically 6 | runs on the controller node. OpenStack supports several message queue 7 | services including `RabbitMQ `__ and 8 | `Qpid `__. 9 | However, most distributions that package OpenStack support a particular 10 | message queue service. This guide implements the RabbitMQ message queue 11 | service because most distributions support it. If you prefer to 12 | implement a different message queue service, consult the documentation 13 | associated with it. 14 | 15 | The message queue runs on the controller node. 16 | 17 | .. toctree:: 18 | :glob: 19 | 20 | environment-messaging-* 21 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-networking-compute.rst: -------------------------------------------------------------------------------- 1 | Compute node 2 | ~~~~~~~~~~~~ 3 | 4 | Configure network interfaces 5 | ---------------------------- 6 | 7 | #. Configure the first interface as the management interface: 8 | 9 | IP address: 10.0.0.31 10 | 11 | Network mask: 255.255.255.0 (or /24) 12 | 13 | Default gateway: 10.0.0.1 14 | 15 | .. note:: 16 | 17 | Additional compute nodes should use 10.0.0.32, 10.0.0.33, and so on. 18 | 19 | #. The provider interface uses a special configuration without an IP 20 | address assigned to it. Configure the second interface as the provider 21 | interface: 22 | 23 | Replace ``INTERFACE_NAME`` with the actual interface name. For example, 24 | *eth1* or *ens224*. 25 | 26 | For Ubuntu: 27 | 28 | * Edit the ``/etc/network/interfaces`` file to contain the following: 29 | 30 | .. code-block:: bash 31 | 32 | # The provider network interface 33 | auto INTERFACE_NAME 34 | iface INTERFACE_NAME inet manual 35 | up ip link set dev $IFACE up 36 | down ip link set dev $IFACE down 37 | 38 | For RHEL or CentOS: 39 | 40 | * Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file 41 | to contain the following: 42 | 43 | Do not change the ``HWADDR`` and ``UUID`` keys. 44 | 45 | .. code-block:: bash 46 | 47 | DEVICE=INTERFACE_NAME 48 | TYPE=Ethernet 49 | ONBOOT="yes" 50 | BOOTPROTO="none" 51 | 52 | For SUSE: 53 | 54 | * Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to 55 | contain the following: 56 | 57 | .. code-block:: bash 58 | 59 | STARTMODE='auto' 60 | BOOTPROTO='static' 61 | 62 | #. Reboot the system to activate the changes. 63 | 64 | Configure name resolution 65 | ------------------------- 66 | 67 | #. Set the hostname of the node to ``compute1``. 68 | 69 | #. .. include:: shared/edit_hosts_file.txt 70 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-networking-controller.rst: -------------------------------------------------------------------------------- 1 | Controller node 2 | ~~~~~~~~~~~~~~~ 3 | 4 | Configure network interfaces 5 | ---------------------------- 6 | 7 | #. Configure the first interface as the management interface: 8 | 9 | IP address: 10.0.0.11 10 | 11 | Network mask: 255.255.255.0 (or /24) 12 | 13 | Default gateway: 10.0.0.1 14 | 15 | #. The provider interface uses a special configuration without an IP 16 | address assigned to it. Configure the second interface as the provider 17 | interface: 18 | 19 | Replace ``INTERFACE_NAME`` with the actual interface name. For example, 20 | *eth1* or *ens224*. 21 | 22 | For Ubuntu: 23 | 24 | * Edit the ``/etc/network/interfaces`` file to contain the following: 25 | 26 | .. code-block:: bash 27 | 28 | # The provider network interface 29 | auto INTERFACE_NAME 30 | iface INTERFACE_NAME inet manual 31 | up ip link set dev $IFACE up 32 | down ip link set dev $IFACE down 33 | 34 | For RHEL or CentOS: 35 | 36 | * Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file 37 | to contain the following: 38 | 39 | Do not change the ``HWADDR`` and ``UUID`` keys. 40 | 41 | .. code-block:: ini 42 | 43 | DEVICE=INTERFACE_NAME 44 | TYPE=Ethernet 45 | ONBOOT="yes" 46 | BOOTPROTO="none" 47 | 48 | For SUSE: 49 | 50 | * Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to 51 | contain the following: 52 | 53 | .. code-block:: ini 54 | 55 | STARTMODE='auto' 56 | BOOTPROTO='static' 57 | 58 | #. Reboot the system to activate the changes. 59 | 60 | Configure name resolution 61 | ------------------------- 62 | 63 | #. Set the hostname of the node to ``controller``. 64 | 65 | #. .. include:: shared/edit_hosts_file.txt 66 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-networking-storage-cinder.rst: -------------------------------------------------------------------------------- 1 | Block storage node (Optional) 2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3 | 4 | If you want to deploy the Block Storage service, configure one 5 | additional storage node. 6 | 7 | Configure network interfaces 8 | ---------------------------- 9 | 10 | * Configure the management interface: 11 | 12 | * IP address: ``10.0.0.41`` 13 | 14 | * Network mask: ``255.255.255.0`` (or ``/24``) 15 | 16 | * Default gateway: ``10.0.0.1`` 17 | 18 | Configure name resolution 19 | ------------------------- 20 | 21 | #. Set the hostname of the node to ``block1``. 22 | 23 | #. .. include:: shared/edit_hosts_file.txt 24 | 25 | #. Reboot the system to activate the changes. 26 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-ntp-other.rst: -------------------------------------------------------------------------------- 1 | .. _environment-ntp-other: 2 | 3 | ============ 4 | Other nodes 5 | ============ 6 | 7 | Other nodes reference the controller node for clock synchronization. 8 | Perform these steps on all other nodes. 9 | 10 | Install and configure components 11 | ================================ 12 | 13 | 1. Install the packages. 14 | 15 | For Ubuntu: 16 | 17 | .. code-block:: console 18 | 19 | # apt install chrony 20 | 21 | For RHEL or CentOS Stream: 22 | 23 | .. code-block:: console 24 | 25 | # dnf install chrony 26 | 27 | 2. Configure the ``chrony.conf`` file and comment out or remove all 28 | but one ``server`` key. Change it to reference the controller node. 29 | 30 | For RHEL or CentOS Stream, edit the ``/etc/chrony.conf`` file: 31 | 32 | .. code-block:: ini 33 | 34 | server controller iburst 35 | 36 | For RHEL/CentOS Stream in case of using firewalld don't forget to update firewall rules as follows: 37 | 38 | .. code-block:: console 39 | 40 | # firewall-cmd --permanent --add-service=ntp 41 | # firewall-cmd --reload 42 | 43 | For Ubuntu, edit the ``/etc/chrony/chrony.conf`` file: 44 | 45 | .. code-block:: ini 46 | 47 | server controller iburst 48 | 49 | 3. Comment out the ``pool 2.debian.pool.ntp.org offline iburst`` line. 50 | 51 | 4. Restart the NTP service. 52 | 53 | For Ubuntu: 54 | 55 | .. code-block:: console 56 | 57 | # service chrony restart 58 | 59 | For RHEL or CentOS Stream: 60 | 61 | .. code-block:: console 62 | 63 | # systemctl enable chronyd.service 64 | # systemctl start chronyd.service 65 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-ntp-verify.rst: -------------------------------------------------------------------------------- 1 | .. _environment-ntp-verify: 2 | 3 | Verify operation 4 | ~~~~~~~~~~~~~~~~ 5 | 6 | We recommend that you verify NTP synchronization before proceeding 7 | further. Some nodes, particularly those that reference the controller 8 | node, can take several minutes to synchronize. 9 | 10 | #. Run this command on the *controller* node: 11 | 12 | .. code-block:: console 13 | 14 | # chronyc sources 15 | 16 | 210 Number of sources = 2 17 | MS Name/IP address Stratum Poll Reach LastRx Last sample 18 | =============================================================================== 19 | ^- 192.0.2.11 2 7 12 137 -2814us[-3000us] +/- 43ms 20 | ^* 192.0.2.12 2 6 177 46 +17us[ -23us] +/- 68ms 21 | 22 | Contents in the *Name/IP address* column should indicate the hostname or IP 23 | address of one or more NTP servers. Contents in the *MS* column should indicate 24 | *\** for the server to which the NTP service is currently synchronized. 25 | 26 | #. Run the same command on *all other* nodes: 27 | 28 | .. code-block:: console 29 | 30 | # chronyc sources 31 | 32 | 210 Number of sources = 1 33 | MS Name/IP address Stratum Poll Reach LastRx Last sample 34 | =============================================================================== 35 | ^* controller 3 9 377 421 +15us[ -87us] +/- 15ms 36 | 37 | Contents in the *Name/IP address* column should indicate the hostname of the 38 | controller node. 39 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-ntp.rst: -------------------------------------------------------------------------------- 1 | .. _environment-ntp: 2 | 3 | Network Time Protocol (NTP) 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5 | 6 | To properly synchronize services among nodes, you can install Chrony, an 7 | implementation of :term:`NTP `. We recommend that 8 | you configure the controller node to reference more accurate (lower stratum) 9 | servers and other nodes to reference the controller node. 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | 14 | environment-ntp-controller.rst 15 | environment-ntp-other.rst 16 | environment-ntp-verify.rst 17 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-packages.rst: -------------------------------------------------------------------------------- 1 | OpenStack packages 2 | ~~~~~~~~~~~~~~~~~~ 3 | 4 | Distributions release OpenStack packages as part of the distribution or 5 | using other methods because of differing release schedules. Perform 6 | these procedures on all nodes. 7 | 8 | .. note:: 9 | 10 | The set up of OpenStack packages described here needs to be done on 11 | all nodes: controller, compute, and Block Storage nodes. 12 | 13 | .. warning:: 14 | 15 | Your hosts must contain the latest versions of base installation 16 | packages available for your distribution before proceeding further. 17 | 18 | .. note:: 19 | 20 | Disable or remove any automatic update services because they can 21 | impact your OpenStack environment. 22 | 23 | .. toctree:: 24 | :glob: 25 | 26 | environment-packages-* 27 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-sql-database-rdo.rst: -------------------------------------------------------------------------------- 1 | SQL database for RHEL and CentOS 2 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3 | 4 | Most OpenStack services use an SQL database to store information. The 5 | database typically runs on the controller node. The procedures in this 6 | guide use MariaDB or MySQL depending on the distribution. OpenStack 7 | services also support other SQL databases including 8 | `PostgreSQL `__. 9 | 10 | Install and configure components 11 | -------------------------------- 12 | 13 | #. Install the packages: 14 | 15 | .. code-block:: console 16 | 17 | # dnf install mariadb mariadb-server python3-PyMySQL 18 | 19 | 2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file 20 | (backup existing configuration files in ``/etc/my.cnf.d/`` if needed) 21 | and complete the following actions: 22 | 23 | - Create a ``[mysqld]`` section, and set the ``bind-address`` 24 | key to the management IP address of the controller node to 25 | enable access by other nodes via the management network. Set 26 | additional keys to enable useful options and the UTF-8 27 | character set: 28 | 29 | .. path /etc/my.cnf.d/openstack.cnf 30 | .. code-block:: ini 31 | 32 | [mysqld] 33 | bind-address = 10.0.0.11 34 | 35 | default-storage-engine = innodb 36 | innodb_file_per_table = on 37 | max_connections = 4096 38 | collation-server = utf8_general_ci 39 | character-set-server = utf8 40 | 41 | Finalize installation 42 | --------------------- 43 | 44 | #. Start the database service and configure it to start when the system 45 | boots: 46 | 47 | .. code-block:: console 48 | 49 | # systemctl enable mariadb.service 50 | # systemctl start mariadb.service 51 | 52 | 2. Secure the database service by running the ``mysql_secure_installation`` 53 | script. In particular, choose a suitable password for the database 54 | ``root`` account: 55 | 56 | .. code-block:: console 57 | 58 | # mysql_secure_installation 59 | -------------------------------------------------------------------------------- /doc/install-guide/source/environment-sql-database.rst: -------------------------------------------------------------------------------- 1 | SQL database 2 | ~~~~~~~~~~~~ 3 | 4 | Most OpenStack services use an SQL database to store information. The 5 | database typically runs on the controller node. The procedures in this 6 | guide use MariaDB or MySQL depending on the distribution. OpenStack 7 | services also support other SQL databases including 8 | `PostgreSQL `__. 9 | 10 | .. note:: 11 | 12 | If you see ``Too many connections`` or ``Too many open files`` 13 | error log messages on OpenStack services, verify that maximum number of 14 | connection settings are well applied to your environment. 15 | In MariaDB, you may also need to change 16 | `open_files_limit `__ 17 | configuration. 18 | 19 | .. toctree:: 20 | :glob: 21 | 22 | environment-sql-database-* 23 | 24 | -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/api-endpoint_1_register_endpoint.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/api-endpoint_1_register_endpoint.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/api-endpoint_2_keystone_server_ip.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/api-endpoint_2_keystone_server_ip.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/api-endpoint_3_keystone_authtoken.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/api-endpoint_3_keystone_authtoken.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/api-endpoint_4_service_endpoint_ip_address.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/api-endpoint_4_service_endpoint_ip_address.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/api-endpoint_5_region_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/api-endpoint_5_region_name.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_1_configure-with-dbconfig-yes-no.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_1_configure-with-dbconfig-yes-no.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_2_db-types.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_2_db-types.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_3_connection_method.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_3_connection_method.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_4_mysql_root_password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_4_mysql_root_password.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_5_mysql_app_password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_5_mysql_app_password.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_6_mysql_app_password_confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_6_mysql_app_password_confirm.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_keep_admin_pass.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_keep_admin_pass.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_used_for_remote_db.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/dbconfig-common_used_for_remote_db.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/glance-common_pipeline_flavor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/glance-common_pipeline_flavor.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_1_admin_token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_1_admin_token.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_2_register_admin_tenant_yes_no.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_2_register_admin_tenant_yes_no.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_3_admin_user_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_3_admin_user_name.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_4_admin_user_email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_4_admin_user_email.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_5_admin_user_pass.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_5_admin_user_pass.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_6_admin_user_pass_confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_6_admin_user_pass_confirm.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/keystone_7_register_endpoint.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/keystone_7_register_endpoint.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/neutron_1_plugin_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/neutron_1_plugin_selection.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/rabbitmq-host.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/rabbitmq-host.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/rabbitmq-password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/rabbitmq-password.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/rabbitmq-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/rabbitmq-user.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_admin_password.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_admin_password.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_admin_tenant_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_admin_tenant_name.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_server_hostname.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_server_hostname.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_tenant_admin_user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/debconf-screenshots/service_keystone_authtoken_tenant_admin_user.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/hwreqs.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/hwreqs.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/hwreqs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/hwreqs.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/installguide-neutron-initialnetworks.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/installguide-neutron-initialnetworks.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/installguide-neutron-initialnetworks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/installguide-neutron-initialnetworks.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network1-connectivity.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network1-connectivity.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network1-connectivity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network1-connectivity.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network1-overview.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network1-overview.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network1-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network1-overview.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network1-services.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network1-services.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network2-connectivity.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network2-connectivity.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network2-connectivity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network2-connectivity.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network2-overview.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network2-overview.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network2-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network2-overview.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/network2-services.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/network2-services.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/networklayout.graffle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/networklayout.graffle -------------------------------------------------------------------------------- /doc/install-guide/source/figures/networklayout.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/networklayout.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/openstack-arch-kilo-logical-v1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/openstack-arch-kilo-logical-v1.png -------------------------------------------------------------------------------- /doc/install-guide/source/figures/openstack_kilo_conceptual_arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/doc/install-guide/source/figures/openstack_kilo_conceptual_arch.png -------------------------------------------------------------------------------- /doc/install-guide/source/get-started-conceptual-architecture.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. _get_started_conceptual_architecture: 4 | 5 | ======================= 6 | Conceptual architecture 7 | ======================= 8 | 9 | The following diagram shows the relationships among the OpenStack 10 | services: 11 | 12 | .. image:: figures/openstack_kilo_conceptual_arch.png 13 | :alt: OpenStack conceptual architecture 14 | :width: 100% 15 | -------------------------------------------------------------------------------- /doc/install-guide/source/get-started-logical-architecture.rst: -------------------------------------------------------------------------------- 1 | ==================== 2 | Logical architecture 3 | ==================== 4 | 5 | To design, deploy, and configure OpenStack, administrators must 6 | understand the logical architecture. 7 | 8 | As shown in :ref:`get_started_conceptual_architecture`, OpenStack consists of 9 | several independent parts, named the OpenStack services. All services 10 | authenticate through a common Identity service. Individual services interact 11 | with each other through public APIs, except where privileged administrator 12 | commands are necessary. 13 | 14 | Internally, OpenStack services are composed of several processes. All 15 | services have at least one API process, which listens for API requests, 16 | preprocesses them and passes them on to other parts of the service. With 17 | the exception of the Identity service, the actual work is done by 18 | distinct processes. 19 | 20 | For communication between the processes of one service, an AMQP message 21 | broker is used. The service's state is stored in a database. When 22 | deploying and configuring your OpenStack cloud, you can choose among 23 | several message broker and database solutions, such as RabbitMQ, 24 | MySQL, MariaDB, and SQLite. 25 | 26 | Users can access OpenStack via the web-based user interface implemented 27 | by the Horizon Dashboard, via `command-line 28 | clients `__ and by 29 | issuing API requests through tools like browser plug-ins or :command:`curl`. 30 | For applications, `several SDKs `__ 31 | are available. Ultimately, all these access methods issue REST API calls 32 | to the various OpenStack services. 33 | 34 | The following diagram shows the most common, but not the only possible, 35 | architecture for an OpenStack cloud: 36 | 37 | .. image:: figures/openstack-arch-kilo-logical-v1.png 38 | :alt: Logical architecture 39 | :width: 100% 40 | -------------------------------------------------------------------------------- /doc/install-guide/source/get-started-with-openstack.rst: -------------------------------------------------------------------------------- 1 | ========================== 2 | Get started with OpenStack 3 | ========================== 4 | 5 | The OpenStack project is an open source cloud computing platform for all 6 | types of clouds, which aims to be simple to implement, massively 7 | scalable, and feature rich. Developers and cloud computing technologists 8 | from around the world create the OpenStack project. 9 | 10 | OpenStack provides an :term:`Infrastructure-as-a-Service (IaaS)` solution 11 | through a set of interrelated services. Each service offers an 12 | :term:`Application Programming Interface (API)` that facilitates this 13 | integration. Depending on your needs, you can install some or all 14 | services. 15 | 16 | The OpenStack services 17 | ====================== 18 | 19 | The 20 | `OpenStack project navigator `_ 21 | lets you browse the OpenStack services that make up the OpenStack architecture. 22 | The services are categorized per the service type and release series. 23 | 24 | The OpenStack architecture 25 | ========================== 26 | 27 | The following sections describe the OpenStack architecture in more detail: 28 | 29 | .. toctree:: 30 | :maxdepth: 2 31 | 32 | get-started-conceptual-architecture.rst 33 | get-started-logical-architecture.rst 34 | -------------------------------------------------------------------------------- /doc/install-guide/source/index.rst: -------------------------------------------------------------------------------- 1 | ============================== 2 | OpenStack Installation Guide 3 | ============================== 4 | 5 | .. toctree:: 6 | :maxdepth: 3 7 | 8 | common/conventions.rst 9 | preface 10 | get-started-with-openstack 11 | overview.rst 12 | environment.rst 13 | openstack-services.rst 14 | launch-instance.rst 15 | firewalls-default-ports.rst 16 | common/appendix.rst 17 | -------------------------------------------------------------------------------- /doc/install-guide/source/shared/edit_hosts_file.txt: -------------------------------------------------------------------------------- 1 | Edit the ``/etc/hosts`` file to contain the following: 2 | 3 | .. code-block:: none 4 | 5 | # controller 6 | 10.0.0.11 controller 7 | 8 | # compute1 9 | 10.0.0.31 compute1 10 | 11 | # block1 12 | 10.0.0.41 block1 13 | 14 | # object1 15 | 10.0.0.51 object1 16 | 17 | # object2 18 | 10.0.0.52 object2 19 | 20 | .. warning:: 21 | 22 | Some distributions add an extraneous entry in the ``/etc/hosts`` 23 | file that resolves the actual hostname to another loopback IP 24 | address such as ``127.0.1.1``. You must comment out or remove this 25 | entry to prevent name resolution problems. 26 | **Do not remove the 127.0.0.1 entry.** 27 | 28 | .. note:: 29 | 30 | This guide includes host entries for optional services in order to reduce 31 | complexity should you choose to deploy them. 32 | -------------------------------------------------------------------------------- /doc/install-guide/source/shared/note_configuration_vary_by_distribution.rst: -------------------------------------------------------------------------------- 1 | .. note:: 2 | 3 | Default configuration files vary by distribution. You might need 4 | to add these sections and options rather than modifying existing 5 | sections and options. Also, an ellipsis (``...``) in the configuration 6 | snippets indicates potential default configuration options that you 7 | should retain. 8 | -------------------------------------------------------------------------------- /projects.txt: -------------------------------------------------------------------------------- 1 | openstack/security-doc 2 | openstack/ha-guide 3 | openstack/operations-guide 4 | -------------------------------------------------------------------------------- /releasenotes/source/index.rst: -------------------------------------------------------------------------------- 1 | ================================ 2 | Documentation team release notes 3 | ================================ 4 | 5 | These release notes cover all aspects of the work of the documentation 6 | team with the exception of those repositories that have their own 7 | release notes (currently openstackdocstheme and openstack-doc-tools). 8 | Thus this file covers the content of the following repositories: 9 | 10 | * api-site 11 | * contributor-guide 12 | * openstack-manuals 13 | * security-guide 14 | * training-guide 15 | 16 | Contents 17 | ~~~~~~~~ 18 | 19 | .. toctree:: 20 | :maxdepth: 2 21 | 22 | train.rst 23 | rocky.rst 24 | queens.rst 25 | pike.rst 26 | ocata.rst 27 | newton.rst 28 | mitaka.rst 29 | -------------------------------------------------------------------------------- /releasenotes/source/pike.rst: -------------------------------------------------------------------------------- 1 | ============ 2 | Pike release 3 | ============ 4 | 5 | * As of the Pike release, the complete documentation suite that resided within 6 | the openstack-manuals repository has been reworked, and the content of the 7 | following guides has been moved to the project team repositories: 8 | 9 | - Installation Guide 10 | - Administration Guide 11 | - End User Guide 12 | - Command-Line (CLI) Reference 13 | - Configuration Reference 14 | 15 | * All of the documentation builds (except for release notes and the 16 | api-ref) have been combined so that each 17 | repository has a single ``doc/source`` directory, a single 18 | sphinx ``conf.py``, and a single job for building and 19 | publishing the content including developer, contributor, 20 | and user documentation. 21 | 22 | * The Operations Guide is in the process of being migrated to the 23 | OpenStack wiki. It is unavailable on docs.openstack.org from Pike. 24 | 25 | Contributor Guide 26 | ~~~~~~~~~~~~~~~~~ 27 | 28 | * Added content about the new release process. 29 | * Updated guide to be relevant for updated openstack-manuals. 30 | * General bug fixes and updates. 31 | 32 | Security Guide 33 | ~~~~~~~~~~~~~~ 34 | 35 | * Updated Keystone Checklists 36 | * Rework of 'node hardening' section 37 | * Various fixes such as grammar and incorrect hyperlinks 38 | 39 | Training Labs 40 | ~~~~~~~~~~~~~ 41 | 42 | * Support for the new OpenStack release will be available shortly 43 | after the release of Pike. 44 | * Various bug fixes and minor improvements in the host scripts. 45 | -------------------------------------------------------------------------------- /releasenotes/source/queens.rst: -------------------------------------------------------------------------------- 1 | ============== 2 | Queens release 3 | ============== 4 | 5 | Documentation Contributor Guide 6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 7 | 8 | Available from the `OpenStack Documentation Contributor Guide 9 | `_. 10 | 11 | * Renamed from Contributor Guide to Documentation Contributor Guide to 12 | distinguish this document from the new document aimed at all new OpenStack 13 | contributors. 14 | * Updated for changes with regard to migrating documentation from 15 | openstack-manuals to project team repositories. 16 | * Added a new 2017/2018 documentation team vision document. 17 | 18 | Contributor Guide 19 | ~~~~~~~~~~~~~~~~~ 20 | 21 | Available from the `OpenStack Contributor Guide 22 | `_. 23 | 24 | * This is a new document that aims to provide common documentation for all 25 | OpenStack Contributors and help with on-boarding efforts. 26 | 27 | Translations 28 | ~~~~~~~~~~~~ 29 | 30 | Besides updating the existing translated manuals, the Internationalization 31 | (i18n) team added the following new manuals: 32 | 33 | * [DE] Added Security Guide, Installation Guide, I18n Guide, and 34 | FirstApp API Guide 35 | * [ID] Added Security Guide, Installation Guide, I18n Guide 36 | * [JA] Added I18n Guide 37 | * [ko_KR] Added Installation Guide 38 | * [tr_TR] Added Security Guide 39 | -------------------------------------------------------------------------------- /releasenotes/source/rocky.rst: -------------------------------------------------------------------------------- 1 | ============= 2 | Rocky release 3 | ============= 4 | 5 | OpenStack Operations Guide 6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ 7 | 8 | Available from the `OpenStack Operations Guide 9 | `_. 10 | 11 | * The ``operations-guide`` repository was restored and is now owned by the 12 | Operations Documentation SIG. The source of the Operations Guide was moved 13 | from ``openstack-manuals`` to that repository. 14 | 15 | OpenStack High Availability Guide 16 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 17 | 18 | Available from the `OpenStack High Availability Guide 19 | `_. 20 | 21 | * The ``ha-guide`` repository was restored and is now owned by the Operations 22 | Documentation SIG. The source of the High Availability Guide was moved 23 | from ``openstack-manuals`` to that repository. 24 | -------------------------------------------------------------------------------- /releasenotes/source/train.rst: -------------------------------------------------------------------------------- 1 | ============= 2 | Train release 3 | ============= 4 | 5 | * The API Guide document has been migrated into the 6 | ``openstack-manuals`` repository and is published to 7 | `docs.openstack.org `__. 8 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | # The order of packages is significant, because pip processes them in the order 2 | # of appearance. Changing the order has an impact on the overall integration 3 | # process, which may cause wedges in the gate later. 4 | pbr>=2.0 # Apache-2.0 5 | 6 | # Hacking already pins down pep8, pyflakes and flake8 7 | hacking>=3.0,<3.1.0 # Apache-2.0 8 | 9 | beautifulsoup4 # MIT 10 | Jinja2>=2.8 # BSD License (3 clause) 11 | openstack-doc-tools>=2.0.0 # Apache-2.0 12 | sphinx>=2.0.0,!=2.1.0 # BSD 13 | openstackdocstheme>=2.2.0 # Apache-2.0 14 | doc8 # Apache-2.0 15 | requests>=2.14.2 # Apache-2.0 16 | requestsexceptions>=1.2.0 # Apache-2.0 17 | lxml>=2.3,!=3.7.0 # BSD 18 | PyYAML>=3.10.0 # MIT 19 | jsonschema>=3.2.0 20 | os-service-types 21 | openstack-governance>=0.1.0 22 | percache>=0.3.0 23 | 24 | # For translations 25 | # Babel 2.4.0 is broken, fixed in 2.4.1 26 | Babel>=2.3.4,!=2.4.0 # BSD 27 | 28 | # For testing htaccess file contents 29 | whereto>=0.3.0 # Apache-2.0 30 | -------------------------------------------------------------------------------- /tools/README-USE-openstack-doc-tools.txt: -------------------------------------------------------------------------------- 1 | The tools directory has been moved to a separate repository, 2 | openstack-doc-tools: 3 | 4 | https://opendev.org/openstack/openstack-doc-tools 5 | 6 | Please do not make changes here, commit instead to openstack-doc-tools 7 | unless you need those for gating jobs. 8 | 9 | This directory will be removed once all the gating jobs are setup 10 | correctly. 11 | -------------------------------------------------------------------------------- /tools/build-all-rst.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -e 2 | 3 | mkdir -p publish-docs/html 4 | 5 | # Set this to a sensible value if not set by OpenStack CI. 6 | if [ -z "$ZUUL_BRANCH" ] ; then 7 | ZUUL_BRANCH="master" 8 | fi 9 | 10 | # This marker is needed for infra publishing. 11 | # Note for stable branches, this needs to be the top of each manual. 12 | MARKER_TEXT="Project: $ZUUL_PROJECT Ref: $ZUUL_BRANCH Build: $ZUUL_UUID Revision: $ZUUL_NEWREF" 13 | 14 | LINKCHECK="" 15 | PDF_OPTION="" 16 | while [[ $# > 0 ]] ; do 17 | option="$1" 18 | case $option in 19 | --linkcheck) 20 | LINKCHECK="--linkcheck" 21 | ;; 22 | --pdf) 23 | PDF_OPTION="--pdf" 24 | ;; 25 | esac 26 | shift 27 | done 28 | 29 | # PDF targets for Install guides are dealt in build-install-guides-rst.sh 30 | PDF_TARGETS=( 'image-guide' \ 31 | 'install-guide') 32 | 33 | for guide in doc-contrib-guide glossary \ 34 | api-quick-start image-guide install-guide; do 35 | if [[ ${PDF_TARGETS[*]} =~ $guide ]]; then 36 | tools/build-rst.sh doc/$guide --build build \ 37 | --target $guide $LINKCHECK $PDF_OPTION 38 | else 39 | tools/build-rst.sh doc/$guide --build build \ 40 | --target $guide $LINKCHECK 41 | fi 42 | done 43 | 44 | # For master, just mark the root 45 | if [ "$ZUUL_BRANCH" = "master" ] ; then 46 | echo $MARKER_TEXT > publish-docs/html/.root-marker 47 | fi 48 | -------------------------------------------------------------------------------- /tools/glossary-sort.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -xe 2 | 3 | # Check that doc/common/glossary entries are alphabetized and prints 4 | # list of entries that should be sorted. 5 | 6 | # Cross-platform (Mac and Linux) commands to make a temporary working directory 7 | thetmpdir=`mktemp -d 2>/dev/null || mktemp -d -t 'thetmpdir'` 8 | trap "rm -rf $thetmpdir" EXIT 9 | 10 | pushd $thetmpdir 11 | GLOSSARY=$OLDPWD/doc/common/glossary.rst 12 | 13 | grep '^ [a-zA-Z0-9]' $GLOSSARY > glossary_entries 14 | 15 | LC_ALL=C sort --ignore-case glossary_entries -o glossary_entries.sorted 16 | 17 | if ! diff glossary_entries glossary_entries.sorted > glossary_entries.diff; then 18 | echo "The following entries should be alphabetized: " 19 | cat glossary_entries.diff | grep -e '> ' 20 | exit 1 21 | else 22 | echo "Glossary alphabetized." 23 | fi 24 | 25 | popd 26 | -------------------------------------------------------------------------------- /tools/publishdocs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -xe 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 | mkdir -p publish-docs/html 16 | 17 | # Build all RST guides including PDF files 18 | tools/build-all-rst.sh --pdf 19 | 20 | # Build website 21 | python3 tools/www-generator.py --source-directory www/ \ 22 | --output-directory publish-docs/html --publish 23 | rsync -a www/static/ publish-docs/html/ 24 | 25 | # Don't publish these files 26 | rm -rf publish-docs/html/project-data 27 | -------------------------------------------------------------------------------- /tools/sync-projects.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -xe 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 | PROJECT_DIR=$1 16 | 17 | if [ -z "$PROJECT_DIR" ] ; then 18 | echo "Usage: $0 PROJECT_DIR" 19 | exit 1 20 | fi 21 | 22 | function copy_rst_trans { 23 | target=$1 24 | # Copy over some RST files 25 | mkdir -p $PROJECT_DIR/$target/source/locale 26 | for lang in de id ja tr_TR ; do 27 | TARGET=$PROJECT_DIR/$target/source/locale/$lang/LC_MESSAGES 28 | mkdir -p $TARGET 29 | cp doc/common/source/locale/$lang/LC_MESSAGES/common.po \ 30 | $TARGET 31 | done 32 | (cd $PROJECT_DIR; git add $target/source/locale/) 33 | } 34 | 35 | function copy_rst { 36 | target=$1 37 | # Copy over some RST files 38 | mkdir -p $PROJECT_DIR/$target 39 | 40 | for filename in app-support.rst conventions.rst glossary.rst; do 41 | cp doc/common/$filename $PROJECT_DIR/$target 42 | done 43 | (cd $PROJECT_DIR; git add $target) 44 | } 45 | 46 | 47 | case "$PROJECT_DIR" in 48 | security-doc) 49 | copy_rst common 50 | copy_rst_trans common 51 | ;; 52 | ha-guide|operations-guide) 53 | copy_rst doc/source/common 54 | ;; 55 | *) 56 | echo "$PROJECT_DIR not handled" 57 | exit 1 58 | ;; 59 | esac 60 | -------------------------------------------------------------------------------- /tools/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -xe 2 | 3 | if [[ -d publish-docs/html/www/ ]]; then 4 | output=publish-docs/html/www 5 | else 6 | output=publish-docs/html/ 7 | fi 8 | 9 | .tox/publishdocs/bin/python tools/www-generator.py --verbose --source-directory www/ \ 10 | --output-directory $output $@ 11 | 12 | if [[ $? -eq 0 ]]; then 13 | rsync -a www/static/ $output 14 | fi 15 | 16 | .tox/publishdocs/bin/whereto $output/.htaccess $output/redirect-tests.txt 17 | -------------------------------------------------------------------------------- /www/2023.1/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2023.1/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |

By deployment method

25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

28 | {{project.service}} Guide 29 |

30 | {% endif %} 31 | {%- endfor %} 32 |
33 |
34 |
35 |
36 |
37 |

Documentation treated like code, powered by the community - interested?

38 | How To Contribute 39 |
40 |
41 |
42 |
43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/2023.1/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/2023.2/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2023.2/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |

By deployment method

25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

28 | {{project.service}} Guide 29 |

30 | {% endif %} 31 | {%- endfor %} 32 |
33 |
34 |
35 |
36 |
37 |

Documentation treated like code, powered by the community - interested?

38 | How To Contribute 39 |
40 |
41 |
42 |
43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/2023.2/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/2024.1/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2024.1/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |

By deployment method

25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

28 | {{project.service}} Guide 29 |

30 | {% endif %} 31 | {%- endfor %} 32 |
33 |
34 |
35 |
36 |
37 |

Documentation treated like code, powered by the community - interested?

38 | How To Contribute 39 |
40 |
41 |
42 |
43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/2024.1/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/2024.2/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2024.2/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |

By deployment method

25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

28 | {{project.service}} Guide 29 |

30 | {% endif %} 31 | {%- endfor %} 32 |
33 |
34 |
35 |
36 |
37 |

Documentation treated like code, powered by the community - interested?

38 | How To Contribute 39 |
40 |
41 |
42 |
43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/2024.2/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/2025.1/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2025.1/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |

This is documentation in progress for the next release.

17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |

By deployment method

26 | {% for project in projects|sort(attribute='name') -%} 27 | {% if project.type == 'deployment' and project.has_deployment_guide %} 28 |

29 | {{project.service}} Guide 30 |

31 | {% endif %} 32 | {%- endfor %} 33 |
34 |
35 |
36 |
37 |
38 |

Documentation treated like code, powered by the community - interested?

39 | How To Contribute 40 |
41 |
42 |
43 |
44 | 45 | {% endblock content %} 46 | -------------------------------------------------------------------------------- /www/2025.1/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/2025.2/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/2025.2/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Deployment Guides

14 |

The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

16 |

This is documentation in progress for the next release.

17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |

By deployment method

26 | {% for project in projects|sort(attribute='name') -%} 27 | {% if project.type == 'deployment' and project.has_deployment_guide %} 28 |

29 | {{project.service}} Guide 30 |

31 | {% endif %} 32 | {%- endfor %} 33 |
34 |
35 |
36 |
37 |
38 |

Documentation treated like code, powered by the community - interested?

39 | How To Contribute 40 |
41 |
42 |
43 |
44 | 45 | {% endblock content %} 46 | -------------------------------------------------------------------------------- /www/2025.2/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/austin/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/austin/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/bexar/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/bexar/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/cactus/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/cactus/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/diablo/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/diablo/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/essex/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/essex/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/folsom/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/folsom/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/grizzly/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/grizzly/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/havana/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/havana/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 | {% endblock content %} 8 | -------------------------------------------------------------------------------- /www/icehouse/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 |
8 |
9 |
10 |
11 | 12 |
13 |
14 |
15 |

Configuration Guides

16 | Configuration Reference 17 |

Installation and configuration options for OpenStack

18 |
19 |
20 |
21 |
22 | {% endblock content %} 23 | -------------------------------------------------------------------------------- /www/juno/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/juno/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 |
8 |
9 |
10 |
11 | 12 |
13 |
14 |
15 |

Configuration Guides

16 | Configuration Reference 17 |

Installation and configuration options for OpenStack

18 |
19 |
20 |
21 |
22 | {% endblock content %} 23 | -------------------------------------------------------------------------------- /www/kilo/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/kilo/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 |
8 |
9 |
10 |
11 | 12 |
13 |
14 |
15 |

Configuration Guides

16 | Configuration Reference 17 |

Installation and configuration options for OpenStack

18 |
19 |
20 |
21 |
22 |

Operations and Administration Guides

23 | Networking Guide 24 |

Deploy and manage OpenStack Networking (neutron)

25 |
26 |
27 |
28 |
29 | {% endblock content %} 30 | -------------------------------------------------------------------------------- /www/latest/badge.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
6 | x 7 |
8 |

9 | This release is under development. The current supported release is {{RELEASED_SERIES.capitalize()}}. 10 |

11 | Back to Top 12 |
13 |
-------------------------------------------------------------------------------- /www/liberty/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/liberty/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/indexbase.tmpl" %} 2 | {% block pagetitle %}{{SERIES_TITLE}}{% endblock %} 3 | {% block title %}{% endblock %} 4 | {% block header %} 5 | {% endblock header %} 6 | {% block content %} 7 |
8 |
9 |
10 |
11 | 12 |
13 |
14 | 15 |
16 |

Installation Guides

17 |

Getting started with the most commonly used OpenStack services

18 | Installation Guides for openSUSE or SUSE Linux Enterpreise
19 | Installation Guides for CentOS or Red Hat Enterprise Linux
20 | Installation Guides for Ubuntu Linux
21 |
22 | 23 |
24 |

Configuration Guides

25 | Configuration Reference 26 |

Installation and configuration options for OpenStack

27 |
28 |
29 | 30 |
31 |
32 |

Operations and Administration Guides

33 | Networking Guide 34 |

Deploy and manage OpenStack Networking (neutron)

35 |
36 |
37 |
38 | 39 |
40 | {% endblock content %} 41 | -------------------------------------------------------------------------------- /www/master/badge.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
6 | x 7 |
8 |

9 | This release is under development. The current supported release is {{RELEASED_SERIES.capitalize()}}. 10 |

11 | Back to Top 12 |
13 |
-------------------------------------------------------------------------------- /www/mitaka/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/mitaka/projects.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Services and Libraries{% endblock %} 4 | {% block title %} 5 | Documentation > Services and Libraries 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Projects

14 |

15 | This page contains project-specific documentation for 16 | OpenStack services and libraries. 17 |

18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | 30 |
31 |

OpenStack Services

32 | {% for project in projects|sort(attribute='service') %} 33 | {% if project.type in ['service', 'other'] %} 34 | 35 | {{project.service}} ({{project.name}})
36 | {% endif %} 37 | {% endfor %} 38 |
39 | 40 |
41 |
42 |
43 |
44 |

Documentation treated like code, powered by the community - interested?

45 | How To Contribute 46 |
47 |
48 |
49 |
50 | 51 | {% endblock content %} 52 | -------------------------------------------------------------------------------- /www/newton/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/newton/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/base.tmpl" %} 2 | {% block pagetitle %}Newton Deployment Guides{% endblock %} 3 | {% block title %} 4 | Documentation > Newton Deployment Guides 5 | {% endblock %} 6 | {% block content %} 7 | 8 |
9 |
10 |
11 |
12 |

Newton Deployment Guides

13 |

The following deployment guides support different installation 14 | methods for core and optional OpenStack services.

15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |

By deployment method

24 |

OpenStack-Ansible Deployment Guide

25 |

TripleO Deployment Guide

26 |
27 |
28 |
29 |
30 |

Documentation treated like code, powered by the community - interested?

31 | How To Contribute 32 |
33 |
34 |
35 |
36 | 37 | {% endblock content %} 38 | -------------------------------------------------------------------------------- /www/newton/projects.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Services and Libraries{% endblock %} 4 | {% block title %} 5 | Documentation > Services and Libraries 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
10 |
11 |
12 |
13 |

OpenStack {{SERIES_TITLE}} Projects

14 |

15 | This page contains project-specific documentation for 16 | OpenStack services and libraries. 17 |

18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | 30 |
31 |

OpenStack Services

32 | {% for project in projects|sort(attribute='service') %} 33 | {% if project.type in ['service', 'other'] %} 34 | 35 | {{project.service}} ({{project.name}})
36 | {% endif %} 37 | {% endfor %} 38 |
39 | 40 |
41 |
42 |
43 |
44 |

Documentation treated like code, powered by the community - interested?

45 | How To Contribute 46 |
47 |
48 |
49 |
50 | 51 | {% endblock content %} 52 | -------------------------------------------------------------------------------- /www/ocata/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/ocata/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/base.tmpl" %} 2 | {% block pagetitle %}Ocata Deployment Guides{% endblock %} 3 | {% block title %} 4 | Documentation > Ocata Deployment Guides 5 | {% endblock %} 6 | {% block content %} 7 | 8 |
9 |
10 |
11 |
12 |

Ocata Deployment Guides

13 |

The following deployment guides support different installation 14 | methods for core and optional OpenStack services.

15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |

By deployment method

24 |

OpenStack-Ansible Deployment Guide

25 |

Kolla Deployment Guide

26 |

TripleO Deployment Guide

27 |
28 |
29 |
30 |
31 |

Documentation treated like code, powered by the community - interested?

32 | How To Contribute 33 |
34 |
35 |
36 |
37 | 38 | {% endblock content %} 39 | -------------------------------------------------------------------------------- /www/pike/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/pike/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/project-data/README.rst: -------------------------------------------------------------------------------- 1 | See 2 | https://docs.openstack.org/doc-contrib-guide/doc-tools/template-generator.html 3 | for details. 4 | -------------------------------------------------------------------------------- /www/project-data/schema.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | type: array 3 | items: 4 | type: object 5 | additionalProperties: false 6 | required: 7 | - name 8 | - service 9 | - type 10 | properties: 11 | name: 12 | type: string 13 | deliverable-name: 14 | type: string 15 | service: 16 | type: string 17 | service_type: 18 | type: string 19 | type: 20 | type: string 21 | enum: 22 | - service 23 | - cloud-client 24 | - service-client 25 | - library 26 | - tool 27 | - baremetal 28 | - deployment 29 | - networking 30 | - other 31 | description: 32 | type: string 33 | has_install_guide: 34 | type: boolean 35 | has_api_guide: 36 | type: boolean 37 | has_api_ref: 38 | type: boolean 39 | has_config_ref: 40 | type: boolean 41 | has_in_tree_api_docs: 42 | type: boolean 43 | has_admin_guide: 44 | type: boolean 45 | has_user_guide: 46 | type: boolean 47 | has_in_tree_htaccess: 48 | type: boolean 49 | has_deployment_guide: 50 | type: boolean 51 | has_project_guide: 52 | type: boolean 53 | -------------------------------------------------------------------------------- /www/pt_BR/index.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/base.tmpl" %} 2 | {% block pagetitle %}Portuguese{% endblock %} 3 | {% block title %} Documentação{% endblock %} 4 | {% block content %} 5 | 6 |
7 |
8 |
9 |
10 |

Documentação português

11 |

12 | Esta página lista a documentação OpenStack traduzidas para o português. 13 |

14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |

Participar

24 | A tradução do OpenStack é dividida por projetos e precisamos de grande apoio de voluntários que possam contribuir com a tradução do OpenStack para o português Brasileiro (pt_BR). Se você tem interesse, basta se registrar ao site translate.openstack.org e começar a traduzir! 25 | 26 | Time de tradução do OpenStack Brasil - Português 27 | 28 |
29 |
30 |
31 |
32 | 33 | 34 | {% endblock content %} 35 | -------------------------------------------------------------------------------- /www/queens/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/queens/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/rocky/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/rocky/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/static/common/css/bootstrap.min.css: -------------------------------------------------------------------------------- 1 | bootstrap.css -------------------------------------------------------------------------------- /www/static/common/css/font-awesome-additions.css: -------------------------------------------------------------------------------- 1 | .fa-users-cog:before { 2 | content: "\f509"; 3 | } 4 | -------------------------------------------------------------------------------- /www/static/common/css/main-landing.css: -------------------------------------------------------------------------------- 1 | /* @override http://docs.openstack.org/common/css/main.css */ 2 | /* CSS is used by docs.openstack.org/infra and specs.openstack.org. */ 3 | 4 | #subnav ul li{ 5 | text-align:left; 6 | } 7 | 8 | ul{ 9 | list-style-type:none; 10 | } 11 | 12 | #subnav{ 13 | padding-top:0px; 14 | } 15 | 16 | a, 17 | a:visited{ 18 | color:firebrick; 19 | text-decoration:none; 20 | } 21 | 22 | .last-right{ 23 | margin-right:0px; 24 | margin-top:0px; 25 | } 26 | 27 | .last-right-more{ 28 | margin-right:0px; 29 | margin-top:22px; 30 | } 31 | 32 | .last-right-most{ 33 | margin-right:0px; 34 | margin-top:37px; 35 | } 36 | 37 | .last-right ul, ol{ 38 | margin:0px 1.5em 1.5em 0px; 39 | padding-left:0; 40 | } 41 | 42 | ul.subsectionNav-link li a { 43 | display: block; 44 | padding: 10px 20px 10px 42px; 45 | text-decoration: none; 46 | color: #000; 47 | background: none no-repeat scroll 5px center #D5EFD4; 48 | margin-right: 40px; 49 | } 50 | 51 | ul.subsectionNav li a { 52 | display: block; 53 | padding: 10px 20px 10px 42px; 54 | text-decoration: none; 55 | color: #000; 56 | background: none no-repeat scroll 5px center lightgray; 57 | margin-right: 40px; 58 | } 59 | -------------------------------------------------------------------------------- /www/static/common/css/search.css: -------------------------------------------------------------------------------- 1 | /*hide close button*/ 2 | .ossw-search-bar-close { 3 | display: none !important; 4 | } 5 | 6 | #search-bar-input{ 7 | width: 98% !important; 8 | margin-top: 10px !important; 9 | } 10 | 11 | .search-container-mobile { 12 | display: none !important; 13 | position: relative !important; 14 | width: 100% !important; 15 | } 16 | 17 | @media (max-width: 767px), only screen and (max-device-width: 1024px) { 18 | .search-container-mobile { 19 | display: block !important; 20 | } 21 | 22 | .search-container { 23 | display: none !important; 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /www/static/common/images/ATT00001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/ATT00001.png -------------------------------------------------------------------------------- /www/static/common/images/arch-guide-cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/arch-guide-cover.png -------------------------------------------------------------------------------- /www/static/common/images/docs/superuser1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/docs/superuser1.png -------------------------------------------------------------------------------- /www/static/common/images/docs/superuser2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/docs/superuser2.png -------------------------------------------------------------------------------- /www/static/common/images/docs/superuser3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/docs/superuser3.png -------------------------------------------------------------------------------- /www/static/common/images/docs/superuser4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/docs/superuser4.png -------------------------------------------------------------------------------- /www/static/common/images/footer-facebook-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-facebook-hover.png -------------------------------------------------------------------------------- /www/static/common/images/footer-facebook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-facebook.png -------------------------------------------------------------------------------- /www/static/common/images/footer-linkedin-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-linkedin-hover.png -------------------------------------------------------------------------------- /www/static/common/images/footer-linkedin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-linkedin.png -------------------------------------------------------------------------------- /www/static/common/images/footer-twitter-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-twitter-hover.png -------------------------------------------------------------------------------- /www/static/common/images/footer-twitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-twitter.png -------------------------------------------------------------------------------- /www/static/common/images/footer-youtube-hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-youtube-hover.png -------------------------------------------------------------------------------- /www/static/common/images/footer-youtube.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/footer-youtube.png -------------------------------------------------------------------------------- /www/static/common/images/loading.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/loading.gif -------------------------------------------------------------------------------- /www/static/common/images/openlogo-100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/openlogo-100.png -------------------------------------------------------------------------------- /www/static/common/images/openstack-arch-guide-team.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/openstack-arch-guide-team.png -------------------------------------------------------------------------------- /www/static/common/images/openstack-logo-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/openstack-logo-full.png -------------------------------------------------------------------------------- /www/static/common/images/openstack-logo-vert.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/openstack-logo-vert.png -------------------------------------------------------------------------------- /www/static/common/images/search-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/common/images/search-icon.png -------------------------------------------------------------------------------- /www/static/common/js/bootstrap.min.js: -------------------------------------------------------------------------------- 1 | bootstrap.js -------------------------------------------------------------------------------- /www/static/common/js/deprecated-badge.js: -------------------------------------------------------------------------------- 1 | window.onload = function(){ 2 | document.getElementById('deprecated-badge-close-button').onclick = function(){ 3 | var deprecated_badge = document.getElementById('deprecated-badge'); 4 | deprecated_badge.style.display = 'none'; 5 | }; 6 | }; -------------------------------------------------------------------------------- /www/static/common/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 | } -------------------------------------------------------------------------------- /www/static/common/js/navigation.js: -------------------------------------------------------------------------------- 1 | 2 | // Open header drop downs on hover 3 | jQuery(document).ready(function(){ 4 | if (jQuery(window).width() > 767) { 5 | $('ul.navbar-main li ul.dropdown-menu').addClass('dropdown-hover'); 6 | $('ul.navbar-main li').hover(function() { 7 | $(this).find('.dropdown-hover').stop(true, true).delay(400).fadeIn(100); 8 | }, function() { 9 | $(this).find('.dropdown-hover').stop(true, true).delay(100).fadeOut(200); 10 | }); 11 | } else { 12 | $('ul.navbar-main li ul.dropdown-menu').removeClass('dropdown-hover'); 13 | } 14 | }); 15 | 16 | jQuery(window).resize(function () { 17 | if (jQuery(window).width() > 767) { 18 | $('ul.navbar-main li ul.dropdown-menu').addClass('dropdown-hover'); 19 | $('ul.navbar-main li').hover(function() { 20 | $(this).find('.dropdown-hover').stop(true, true).delay(400).fadeIn(100); 21 | }, function() { 22 | $(this).find('.dropdown-hover').stop(true, true).delay(100).fadeOut(200); 23 | }); 24 | } else { 25 | $('ul.navbar-main li ul.dropdown-menu').removeClass('dropdown-hover'); 26 | } 27 | }); 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /www/static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/openstack-manuals/829f718cbbbd8778ae1d4a0089e8e0e2f1019669/www/static/favicon.ico -------------------------------------------------------------------------------- /www/static/robots.txt: -------------------------------------------------------------------------------- 1 | # openstack-manuals/www/robots.txt 2 | User-agent: Googlebot 3 | Disallow: /*.pdf$ 4 | 5 | # Keep OpenStack users from accidentally using docs for the upcoming release 6 | User-agent: * 7 | Disallow: /trunk/ 8 | Disallow: /draft/ 9 | 10 | # Prevent legacy ironic releases from being indexed 11 | Disallow: /ironic/mitaka 12 | Disallow: /ironic/newton 13 | Disallow: /ironic/ocata 14 | Disallow: /ironic/pike 15 | Disallow: /ironic/queens 16 | Disallow: /ironic/rocky 17 | Disallow: /ironic/stein 18 | -------------------------------------------------------------------------------- /www/stein/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/stein/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/templates/api_guides.tmpl: -------------------------------------------------------------------------------- 1 |
2 |

API Guides

3 | API Guides 4 |

OpenStack API Documentation

5 |
6 | -------------------------------------------------------------------------------- /www/templates/base.tmpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | {% block header %}{% endblock %} 9 | OpenStack Docs: {% block pagetitle %}{% endblock %} 10 | 11 | 12 | 13 | {% include 'templates/css.tmpl' %} 14 | {% include 'templates/google_analytics.tmpl' %} 15 | 16 | 17 | {% include 'templates/header.tmpl' %} 18 | {% block content %}{% endblock %} 19 | {% include 'templates/deprecated_badge.tmpl' %} 20 | {% include 'templates/footer.tmpl' %} 21 | {% include 'templates/script_footer.tmpl' %} 22 | 23 | 24 | -------------------------------------------------------------------------------- /www/templates/contributor_guides.tmpl: -------------------------------------------------------------------------------- 1 |
2 |

Contributor Guides

3 | OpenStack Documentation Contributor Guide 4 |

Documentation workflow and conventions

5 | OpenStack Technical Committee Governance Documents 6 |

OpenStack Technical Committee reference documents and official resolutions

7 | OpenStack Project specifications 8 |

Specifications for future project features

9 | OpenStack Project Team Guide 10 |

Guide to the OpenStack project and community

11 | OpenStack Testing and Collaboration Tools Documentation 12 |

Community-managed development and communication systems

13 | OpenStack I18n Guide 14 |

Internationalization workflow and conventions

15 | Join the Open Infrastructure Foundation 16 |

How to join the Open Infrastructure Foundation

17 | Take the Deployment Survey 18 |

Influence the future of OpenStack

19 |
20 | -------------------------------------------------------------------------------- /www/templates/css.tmpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /www/templates/default.tmpl: -------------------------------------------------------------------------------- 1 | {%- extends "base.html" %} 2 | -------------------------------------------------------------------------------- /www/templates/dropdown_languages.tmpl: -------------------------------------------------------------------------------- 1 |
2 |
3 | Languages 4 | 14 |
15 |
16 | -------------------------------------------------------------------------------- /www/templates/google_analytics.tmpl: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | -------------------------------------------------------------------------------- /www/templates/navigation.tmpl: -------------------------------------------------------------------------------- 1 | 27 | -------------------------------------------------------------------------------- /www/templates/ops_and_admin_guides.tmpl: -------------------------------------------------------------------------------- 1 |

Operations and Administration Guides

2 | Administrator Guides 3 |

Manage and troubleshoot an OpenStack cloud

4 | 8 | Security Guide 9 |

Guidelines and scenarios for creating more secure OpenStack clouds

10 | Virtual Machine Image Guide[PDF] 11 |

Obtain, create, and modify OpenStack-compatible virtual machine images

12 | Architecture Design Guide 13 |

Guidelines for designing an OpenStack cloud

14 | -------------------------------------------------------------------------------- /www/templates/os_search.tmpl: -------------------------------------------------------------------------------- 1 |
2 |
3 |
-------------------------------------------------------------------------------- /www/templates/os_search_install.tmpl: -------------------------------------------------------------------------------- 1 | 11 | -------------------------------------------------------------------------------- /www/templates/os_search_mobile.tmpl: -------------------------------------------------------------------------------- 1 |
  • 2 |
    3 |
    • -------------------------------------------------------------------------------- /www/templates/project_guides.tmpl: -------------------------------------------------------------------------------- 1 |
    2 |

    Project-specific Guides

    3 | Services and Libraries 4 |

    Documentation for OpenStack services and libraries

    5 | Language Bindings and Python Clients 6 |

    Documentation for the OpenStack Python bindings and clients

    7 |
    8 | -------------------------------------------------------------------------------- /www/templates/script_footer.tmpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 26 | -------------------------------------------------------------------------------- /www/templates/script_search.tmpl: -------------------------------------------------------------------------------- 1 | 3 | 30 | -------------------------------------------------------------------------------- /www/templates/series_status.tmpl: -------------------------------------------------------------------------------- 1 | {# -*- mode: html -*- #} 2 | 3 | {% if SERIES_INFO.status in ('obsolete', 'EOL') %} 4 |

    5 | The {{SERIES_TITLE}} release of OpenStack is no longer supported by 6 | the community. For more information about the release, refer to 7 | the releases 8 | web site. 9 |

    10 | {% endif %} 11 | 12 | {% if SERIES_INFO.status == 'obsolete' %} 13 |

    14 | For documentation, please refer to a newer release. The most 15 | recently released version is 16 | {{RELEASED_SERIES|title}} 17 | and the version in development is 18 | {{SERIES_IN_DEVELOPMENT|title}}. 19 |

    20 | 21 | {% elif SERIES_INFO.status == 'EOL' %} 22 |

    23 | Minimal documentation is still published here to 24 | assist users running this version. For additional 25 | documentation, please refer to a newer release. The 26 | most recently released version is 27 | {{RELEASED_SERIES|title}} and 28 | the version in development is 29 | {{SERIES_IN_DEVELOPMENT|title}}. 30 |

    31 | 32 | {% elif SERIES == RELEASED_SERIES %} 33 |

    This is the latest release. Use the top menu to select a prior release 34 | if needed.

    35 | 36 | {% elif SERIES_INFO.status == 'extended-maintenance' %} 37 |

    This is an old release in extended maintenance. Use the top menu to 38 | select a different release if needed.

    39 | 40 | {% elif SERIES_INFO.status == 'unmaintained' %} 41 |

    This is an old unmaintained release. Use the top menu to 42 | select a different release if needed.

    43 | 44 | {% elif SERIES_INFO.status == 'maintained' %} 45 |

    This is not the latest release. Use the top menu to select a different 46 | release if needed.

    47 | 48 | {% elif SERIES_INFO.status == 'development' %} 49 |

    This release is currently under development. Use the top menu to select 50 | a different release if needed.

    51 | 52 | {% endif %} 53 | -------------------------------------------------------------------------------- /www/templates/training_guides.tmpl: -------------------------------------------------------------------------------- 1 |
    2 |

    Training Guides And Training Labs

    3 | Upstream training 4 |

    Resources for the OpenStack Upstream Training program

    5 |
    6 | -------------------------------------------------------------------------------- /www/templates/user_guides.tmpl: -------------------------------------------------------------------------------- 1 |
    2 |

    User Guides

    3 | End User Guide (includes Python SDKs) 4 |

    Create and manage resources using the OpenStack dashboard, command-line client, and Python SDKs

    5 | Open source software for application development 6 |

    Resources for application development on OpenStack clouds

    7 |
    8 | -------------------------------------------------------------------------------- /www/train/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/train/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/ussuri/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/ussuri/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/victoria/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/victoria/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/wallaby/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/wallaby/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
    10 |
    11 |
    12 |
    13 |

    OpenStack {{SERIES_TITLE}} Deployment Guides

    14 |

    The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

    16 |
    17 |
    18 |
    19 |
    20 |
    21 |
    22 |
    23 |
    24 |

    By deployment method

    25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

    28 | {{project.service}} Guide 29 |

    30 | {% endif %} 31 | {%- endfor %} 32 |
    33 |
    34 |
    35 |
    36 |
    37 |

    Documentation treated like code, powered by the community - interested?

    38 | How To Contribute 39 |
    40 |
    41 |
    42 |
    43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/wallaby/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/xena/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/xena/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
    10 |
    11 |
    12 |
    13 |

    OpenStack {{SERIES_TITLE}} Deployment Guides

    14 |

    The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

    16 |
    17 |
    18 |
    19 |
    20 |
    21 |
    22 |
    23 |
    24 |

    By deployment method

    25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

    28 | {{project.service}} Guide 29 |

    30 | {% endif %} 31 | {%- endfor %} 32 |
    33 |
    34 |
    35 |
    36 |
    37 |

    Documentation treated like code, powered by the community - interested?

    38 | How To Contribute 39 |
    40 |
    41 |
    42 |
    43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/xena/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/yoga/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/yoga/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
    10 |
    11 |
    12 |
    13 |

    OpenStack {{SERIES_TITLE}} Deployment Guides

    14 |

    The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

    16 |
    17 |
    18 |
    19 |
    20 |
    21 |
    22 |
    23 |
    24 |

    By deployment method

    25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

    28 | {{project.service}} Guide 29 |

    30 | {% endif %} 31 | {%- endfor %} 32 |
    33 |
    34 |
    35 |
    36 |
    37 |

    Documentation treated like code, powered by the community - interested?

    38 | How To Contribute 39 |
    40 |
    41 |
    42 |
    43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/yoga/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | -------------------------------------------------------------------------------- /www/zed/badge.html: -------------------------------------------------------------------------------- 1 | {% include 'templates/project_deprecated_badge.tmpl' %} -------------------------------------------------------------------------------- /www/zed/deploy/index.html: -------------------------------------------------------------------------------- 1 | {% set projects = PROJECT_DATA[SERIES] %} 2 | {% extends "templates/base.tmpl" %} 3 | {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} 4 | {% block title %} 5 | Documentation > {{SERIES_TITLE}} Deployment Guides 6 | {% endblock %} 7 | {% block content %} 8 | 9 |
    10 |
    11 |
    12 |
    13 |

    OpenStack {{SERIES_TITLE}} Deployment Guides

    14 |

    The following deployment guides support different installation 15 | methods for core and optional OpenStack services.

    16 |
    17 |
    18 |
    19 |
    20 |
    21 |
    22 |
    23 |
    24 |

    By deployment method

    25 | {% for project in projects|sort(attribute='name') -%} 26 | {% if project.type == 'deployment' and project.has_deployment_guide %} 27 |

    28 | {{project.service}} Guide 29 |

    30 | {% endif %} 31 | {%- endfor %} 32 |
    33 |
    34 |
    35 |
    36 |
    37 |

    Documentation treated like code, powered by the community - interested?

    38 | How To Contribute 39 |
    40 |
    41 |
    42 |
    43 | 44 | {% endblock content %} 45 | -------------------------------------------------------------------------------- /www/zed/projects.html: -------------------------------------------------------------------------------- 1 | {% extends "templates/project_list.tmpl" %} 2 | --------------------------------------------------------------------------------