Changes between Version 8 and Version 9 of WikiStart


Ignore:
Timestamp:
06/23/17 14:29:54 (18 months ago)
Author:
dennis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v8 v9  
    22
    33= CMT -- Config Management Tool =
    4 {{{
    5 #!NewsFlash
    6 = May 3rd, 2016: Version 2.0 released =
    7 PIP package:
    8 * client
    9  * ftp://ftp.surfsara.nl/pub/outgoing/CMT/latest/cmt-client-2.0.4.tar.gz
    104
    11 * server
    12  * ftp://ftp.surfsara.nl/pub/outgoing/CMT/latest/cmt-server-2.0.0.tar.gz
    13 }}}
     5'''Currenlty we are migrating our project to gitlab: https://gitlab.com/surfsara/cmt'''
    146
    157CMT is a Config Management Tool originally created at SARA Computing and Networking Services, which is based in Amsterdam and known as SURFsara nowadays. It once started as a single script, went through some reincarnations, and now it consists of a Django-powered backend on the server-side, and a CLI for the client-side.
     
    3123 * Build an API to make it easier to integrate CMT in other software/scripts
    3224
    33 == Requirements ==
    34 
    35 === Python/PIP packages ===
    36 
    37 ==== CMT client ====
    38 
    39  * pip
    40 
    41 ==== CMT server ====
    42 
    43 In addition, the CMT server also requires:
    44 
    45  * Python>=2.6
    46  * Django>=1.5
    47  * IPy>=0.75
    48  * django-extensions>=0.4
    49  * django-tagging>=0.3.1
    50  * psycopg2>=2.4.4
    51  * django-auth-ldap
    52  * south
    53 
    54 === System packages ===
    55  * header files and a static library for Python
    56    * i.e.: libpython/python-libs + python-dev
    57  * header files for libpq (PostgreSQL library)
    58    * i.e.: libpq + libpq-dev
    59 
    60 = Installation, configuration & usage =
    61 Documentation of CMT is divided into several pages.
    62 
    63 
    64 == Client ==
    65  [wiki:Usage2/Quickstart Quickstart]:: This will give you a quick introduction on how to prepare your environment, and get started with the CMT client.
    66 
    67  [wiki:Usage2/UserDocumentation User documentation]:: Further details about how to use CMT as a user. This describes how to manage the information you store in CMT, and how to do this by using the interfaces it has.
    68 
    69  [wiki:Usage/TemplatingDocumentation Templating documentation]:: How to utilize CMT's templating engine to generate (config) files
    70 
    71  [wiki:Data/Datastructure Datastructure documentation]:: More about CMT's datastructure. This can be handy information when writing your templates.
    72 
    73 
    74 == Server ==
    75 Documentation about the central CMT server can be found here. This is meant for administrators of the central CMT server only. Users of CMT should skip this, and continue at the client documentation in the next subsection.
    76 
    77  [wiki:Server/Setup Setup Server]:: How to get the central CMT server up and running.
    78 
    79 
    80 = Source code =
    81 Currently the Subversion repository is only kept for historical purposes. All development now occurs in GIT.
    82 
    83 == Access repository ==
    84 
    85  * [https://github.com/basvandervlies/cmt]
    86 
    87 == Tarballs ==
    88 Of each release a source tarball is available on:
    89 
    90  * ftp://ftp.surfsara.nl/pub/outgoing/CMT
    91  * named: CMT-<version>.src.tar.bz2
    92 
    93 Please note: the easiest way to install is using the PIP package (as described [Usage/Quickstart here]) and the source should only be needed for development purposes
    94 
    95 = Development =
    96 == Branching ==
    97 We are working with 4 kinds of branches:
    98 
    99  * master branch, called `master`.
    100  * stable branches, called `stable/<version>` (where versions consist of 2 digits like `1.0`, `1.1`, `2.0`, etc.). Those stable branches are tagged whenever bugfixes are done for a bugfix-release. Those bugfix-releases (for example as for `stable/1.0`) are tagged as `stable/<version>.<patchlevel>`, where the patchlevel is an integer that increments for each (couple of) merged bugfix(es). Stable branches are branched from master, and merged back to master whenever it's tagged as a new bugfix-release.
    101  * bugfix branches, in which we have a branch for each bugfix to patch, branched from a stable branch. These branches can be locally. The branches are called `bugfix/#]/human_readable_label]` where the hash-symbol is a number referring to the ticket of the bug-report, and the `human_readable_label` an optional label to know what it's about (without knowledge of the tickets).
    102  * feature branches, in which we have a branch for each new feature, branched from master. These branches can be locally, however can be public for collaboration-purposes as well. As a naming-convention we'll call these branches `feature/#[/human_readable_label]`, where the hash-symbol is a number referring to the ticket for the feature, and the `human_readable_label` an optional label to know what it's about (without knowledge of the tickets).
    103 
    104 == Versioning ==
    105 So, we're using 2 or 3 numbers for versions, like `x.y[.z]`:
    106 
    107  * `x` - major version number, only incremented when changes have been introduced that aren't compatible with earlier versions.
    108  * `y` - minor version number, incremented when changes have been done for new features that are compatible with earlier versions.
    109  * `z` - patchlevel, introduced when the first bugfix has been done on a stable branch, and incremented at each new bugfix-release.
    110 
    111 == Release checklist ==
    112  * [wiki:Development2/ReleaseChecklist Release checklist]
    113 
    114 = Contact =
    115 Existing bugs and feature requests for CMT can be found in our [/report/1 overview of active tickets]. If you have any issues with CMT, which aren't listed as a ticket yet, please [/newticket create a new ticket] or [mailto:cmt@sara.nl send us an email] about it.
    116 
    117 == Mailing lists ==
    118  * https://lists.surfsara.nl/listinfo/cmt-users -- Anouncement and discussion list -- low volume
    119  * https://lists.surfsara.nl/listinfo/cmt-dev -- Development and tickets list -- mid/high volume