These two documents were incredibly outdated, but also had almost
identical concerns. This patch updates the content and merges the two
documents.
Note that this guide is still separate to the quickstart guide, which is
intended for developers. In future patches in this blueprint, the file &
navigation structure will be altered to make this distinction more
clear.
Change-Id: Ic5d111d53ab69a3cd1ab08c4c05b2d676e79258c
Implements: blueprint pike-docs-overhaul
After switching openstackdocstheme, TOC in the left sidebar becomes long.
This is because openstackdocstheme treats the first level of 'doctree'
in the top page (index.rst). In Horizon documentation, many documents
are listed as the first level, so the sidebar is long.
This commit adds index.rst per topic and merges all toctree
under the developer docs into a single toctree.
This will lead to the well-organized toc tree in the sidebar.
(Note that this does not touch "Using Horizon" part as it is being
refactored in https://review.openstack.org/#/c/473932/.)
The title level of "Packaging Horizon" in topics/packaging.rst is
changed to the second level because openstackdocthemes assume
only one first-level title per file and the second first-level title
or later are not displayed in a rendered page.
Implements: blueprint pike-docs-overhaul
Change-Id: I16e2bae18d8f67716c9838094a39527cd8bf733e
The CLI propmpt symbol in the updated doc was changed to #, which
implies root. Lets not encourage people to run a bunch of things as
root. This patch reverts it to $
Change-Id: Iac7343e676cc58b79e7328cdbad1652f98da0ecf
Implements: blueprint pike-docs-overhaul
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.
[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081
Change-Id: Ia6721b3b2bdf8427e8c42b4f056f5fcb7c4b73ee
Update the example local.conf with a couple of useful options, and
remove plugins that are no longer part of the Horizon tree.
Change-Id: I5a4de7041fdf821b480d1fe34cf9423441390d91
Implements: blueprint pike-docs-overhaul
This patch is the first in a series improving Horizons documentation. It
aims to make the initial quick start section clearer, updates the
information to remove some redundant information, and updates the
appearance to match the rest of the openstack docs.
Change-Id: I942e62b6c2c272dc2b5c91bca42c77677bb4e09d
Implements: blueprint pike-docs-overhaul
This patch adds the ability to configure the default "create volume"
value when launching an instance with Cinder enabled.
Co-Authored-By: Rob Cresswell <robert.cresswell@outlook.com>
Closes-Bug: 1678109
Change-Id: I272f7f1b20cc1276976c464a82d1776de92d17e7
There is no need to catch warnings from openstack_dashboard.settings
in the doc build job. This might be a bug of a recent Sphinx 1.6.x,
but I think it is useful to have this setting to avoid unexpected failures.
Change-Id: I9894622ba0f5fbb74e9dac016ed76ac9e3c2f733
This change extends the description of OPENSTACK_HOST, now including
references to other settings that explain how to setup multiple region in
Horizon.
Change-Id: Id079cae5767159ff8d2ff8b854ab218db1fbdd79
The enabled files for the Developer dashboard and Theme Preview
panel have been moved to contrib.
Added the step for copying enabled files to the local folder.
Change-Id: I3182aafd86e1ed1ba610d4b11bed81f8a65eb0e3
Closes-bug: #1691291
IP address is now included in the default format
as %(client_ip)s what fully covers auditing
use case for this log.
Change-Id: I226f268b0eac6e35021b3e86aef512108ddb5691
Closes-Bug: #1688484
The floating IPs tab on access and security panel was moved to
its own panel in Ocata.
Replaced the example of disabling floating IPs tab with an example
to disable the orchestration services tab.
Change-Id: Ibba5834b17a116f16b761c495732928b103b7324
Closes-bug: #1688147
enable_firewall and enable_vpn settings have been deprecated
since Juno release, but they have not been dropped yet just because
we need a lot of changes in unit tests if dropped.
The situation is resolved by the parent commit and we can now drop these
settings safely. We can control whether a specific panel should be
enabled or disabled via the pluggable panel mechanism ("enabled" dir).
Also clean up enable_lb which has gone several releases ago.
Closes-Bug: #1687185
Change-Id: I83fa48c5d9568a00294be7cd5f43ef181bc1f28d
We support py35 now. We do not have python 3.4 in setup.cfg which
declares the explicit supported versions. so it is no need to keep
the supoort for py34.
Change-Id: I8a2176e020714a1577573f1453ce1892706b36e4
Update the VNIC type list shown by Horizon to match the options
supported by neutronclient.
See neutronclient/tests/unit/test_cli20_port.py
Closes-Bug: 1681917
Change-Id: Ifbe81a3a3b5f2edc9c0b8a0129d780546119a92e
python-openstackclient, shade, openstacksdk and Ansible's OpenStack
modules all support reading client config information from a file called
clouds.yaml instead of from environment variables set from openrc files.
Unfortunately, the only thing horizon currently offers for download is
old-style openrc files.
Add support for downloading clouds.yaml files.
Change-Id: I0611dd44524b746ad993bff7435ec8628a83a762
This patch adds microversion support to Horizon, as well as
documentation, service references, tests and an example.
Implements: blueprint microversion-support
Change-Id: Ic5aa559dbc13aa84d8e4a14b68f26f5d84183fa9
Previously we mentioned py27djXX but py27 was not described.
Also add how to run a specific test class or a specific test
in a test class.
Change-Id: If442c29c0fcd9bef207cbda7212a8f1c4b8340d4
There's some vendor specific code still lingering from several cycles
ago. This patch removes all usage of it, all related tests, and all
default settings.
Implements: blueprint horizon-vendor-split
Change-Id: Ic0bb84f547b07b130480e587bd365f6e7805dfb5
Some places are not using ThemableSelectWidget, so
these select ui is not themable. This patch fix it.
Change-Id: I303a9cf8c6f8f651edf68973a2f5e16a8b04b26d
Closes-bug: #1669696
Added setting physical_networks to provide users list of
available physical networks to choose from on the
admin create network modal.
Default to an empty list and the physical network field is
a regular input field where users can type in the name
of the physical network to be used.
If it's set to a list of physical network names, the
physical network field is a dropdown menu where users can
choose a physical network to use.
Closes-bug: #1485144
Change-Id: I342b3776a52179d5b4a704fb984912878ff3dc81
Added documentation for Jasmine break points and how to check why
tests fail minimum threshold. Also removed irrelevant python test
documentation.
Change-Id: Idf3b4bf74aaf4712a13c3c3e4c6f0880457f78d8
The docs erroneously indicate that OPENSTACK_KEYSTONE_URL should not
be set when AVAILABLE_REGIONS is used, but it actually should be.
Change-Id: I2bd55b1c7e41c14a2624aadd8d32acdae5753839
Closes-Bug: 1667557
This patch fixes the auto enumerated formatting for the profiler setup
steps, as well as cleaning up some of the text formatting and language.
Change-Id: I4a7f109e87a274ab85d67e6691a53a085c16f04f
Closes-bug: 1664500
The description for the PROJECT_TABLE_EXTRA_INFO and
USER_TABLE_EXTRA_INFO settings makes no sense. This patch cleans
up the English to describe how to use these settings.
Change-Id: I6e14889a1dc8b3e4b242b6649847761084500c08
