diff options
author | Jan Safranek <jsafrane@redhat.com> | 2013-10-18 14:45:03 +0200 |
---|---|---|
committer | Jan Safranek <jsafrane@redhat.com> | 2013-10-18 14:45:03 +0200 |
commit | c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336 (patch) | |
tree | dc34216411938495b489368e15e22a7e5a5d0878 /src/realmd | |
parent | 087d51a3b03815ddbacaf62bf2fa047dbcbb9537 (diff) | |
download | openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.gz openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.xz openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.zip |
Rework documentation.
- Everything is in openlmi-providers/doc/admin directory.
- 'make doc' automatically builds documentation of all
enabled providers.
- Documentation shares one 'conf.py' for sphinx.
- All documentation uses the same directory structure.
There is only one CMakefile.txt to generate all the docs.
Diffstat (limited to 'src/realmd')
-rw-r--r-- | src/realmd/doc/Makefile | 159 | ||||
-rw-r--r-- | src/realmd/doc/class_diagram.svg | 176 | ||||
-rwxr-xr-x | src/realmd/doc/examples/realmd-cim | 175 | ||||
-rw-r--r-- | src/realmd/doc/source/conf.py | 243 | ||||
-rw-r--r-- | src/realmd/doc/source/index.rst | 24 | ||||
-rw-r--r-- | src/realmd/doc/source/mof/Makefile | 14 | ||||
-rw-r--r-- | src/realmd/doc/source/mof/header.txt | 2 | ||||
-rw-r--r-- | src/realmd/doc/source/usage.rst | 47 |
8 files changed, 0 insertions, 840 deletions
diff --git a/src/realmd/doc/Makefile b/src/realmd/doc/Makefile deleted file mode 100644 index 78f87c9..0000000 --- a/src/realmd/doc/Makefile +++ /dev/null @@ -1,159 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext mof - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -mof: - make -C source/mof - -mof-clean: - make -C source/mof clean - -clean: mof-clean - -rm -rf $(BUILDDIR)/* - -html: mof - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMIService.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIService.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMIService" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIService" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/src/realmd/doc/class_diagram.svg b/src/realmd/doc/class_diagram.svg deleted file mode 100644 index 8cf2243..0000000 --- a/src/realmd/doc/class_diagram.svg +++ /dev/null @@ -1,176 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- Created with Inkscape (http://www.inkscape.org/) --> - -<svg - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:cc="http://creativecommons.org/ns#" - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns="http://www.w3.org/2000/svg" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="744.09448819" - height="1052.3622047" - id="svg2" - version="1.1" - inkscape:version="0.48.4 r9939" - sodipodi:docname="class_diagram.svg"> - <defs - id="defs4"> - <marker - inkscape:stockid="Arrow2Mend" - orient="auto" - refY="0.0" - refX="0.0" - id="Arrow2Mend" - style="overflow:visible;"> - <path - id="path3871" - style="fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" - d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " - transform="scale(0.6) rotate(180) translate(0,0)" /> - </marker> - <marker - inkscape:stockid="Arrow2Lend" - orient="auto" - refY="0.0" - refX="0.0" - id="Arrow2Lend" - style="overflow:visible;"> - <path - id="path3865" - style="fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" - d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " - transform="scale(1.1) rotate(180) translate(1,0)" /> - </marker> - </defs> - <sodipodi:namedview - id="base" - pagecolor="#ffffff" - bordercolor="#666666" - borderopacity="1.0" - inkscape:pageopacity="0.0" - inkscape:pageshadow="2" - inkscape:zoom="2.8" - inkscape:cx="236.5764" - inkscape:cy="611.39239" - inkscape:document-units="px" - inkscape:current-layer="layer1" - showgrid="true" - inkscape:window-width="1920" - inkscape:window-height="1051" - inkscape:window-x="1680" - inkscape:window-y="0" - inkscape:window-maximized="1" - inkscape:snap-grids="true" - inkscape:snap-bbox="true"> - <inkscape:grid - type="xygrid" - id="grid3006" - empspacing="5" - visible="true" - enabled="true" - snapvisiblegridlinesonly="true" /> - </sodipodi:namedview> - <metadata - id="metadata7"> - <rdf:RDF> - <cc:Work - rdf:about=""> - <dc:format>image/svg+xml</dc:format> - <dc:type - rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - </cc:Work> - </rdf:RDF> - </metadata> - <g - inkscape:label="Layer 1" - inkscape:groupmode="layer" - id="layer1"> - <g - id="g3035"> - <g - id="g3030"> - <g - id="g3022" - transform="matrix(1,0,0,0.97395887,0,10.489247)"> - <rect - y="402.36218" - x="350.39706" - height="25" - width="120" - id="rect3008" - style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.41732287;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> - </g> - <path - style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="m 350.39707,417.36218 120,0" - id="path3014" - inkscape:connector-curvature="0" /> - </g> - <text - sodipodi:linespacing="125%" - id="text3010" - y="412.41025" - x="375.69394" - style="font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="412.41025" - x="375.69394" - id="tspan3012" - sodipodi:role="line">ComputerSystem</tspan></text> - </g> - <g - id="g3085" - transform="translate(-0.3488455,0)"> - <g - transform="translate(-221,2e-6)" - id="g3030-5"> - <g - id="g3022-6" - transform="matrix(1,0,0,0.97395887,0,10.489247)"> - <rect - y="402.36218" - x="350.39706" - height="25" - width="120" - id="rect3008-5" - style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.41732287;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" /> - </g> - <path - style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="m 350.39707,417.36218 120,0" - id="path3014-2" - inkscape:connector-curvature="0" /> - </g> - <text - sodipodi:linespacing="125%" - id="text3010-2" - y="412.41025" - x="189.21738" - style="font-size:8px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="412.41025" - x="189.21738" - id="tspan3012-9" - sodipodi:role="line">RealmdService</tspan></text> - </g> - <path - style="fill:#000000;fill-opacity:1;stroke:#ff0000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="m 350,417.36218 -100,0" - id="path3093" - inkscape:connector-type="polyline" - inkscape:connector-curvature="0" /> - <text - xml:space="preserve" - style="font-size:8px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Bitstream Vera Sans" - x="270.92188" - y="412.43054" - id="text3863" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan3865" - x="270.92188" - y="412.43054">HostedService</tspan></text> - </g> -</svg> diff --git a/src/realmd/doc/examples/realmd-cim b/src/realmd/doc/examples/realmd-cim deleted file mode 100755 index eb3f9be..0000000 --- a/src/realmd/doc/examples/realmd-cim +++ /dev/null @@ -1,175 +0,0 @@ -#!/usr/bin/python - -import sys -import os -import optparse -import urlparse -import pywbem - -#---------------------------------------------------------------------- - -def do_status(conn, options, args): - try: - realmd_service = conn.EnumerateInstances('LMI_RealmdService')[0] - except Exception, e: - raise ValueError("could not obtain realmd service") - - if realmd_service["Domain"]: - print "Joined to the domain: %s" % realmd_service["Domain"] - else: - print "Not joined to a domain" - -def do_join(conn, options, args): - # Validate arguments - if len(args) != 3: - raise ValueError("You must supply exacly 3 arguments (user, password, domain)") - - user, password, domain = args - - if (options.verbose): - print "Joining domain: %s" % domain - - try: - realmd_service_instance_name = conn.EnumerateInstanceNames('LMI_RealmdService')[0] - except Exception, e: - raise ValueError("could not obtain realmd service") - - try: - retval, outparams = conn.InvokeMethod("JoinDomain", realmd_service_instance_name, - Domain=domain, - User=user, - Password=password) - except Exception, e: - raise ValueError("Join failed (%s)" % (e)) - - - -def do_leave(conn, options, args): - # Validate arguments - if len(args) != 3: - raise ValueError("You must supply exacly 3 arguments (user, password, domain)") - - user, password, domain = args - - if (options.verbose): - print "Leave domain: %s" % domain - - try: - realmd_service_instance_name = conn.EnumerateInstanceNames('LMI_RealmdService')[0] - except Exception, e: - raise ValueError("could not obtain realmd service") - - try: - retval, outparams = conn.InvokeMethod("LeaveDomain", realmd_service_instance_name, - Domain=domain, - User=user, - Password=password) - except Exception, e: - raise ValueError("Leave failed (%s)" % (e)) - -#---------------------------------------------------------------------- - -def main(): - - actions = {'status': do_status, - 'join': do_join, - 'leave': do_leave, - } - - usage =''' - %%prog [options] <action> <arg> ... - - %%prog [options] status - %%prog [options] join user password domain - %%prog [options] leave user password domain - - Available Actions: %(actions)s - ''' % {'actions': ", ".join(sorted(actions.keys()))} - - # Set-up defaults - - default_cimom_port = 5989 - default_url = os.environ.get("LMI_CIMOM_URL", "https://localhost:5989") - - parsed_default_url = urlparse.urlparse(default_url) - - if parsed_default_url.port: - default_port = parsed_default_url.port or default_cimom_port - - default_username = os.environ.get("LMI_CIMOM_USERNAME", "root") - default_password = os.environ.get("LMI_CIMOM_PASSWORD", "") - - # Set-up arg parser - parser = optparse.OptionParser(usage=usage) - - parser.add_option('-c', '--url', dest='url', default=default_url, - help='CIMOM URL or hostname to connect to') - - parser.add_option('-u', '--username', dest='username', default=default_username, - help='Username for CIMOM authentication') - - parser.add_option('-p', '--password', dest='password', default=default_password, - help='Password for CIMOM authentication') - - parser.add_option('-v', '--verbose', dest='verbose', default=0, - action='count', - help='Turn on verbose output, increases verbosity level by one each time specified') - - options, args = parser.parse_args() - - # Validate arguments - - try: - action = args.pop(0) - except IndexError: - print >>sys.stderr, "You must supply an action to execute" - parser.print_help() - return 1 - - try: - action_func = actions[action] - except KeyError: - print >>sys.stderr, "Unknown action (%s)" % (action) - parser.print_help() - return 1 - - # Get CIMOM URL - - parsed_url = urlparse.urlparse(options.url) - - if not parsed_url.netloc: - # Handle case where URL was bare hostname - parsed_url = urlparse.urlparse('//' + options.url) - - scheme = 'https' - hostname = parsed_url.hostname - port = parsed_url.port or default_port - - url = urlparse.urlunparse((scheme, "%s:%d" % (hostname, port), '', None, None, None)) - - # Connect to CIMOM - - if (options.verbose): - print "Connecting to: %s" % url - - try: - conn = pywbem.WBEMConnection(url, (options.username, options.password)) - except Exception, e: - print >>sys.stderr, "Unable to connect to %s (%s)" % (options.url, e) - return 1 - - - # Execute action - - try: - action_func(conn, options, args) - except Exception, e: - print >>sys.stderr, "%s failed: %s" % (action, e) - return 1 - - return 0 - -#---------------------------------------------------------------------- - -if __name__ == "__main__": - sys.exit(main()) diff --git a/src/realmd/doc/source/conf.py b/src/realmd/doc/source/conf.py deleted file mode 100644 index 4f43459..0000000 --- a/src/realmd/doc/source/conf.py +++ /dev/null @@ -1,243 +0,0 @@ -# -*- coding: utf-8 -*- -# -# OpenLMI Realmd documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 07 15:50:04 2013. -# -# 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.todo', 'sphinx.ext.viewcode'] - -# 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'OpenLMI Realmd' -copyright = u'2012-2013, Red Hat Inc.' - -# 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 = '0.3.0' -# The full version, including alpha/beta/rc tags. -release = '0.3.0' - -# 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 = 'openlmitheme' - -# 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 = ['../../../../tools/'] - -# 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 = 'OpenLMIRealmddoc' - - -# -- 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', 'OpenLMIRealmd.tex', u'OpenLMI Realmd Documentation', - u'Tomas Smetana', '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', 'openlmiservice', u'OpenLMI Realmd Documentation', - [u'Tomas Smetana'], 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', 'OpenLMIRealmd', u'OpenLMI Realmd Documentation', - u'Tomas Smetana', 'OpenLMIRealmd', - 'CIM Provider for managing the Realmd service.', - '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/src/realmd/doc/source/index.rst b/src/realmd/doc/source/index.rst deleted file mode 100644 index d6d516f..0000000 --- a/src/realmd/doc/source/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -OpenLMI Realmd Provider documentation -=========================================== -OpenLMI Realmd is a CIM provider for managing the systems Active Direcory or -Kerberos realms membership through the Realmd system service. - -It provides only the basic functionality: join or leave a domain and query the -domain membership. - -Contents: - -.. toctree:: - :maxdepth: 2 - - usage - -.. ifconfig:: includeClasses - - OpenLMI Realmd CIM Classes: - - .. toctree:: - :maxdepth: 1 - - mof/tree - mof/index diff --git a/src/realmd/doc/source/mof/Makefile b/src/realmd/doc/source/mof/Makefile deleted file mode 100644 index b0a60a8..0000000 --- a/src/realmd/doc/source/mof/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -all: index.rst - -TOPDIR=../../../../.. -MOFS=$(TOPDIR)/mof/60_LMI_Realmd.mof - -clean: - rm -f *.rst - -index.rst: $(MOFS) - $(TOPDIR)/tools/openlmi-doc-class2rst -H header.txt -M `echo $(MOFS) | sed 's/ / -M /g'` \ - -S /usr/share/mof/cim-current/CIM_Schema.mof \ - -S $(TOPDIR)/mof/05_LMI_Qualifiers.mof \ - -S $(TOPDIR)/mof/30_LMI_Jobs.mof \ - `cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'` diff --git a/src/realmd/doc/source/mof/header.txt b/src/realmd/doc/source/mof/header.txt deleted file mode 100644 index cc06402..0000000 --- a/src/realmd/doc/source/mof/header.txt +++ /dev/null @@ -1,2 +0,0 @@ -Class reference -=============== diff --git a/src/realmd/doc/source/usage.rst b/src/realmd/doc/source/usage.rst deleted file mode 100644 index 1613373..0000000 --- a/src/realmd/doc/source/usage.rst +++ /dev/null @@ -1,47 +0,0 @@ -OpenLMI Realmd usage -===================== - -The OpenLMI Realmd provider allows for basic configuration of the managed -systems Active Directory or Kerberos realms membership. It relies on the Realmd -system service. - -Querying a domain membership ----------------------------- - -To verify if the remote machine is part of the domain, it is enough to query the -value of the :ref:`LMI_RealmdService.Domain<LMI-RealmdService-Domain>` property: -If non-NULL it contains the name of the joined domain:: - - #!/usr/bin/lmishell - c = connect("localhost", "pegasus", "test") - realmsrv = c.root.cimv2.LMI_RealmdService.first_instance() - dom = realmsrv.Domain - if (dom): - print "Joined to the domain: " + dom - else: - print "No domain joined." - -Joining a domain ----------------- - -The :ref:`LMI_RealmdService.JoinDomain()<LMI-RealmdService-JoinDomain>` method -can be used to join a domain. It takes three mandatory arguments: username and -password for the authentication and the domain name:: - - #!/usr/bin/lmishell - c = connect("localhost", "pegasus", "test") - realmsrv = c.root.cimv2.LMI_RealmdService.first_instance() - realmsrv.JoinDomain(Password='ZisIzSECRET', User='admin', Domain='AD.EXAMPLE.COM') - -Leaving a domain ----------------- - -Similarly to joining a domain the -:ref:`LMI_RealmdService.LeaveDomain()<LMI-RealmdService-LeaveDomain>` can be used -to leave the joined domain. It requires the same arguments as the -:ref:`JoinDomain()<LMI-RealmdService-JoinDomain>` method:: - - #!/usr/bin/lmishell - c = connect("localhost", "pegasus", "test") - realmsrv = c.root.cimv2.LMI_RealmdService.first_instance() - realmsrv.LeaveDomain(Password='ZisIzSECRET', User='admin', Domain='AD.EXAMPLE.COM') |