diff options
Diffstat (limited to 'doc/source')
l--------- | doc/source/HACKING.rst | 1 | ||||
l--------- | doc/source/README.rst | 1 | ||||
-rw-r--r-- | doc/source/conf.py | 242 | ||||
-rw-r--r-- | doc/source/index.rst | 20 | ||||
-rw-r--r-- | doc/source/install.rst | 133 | ||||
-rw-r--r-- | doc/source/user_guide.rst | 16 |
6 files changed, 0 insertions, 413 deletions
diff --git a/doc/source/HACKING.rst b/doc/source/HACKING.rst deleted file mode 120000 index a2f06b72..00000000 --- a/doc/source/HACKING.rst +++ /dev/null @@ -1 +0,0 @@ -../../HACKING.rst
\ No newline at end of file diff --git a/doc/source/README.rst b/doc/source/README.rst deleted file mode 120000 index c768ff7d..00000000 --- a/doc/source/README.rst +++ /dev/null @@ -1 +0,0 @@ -../../README.rst
\ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100644 index 756f56f9..00000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,242 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Tuskar UI documentation build configuration file, created by -# sphinx-quickstart on Thu Apr 24 09:19:32 2014. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'oslosphinx'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Tuskar UI' -copyright = u'2014, Tuskar Team' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = 'Juno' -# The full version, including alpha/beta/rc tags. -release = 'Juno' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'TuskarUIdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'TuskarUI.tex', u'Tuskar UI Documentation', - u'Tuskar Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'tuskarui', u'Tuskar UI Documentation', - [u'Tuskar Team'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'TuskarUI', u'Tuskar UI Documentation', - u'Tuskar Team', 'TuskarUI', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index d6176cb0..00000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -Tuskar UI -========= - -Contents: - -.. toctree:: - :maxdepth: 2 - - README - install - user_guide - HACKING - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/source/install.rst b/doc/source/install.rst deleted file mode 100644 index 7f2590ab..00000000 --- a/doc/source/install.rst +++ /dev/null @@ -1,133 +0,0 @@ -Installation instructions -========================= - -Note ----- - -If you want to install and configure the entire TripleO + Tuskar + Tuskar UI -stack, you can use -`the devtest installation guide <https://wiki.openstack.org/wiki/Tuskar/Devtest>`_. - -Otherwise, you can use the installation instructions for Tuskar UI below. - -Prerequisites -------------- - -Installation prerequisites are: - -1. A functional OpenStack installation. Horizon and Tuskar UI will - connect to the Keystone service here. Keystone does *not* need to be - on the same machine as your Tuskar UI interface, but its HTTP API - must be accessible. -2. A functional Tuskar installation. Tuskar UI talks to Tuskar via an - HTTP interface. It may, but does not have to, reside on the same - machine as Tuskar UI, but it must be network accessible. - -You may find -`the Tuskar install guide <https://github.com/openstack/tuskar/blob/master/doc/source/install.rst>`_ -helpful. - - -Installing the packages ------------------------ - -Tuskar UI is a Django app written in Python and has a few installation -dependencies: - -On a RHEL 6 system, you should install the following: - -:: - - yum install git python-devel swig openssl-devel mysql-devel libxml2-devel libxslt-devel gcc gcc-c++ - -The above should work well for similar RPM-based distributions. For -other distros or platforms, you will obviously need to convert as -appropriate. - -Then, you'll want to use the ``easy_install`` utility to set up a few -other tools: - -:: - - easy_install pip - easy_install nose - -Install the management UI -------------------------- - -Begin by cloning the Horizon and Tuskar UI repositories: - -:: - - git clone git://github.com/openstack/horizon.git - git clone git://github.com/openstack/python-tuskarclient.git - git clone git://github.com/openstack/tuskar-ui.git - -Go into ``horizon`` and install a virtual environment for your setup:: - - cd horizon - python tools/install_venv.py - - -Next, run ``run_tests.sh`` to have pip install Horizon dependencies: - -:: - - ./run_tests.sh - -Set up your ``local_settings.py`` file: - -:: - - cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py - -Open up the copied ``local_settings.py`` file in your preferred text -editor. You will want to customize several settings: - -- ``OPENSTACK_HOST`` should be configured with the hostname of your - OpenStack server. Verify that the ``OPENSTACK_KEYSTONE_URL`` and - ``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your - environment. (They should be correct unless you modified your - OpenStack server to change them.) - -Install Tuskar UI with all dependencies in your virtual environment:: - - tools/with_venv.sh pip install -e ../python-tuskarclient/ - tools/with_venv.sh pip install -e ../tuskar-ui/ - -And enable it in Horizon:: - - cp ../tuskar-ui/_50_tuskar.py.example openstack_dashboard/local/enabled/_50_tuskar.py - -Then disable the other dashboards:: - - cp ../tuskar-ui/_10_admin.py.example openstack_dashboard/local/enabled/_10_admin.py - cp ../tuskar-ui/_20_project.py.example openstack_dashboard/local/enabled/_20_project.py - cp ../tuskar-ui/_30_identity.py.example openstack_dashboard/local/enabled/_30_identity.py - - -Starting the app ----------------- - -If everything has gone according to plan, you should be able to run: - -:: - - tools/with_venv.sh ./manage.py runserver - -and have the application start on port 8080. The Tuskar UI dashboard will -be located at http://localhost:8080/infrastructure - -If you wish to access it remotely (i.e., not just from localhost), you -need to open port 8080 in iptables: - -:: - - iptables -I INPUT -p tcp --dport 8080 -j ACCEPT - -and launch the server with ``0.0.0.0:8080`` on the end: - -:: - - tools/with_venv.sh ./manage.py runserver 0.0.0.0:8080 - diff --git a/doc/source/user_guide.rst b/doc/source/user_guide.rst deleted file mode 100644 index 782c9e05..00000000 --- a/doc/source/user_guide.rst +++ /dev/null @@ -1,16 +0,0 @@ -========== -User Guide -========== - -Nodes List File ---------------- - -To allow users to load a bunch of nodes at once, there is possibility to -upload CSV file with given list of nodes. This file should be formatted as - -:: - - driver,address,username,password/ssh key,mac addresses,cpu architecture,number of CPUs,available memory,available storage - -Even if there is no all data available, we assume empty values for missing -keys and try to parse everything, what is possible. |