/usr/share/doc/cdist/html/cdist-update.html is in cdist-doc 4.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>5. How to update cdist — cdist 4.4.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="cdist 4.4.1 documentation" href="index.html"/>
<link rel="next" title="6. Support" href="cdist-support.html"/>
<link rel="prev" title="4. How to install cdist" href="cdist-install.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> cdist
</a>
<div class="version">
4.4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="cdist-intro.html">1. cdist - usable configuration management</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-why.html">2. Why should I use cdist?</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-os.html">3. Supported Operating Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-install.html">4. How to install cdist</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. How to update cdist</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#update-the-git-installation">5.1. Update the git installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#safely-upgrading-to-new-versions">5.1.1. Safely upgrading to new versions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#update-the-python-package">5.2. Update the python package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#general-update-instructions">5.3. General update instructions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-3-0-to-3-1">5.3.1. Updating from 3.0 to 3.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-2-3-to-3-0">5.3.2. Updating from 2.3 to 3.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-2-2-to-2-3">5.3.3. Updating from 2.2 to 2.3</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-2-1-to-2-2">5.3.4. Updating from 2.1 to 2.2</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-2-0-to-2-1">5.3.5. Updating from 2.0 to 2.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-7-to-2-0">5.3.6. Updating from 1.7 to 2.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-6-to-1-7">5.3.7. Updating from 1.6 to 1.7</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-5-to-1-6">5.3.8. Updating from 1.5 to 1.6</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-3-to-1-5">5.3.9. Updating from 1.3 to 1.5</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-2-to-1-3">5.3.10. Updating from 1.2 to 1.3</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-1-to-1-2">5.3.11. Updating from 1.1 to 1.2</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating-from-1-0-to-1-1">5.3.12. Updating from 1.0 to 1.1</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cdist-support.html">6. Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-features.html">7. Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-quickstart.html">8. Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="man1/cdist.html">9. cdist(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">10. Bootstrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">11. Manifest</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">12. cdist type</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">13. cdist types</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">14. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">15. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">16. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">17. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">18. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">19. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">20. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">21. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">22. Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">cdist</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>5. How to update cdist</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cdist-update.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="how-to-update-cdist">
<h1>5. How to update cdist<a class="headerlink" href="#how-to-update-cdist" title="Permalink to this headline">¶</a></h1>
<div class="section" id="update-the-git-installation">
<h2>5.1. Update the git installation<a class="headerlink" href="#update-the-git-installation" title="Permalink to this headline">¶</a></h2>
<p>To upgrade cdist in the current branch use</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>git pull
<span class="c1"># Also update the manpages</span>
./build man
<span class="nb">export</span> <span class="nv">MANPATH</span><span class="o">=</span><span class="nv">$MANPATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/doc/man
</pre></div>
</div>
<p>If you stay on a version branche (i.e. 1.0, 1.1., ...), nothing should break.
The master branch on the other hand is the development branch and may not be
working, break your setup or eat the tree in your garden.</p>
<div class="section" id="safely-upgrading-to-new-versions">
<h3>5.1.1. Safely upgrading to new versions<a class="headerlink" href="#safely-upgrading-to-new-versions" title="Permalink to this headline">¶</a></h3>
<p>To upgrade to <strong>any</strong> further cdist version, you can take the
following procedure to do a safe upgrade:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Create new branch to try out the update</span>
git checkout -b upgrade_cdist
<span class="c1"># Get latest cdist version in git database</span>
git fetch -v
<span class="c1"># see what will happen on merge - replace</span>
<span class="c1"># master with the branch you plan to merge</span>
git diff upgrade_cdist..origin/master
<span class="c1"># Merge the new version</span>
git merge origin/master
</pre></div>
</div>
<p>Now you can ensure all custom types work with the new version.
Assume that you need to go back to an older version during
the migration/update, you can do so as follows:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># commit changes</span>
git commit -m ...
<span class="c1"># go back to original branch</span>
git checkout master
</pre></div>
</div>
<p>After that, you can go back and continue the upgrade:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># git checkout upgrade_cdist</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="update-the-python-package">
<h2>5.2. Update the python package<a class="headerlink" href="#update-the-python-package" title="Permalink to this headline">¶</a></h2>
<p>To upgrade to the lastet version do</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>pip install --upgrade cdist
</pre></div>
</div>
</div>
<div class="section" id="general-update-instructions">
<h2>5.3. General update instructions<a class="headerlink" href="#general-update-instructions" title="Permalink to this headline">¶</a></h2>
<div class="section" id="updating-from-3-0-to-3-1">
<h3>5.3.1. Updating from 3.0 to 3.1<a class="headerlink" href="#updating-from-3-0-to-3-1" title="Permalink to this headline">¶</a></h3>
<p>The type <strong>__ssh_authorized_keys</strong> now also manages existing keys,
not only the ones added by cdist.</p>
</div>
<div class="section" id="updating-from-2-3-to-3-0">
<h3>5.3.2. Updating from 2.3 to 3.0<a class="headerlink" href="#updating-from-2-3-to-3-0" title="Permalink to this headline">¶</a></h3>
<p>The <strong>changed</strong> attribute of objects has been removed.
Use <a class="reference external" href="/software/cdist/man/3.0.0/man7/cdist-messaging.html">messaging</a> instead.</p>
</div>
<div class="section" id="updating-from-2-2-to-2-3">
<h3>5.3.3. Updating from 2.2 to 2.3<a class="headerlink" href="#updating-from-2-2-to-2-3" title="Permalink to this headline">¶</a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-2-1-to-2-2">
<h3>5.3.4. Updating from 2.1 to 2.2<a class="headerlink" href="#updating-from-2-1-to-2-2" title="Permalink to this headline">¶</a></h3>
<p>Starting with 2.2, the syntax for requiring a singleton type changed:
Old format:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">"__singleton_type/singleton"</span> ...
</pre></div>
</div>
<p>New format:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">"__singleton_type"</span> ...
</pre></div>
</div>
<p>Internally the "singleton" object id was dropped to make life more easy.
You can probably fix your configuration by running the following code
snippet (currently untested, please report back if it works for you):</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>find ~/.cdist/* -type f -exec sed -i <span class="s1">'s,/singleton,,'</span> <span class="o">{}</span> <span class="se">\;</span>
</pre></div>
</div>
</div>
<div class="section" id="updating-from-2-0-to-2-1">
<h3>5.3.5. Updating from 2.0 to 2.1<a class="headerlink" href="#updating-from-2-0-to-2-1" title="Permalink to this headline">¶</a></h3>
<p>Have a look at the update guide for [[2.0 to 2.1|2.0-to-2.1]].</p>
<blockquote>
<div><ul class="simple">
<li>Type <strong>__package* and __process</strong> use --state <strong>present</strong> or <strong>absent</strong>.
The states <strong>removed/installed</strong> and <strong>stopped/running</strong> have been removed.
Support for the new states is already present in 2.0.</li>
<li>Type <strong>__directory</strong>: Parameter --parents and --recursive are now boolean
The old "yes/no" values need to be removed.</li>
<li>Type <strong>__rvm_ruby</strong>: Parameter --default is now boolean
The old "yes/no" values need to be removed.</li>
<li>Type <strong>__rvm_gemset</strong>: Parameter --default is now boolean
The old "yes/no" values need to be removed.</li>
<li>Type <strong>__addifnosuchline</strong> and <strong>__removeline</strong> have been replaced by <strong>__line</strong></li>
<li>The <strong>conf</strong> directory is now located at <strong>cdist/conf</strong>.
You need to migrate your types, explorers and manifests
manually to the new location.</li>
<li>Replace the variable <strong>__self</strong> by <strong>__object_name</strong>
Support for the variable <strong>__object_name</strong> is already present in 2.0.</li>
<li>The types <strong>__autofs</strong>, <strong>__autofs_map</strong> and <strong>__autofs_reload</strong> have been removed
(no maintainer, no users)</li>
<li>Type <strong>__user</strong>: Parameter --groups removed (use the new __user_groups type)</li>
<li><dl class="first docutils">
<dt>Type <strong>__ssh_authorized_key</strong> has been replaced by more flexible type</dt>
<dd><strong>__ssh_authorized_keys</strong></dd>
</dl>
</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="updating-from-1-7-to-2-0">
<h3>5.3.6. Updating from 1.7 to 2.0<a class="headerlink" href="#updating-from-1-7-to-2-0" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Ensure python (>= 3.2) is installed on the source host</li>
<li>Use "cdist config host" instead of "cdist-deploy-to host"</li>
<li>Use "cdist config -p host1 host2" instead of "cdist-mass-deploy"</li>
<li>Use "cdist banner" for fun</li>
<li>Use <strong>__object_name</strong> instead of <strong>__self</strong> in manifests</li>
</ul>
</div>
<div class="section" id="updating-from-1-6-to-1-7">
<h3>5.3.7. Updating from 1.6 to 1.7<a class="headerlink" href="#updating-from-1-6-to-1-7" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>If you used the global explorer <strong>hardware_type</strong>, you need to change
your code to use <strong>machine</strong> instead.</li>
</ul>
</div>
<div class="section" id="updating-from-1-5-to-1-6">
<h3>5.3.8. Updating from 1.5 to 1.6<a class="headerlink" href="#updating-from-1-5-to-1-6" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>If you used <strong>__package_apt --preseed</strong>, you need to use the new
type <strong>__debconf_set_selections</strong> instead.</li>
<li>The <strong>__package</strong> types accepted either --state deinstalled or
--state uninstaaled. Starting with 1.6, it was made consistently
to --state removed.</li>
</ul>
</div>
<div class="section" id="updating-from-1-3-to-1-5">
<h3>5.3.9. Updating from 1.3 to 1.5<a class="headerlink" href="#updating-from-1-3-to-1-5" title="Permalink to this headline">¶</a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-1-2-to-1-3">
<h3>5.3.10. Updating from 1.2 to 1.3<a class="headerlink" href="#updating-from-1-2-to-1-3" title="Permalink to this headline">¶</a></h3>
<p>Rename <strong>gencode</strong> of every type to <strong>gencode-remote</strong>.</p>
</div>
<div class="section" id="updating-from-1-1-to-1-2">
<h3>5.3.11. Updating from 1.1 to 1.2<a class="headerlink" href="#updating-from-1-1-to-1-2" title="Permalink to this headline">¶</a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-1-0-to-1-1">
<h3>5.3.12. Updating from 1.0 to 1.1<a class="headerlink" href="#updating-from-1-0-to-1-1" title="Permalink to this headline">¶</a></h3>
<p>In 1.1 the type <strong>__file</strong> was split into <strong>__directory</strong>, <strong>__file</strong> and
<strong>__link</strong>. The parameter <strong>--type</strong> was removed from <strong>__file</strong>. Thus you
need to replace <strong>__file</strong> calls in your manifests:</p>
<blockquote>
<div><ul class="simple">
<li>Remove --type from all __file calls</li>
<li>If type was symlink, use __link and --type symbolic</li>
<li>If type was directory, use __directory</li>
</ul>
</div></blockquote>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdist-support.html" class="btn btn-neutral float-right" title="6. Support" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cdist-install.html" class="btn btn-neutral" title="4. How to install cdist" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'4.4.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|