1. 12 May, 2009 4 commits
    • Iustin Pop's avatar
      Some small doc updates · fd07c6b3
      Iustin Pop authored
      We change some formatting to sphinx-specific, to show how the
      documentation can be improved.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
    • Iustin Pop's avatar
      Move the glossary to a separate file · e2078d28
      Iustin Pop authored
      Currently we have an insignificant glossary at the end of the design-2.0
      document. This patch moves it to a separate file with the goal that it
      will grow and all files can refer to it.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
    • Iustin Pop's avatar
      Switch the documentation to sphinx · d17e74b4
      Iustin Pop authored
      This big patch converts the documentation build system to sphinx
      ). Since that uses reStructuredText sources
      too, there is no change (yet) in the documents themselves, just in the
      build system.
      As before, the docs are pre built by the maintainer, and the end-user
      doesn't need sphinx or other rst tools to build the docs. Note that we
      are not distributing PDFs, so building that will require the tools.
      The docs will be stored under doc/html and the build system also need an
      extra directory doc/build. These are considered (by automake)
      maintainer-related objects and are removed at maintainer-clean time.
      The patch also fixes some small issues: add a docpng variable, add
      doc/api (also generated by maintainer) in maintainer-clean-local, etc.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
    • Iustin Pop's avatar
      Convert from auto-generated RAPI docs to static · 6d81475c
      Iustin Pop authored
      This patch removes the autogeneration of the RAPI docs from the code
      (based on docstrings) and moves the current autogenerated output to
      the rapi.rst file.
      The reasons behind this are multiple:
        - the build system becomes a little more simple (this could have been
      	achieved also by distributing the built documentation, though)
        - it's hard to actually write documentation in docstrings; you have to
      	fit restructured text inside the docstrings, and this results in
      	not really nice output
        - even by being close to the code, the documentation manages to get
      	out of sync (not paying attention to docstrings)
      This will also help with the move to sphinx.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
  2. 06 May, 2009 1 commit
  3. 15 Apr, 2009 1 commit
    • Iustin Pop's avatar
      A bunch of doc and other small fixes · 949bdabe
      Iustin Pop authored
      This patch adds a couple of both externally and internally reported
        - missing SGML tags (Issue 54), report and patch by superdupont
        - wrong variable used in the init.d script, report and patch by
          Karsten Keil <karsten-keil@t-online.de>
        - man page for gnt-instance reinstall needs clarification (Issue 56)
        - gnt-instance man page missing --disks documentation for
        - gnt-node modify help output is unclear about the -C/-D/-O input
          format, and the man page doesn't document this command at all
        - “gnt-node modify -C yes” for offline or drained nodes had wrong
          error message
        - “gnt-instance reinstall --select-os” has wrong prompt, we only
          accept a number for the OS and not the template name
      Reviewed-by: ultrotter
  4. 12 Mar, 2009 1 commit
    • Iustin Pop's avatar
      Add the 2.0-specific node flags to the design doc · e0eb13de
      Iustin Pop authored
      This patch adds the newly-introduced node flags to the design document,
      as they currently are missing from there.
      The patch also reduces the TOC depth to 3, as it was too big.
      Reviewed-by: ultrotter
  5. 04 Mar, 2009 1 commit
  6. 02 Mar, 2009 3 commits
    • Iustin Pop's avatar
      Export tags to cluster verify hooks · 35e994e9
      Iustin Pop authored
      This patch export the cluster and node tags to the cluster verify hook
      scripts. The tags are exported as a space-separated list, which allows
      easy parsing from the shell (e.g. “for tag in $GANETI_CLUSTER_TAGS; do
      ...”) and therefore requires the previous “Don't allow spaces in tag
      names” patch.
      The patch also fixes a minor line length style problem.
      Reviewed-by: ultrotter
    • Iustin Pop's avatar
      Update the iallocator documentation · 77031881
      Iustin Pop authored
      This updates the iallocator documentation to 2.0, bumps up the
      iallocator version (and moves a constants to lib/constants.py), and
      fixes a style on install.rst.
      Reviewed-by: ultrotter
    • Iustin Pop's avatar
      A doc update and a small indentation fix · b806661b
      Iustin Pop authored
      This adds a small paragraph about the “master” role of a node, and fixes
      a wrong indentation in the bash completion file.
      Reviewed-by: imsnah
  7. 27 Feb, 2009 2 commits
    • Iustin Pop's avatar
      Convert the RAPI document to restructured text · 4352bf6d
      Iustin Pop authored
      This patch changes the RAPI document, and the RAPI resources
      autogenerated-documentation to restructured text. This meant changing
      the autogen tool.
      The new fragment can be included via RST directives, and doesn't need
      passing through replace-sed-vars. This was also the last sgml document
      in doc/, so we remove old makefile rules about it.
      Reviewed-by: imsnah
    • Iustin Pop's avatar
      Convert the install document to restructured text. · 28e15341
      Iustin Pop authored
      This switches back to the hardcoding of the version number, as we don't
      yet have a wrapper for rst files that passes them through
      Reviewed-by: imsnah
  8. 26 Feb, 2009 1 commit
    • Iustin Pop's avatar
      Add bash-completion rules · e2a2a2eb
      Iustin Pop authored
      This is a not-complete bash completion file for ganeti commands (gnt-*)
      and the burnin tool. It is based on previous work by Minghua Ye
      <yeminghua@google.com> for Ganeti 1.1, which wasn't used because the
      lack of ssconf keys (which allow easy inspection by the shell of the
      existing nodes and instances) made it too slow.
      The file works as expected, however I realized that our custom (like
      comma-separated, or a=b:c,e:f) options are not very nice for
      auto-completion. There are a few FIXMEs in the source for that.
      The file is not installed at make install time, but it should be put in
      the correct place by packages.
      Reviewed-by: imsnah
  9. 25 Feb, 2009 1 commit
  10. 24 Feb, 2009 2 commits
    • Iustin Pop's avatar
      Convert iallocator.sgml to restructured text · 876860a3
      Iustin Pop authored
      This is a no-contents change, this doc will need update to conform to
      2.0 message contents (and also the code will need increase to version 2
      of the iallocator protocol).
      Reviewed-by: imsnah
    • Iustin Pop's avatar
      Convert the admin guide to restructured text · ffa6869f
      Iustin Pop authored
      The RST format holds a little bit less information, as all the <file
      class="directory"> and <userinput> tags are gone, however we're not
      really losing important context here. And it's way easier to read and
      Reviewed-by: imsnah
  11. 20 Feb, 2009 1 commit
  12. 17 Feb, 2009 1 commit
  13. 13 Feb, 2009 1 commit
  14. 10 Feb, 2009 1 commit
  15. 05 Feb, 2009 1 commit
  16. 29 Jan, 2009 1 commit
  17. 23 Jan, 2009 2 commits
    • Iustin Pop's avatar
      Fix batcher for 2.0-style disks and nics · 9939547b
      Iustin Pop authored
      This patch fixes the gnt-instance batch-create command, and in doing so
      also slightly changes two other functions:
        - we change utils.ParseUnit so that it accepts integer values also
          (both ParseUnit(5) and ParseUnit("5") return the same value)
        - a bridge 'None' in LUCreateInstance will be converted to the default
          bridge; currently only missing bridges will be accepted to mean the
          default one
      The main changes to batcher were the change to variable number of disks
      and NICs.
      The patch also adds a batcher-instances.json example file copied from
      the 1.2 branch and properly modified.
      Reviewed-by: imsnah, killerfoxi
    • Iustin Pop's avatar
      Make iallocator work with offline nodes · 1325da74
      Iustin Pop authored
      This patch changes the iallocator framework to work with and properly
      export to plugins offline nodes. It does this by only exporting the
      static configuration data for those nodes, and not attempting to parse
      the runtime data.
      The patch also fixes bugs in iallocator related to the RpcResult
      conversion, changes the should_run to admin_up attribute name (as per
      the internals change), and adds “-I” as a short option for
      “--iallocator” in gnt-instance, gnt-backup and burnin.
      Reviewed-by: ultrotter
  18. 21 Nov, 2008 1 commit
  19. 17 Nov, 2008 1 commit
    • Iustin Pop's avatar
      More updates to the documentation · 6c2d0b44
      Iustin Pop authored
      This patch removes the client-api.txt document (since it's obsoleted by
      the documentation inside the design-2.0.rst document) and adds many
      updates to the latter.
      Reviewed-by: imsnah
  20. 16 Nov, 2008 2 commits
    • Iustin Pop's avatar
      Add a cluster architecture diagram · f86e82ef
      Iustin Pop authored
      This adds a simple diagram for the cluster architecture and also adds a
      dependency on graphviz (both doc and in configure).
      Reviewed-by: imsnah
    • Iustin Pop's avatar
      Combine the 2.0 design documents into one · 5c0c1eeb
      Iustin Pop authored
      This patch combines all the design documents for 2.0 except the
      security one into a single document, in order to ease reading and reduce
      duplication of information.
      Future patches will start removing wrong pointers to old document names
      and some better integration between the sections.
      Reviewed-by: imsnah
  21. 24 Oct, 2008 1 commit
    • Guido Trotter's avatar
      design-2.0-os-interface: update import/export · ef79eb82
      Guido Trotter authored
      In the end we ended up taking a slightly different approach for
      import/export than the one discussed in the design doc, after
      trying/talking about a few more alternatives. Document this in the
      Reviewed-by: iustinp
  22. 21 Oct, 2008 1 commit
    • Iustin Pop's avatar
      Fix whitespace-at-EOL · 16653425
      Iustin Pop authored
      Please configure your editors to strip it, or enable your git hooks...
      Reviewed-by: ultrotter
  23. 16 Oct, 2008 3 commits
    • Guido Trotter's avatar
      design-2.0-cluster-parameters: escape final _ · c5e2d3b9
      Guido Trotter authored
      In rst a final _ is used for linking. Escaping it prevents an error at
      compile time on design-2.0-cluster-parameters.rst
      Reviewed-by: iustinp
    • Guido Trotter's avatar
      OS Design: invert new and old name · 29fc6636
      Guido Trotter authored
      Internally in ganeti we already have renamed the instance, so it's
      better to pass the new name in INSTANCE_NAME and the old one in
      OLD_INSTANCE_NAME rather than the old name in INSTANCE_NAME and the new
      one in NEW_INSTANCE_NAME as this reflects what the cluster thinks.
      Reviewed-by: iustinp
    • René Nussbaumer's avatar
      Provide example for backend parameters · 10799c59
      René Nussbaumer authored
      Update the design about cluster parameters and provide
      some example of backend parameters. By now this includes
      all supported parameters.
      Reviewed-by: iustinp, ultrotter
  24. 13 Oct, 2008 2 commits
  25. 10 Oct, 2008 2 commits
  26. 08 Oct, 2008 2 commits