186 lines
9.3 KiB
HTML
186 lines
9.3 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<title>Khéops documentation — Khéops 0.1 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="Application" href="docs/app/index.html" />
|
|
|
|
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
</head><body>
|
|
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
<a class="reference external image-reference" href="https://amoffat.github.com/sh"><img alt="Logo" src="_images/kheops_brand.png" /></a>
|
|
<section id="kheops-documentation">
|
|
<h1><a class="toc-backref" href="#id1">Khéops documentation</a><a class="headerlink" href="#kheops-documentation" title="Permalink to this headline">¶</a></h1>
|
|
<div class="contents topic" id="table-of-contents">
|
|
<p class="topic-title">Table of Contents</p>
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="#kheops-documentation" id="id1">Khéops documentation</a></p></li>
|
|
<li><p><a class="reference internal" href="#content" id="id2">Content</a></p></li>
|
|
<li><p><a class="reference internal" href="#indices-and-tables" id="id3">Indices and tables</a></p></li>
|
|
</ul>
|
|
</div>
|
|
<p>Welcome in Khéops documentation.</p>
|
|
<p>Khéops is a tool that can be used to lookup a key value pair, that is to say, given a key it will give back the appropriate value. This is certainly nothing special or new, but the crucial difference here is the way in which the data is looked up. Rather than just querying a flat data source and returning the value for a requested key, when doing a hierarchical lookup we perform multiple queries against a configured hierarchy, transcending down to the next layer in the hierarchy until we find an answer. The end result is that we can define key value pairs on a global basis but then override them under certain conditions based on the hierarchical resolution by placing that key value pair further up the hierarchy for a particular condition.</p>
|
|
</section>
|
|
<section id="content">
|
|
<h1><a class="toc-backref" href="#id2">Content</a><a class="headerlink" href="#content" title="Permalink to this headline">¶</a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/app/index.html">Application</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/installation.html">Instalation procedure</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/usage.html">usage !!!</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/cli.html">CLI</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/config.html">Config</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/examples.html">Examples …</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/app/internal.html">Internals</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/learn/index.html">Learn</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="learn/learn101.html">Khéops 101</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#command-line">Command line</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#defining-a-hierarchy">Defining a hierarchy</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#basic-hierarchy">Basic hierarchy</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#roles">Roles</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#per-node-override">Per node override</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#environment-override">Environment override</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#tooling-and-applications">Tooling and applications</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="learn/learn101.html#troubleshooting">Troubleshooting</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/learn/100.html">Introduction</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="docs/learn/100.html#concept">Concept</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="docs/learn/100.html#hierarchical-lookups">Hierarchical Lookups</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="docs/learn/100.html#applying-this-to-infrastructure-management">Applying this to infrastructure management</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/learn/101.html">Learn 101</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/learn/102.html">Learn 102</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/learn/105.html">Learn 105</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/guide/index.html">Guides</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/guide/best_practices.html">Learn 104</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="docs/guide/ansible/index.html">Ansible</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">Python API</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="api/kheops.html">kheops package</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#subpackages">Subpackages</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#module-kheops.app">kheops.app module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#module-kheops.cli">kheops.cli module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#module-kheops.controllers">kheops.controllers module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kheops.html#module-kheops.utils">kheops.utils module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="indices-and-tables">
|
|
<h1><a class="toc-backref" href="#id3">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
|
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
|
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h1 class="logo"><a href="#">Khéops</a></h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/app/index.html">Application</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/learn/index.html">Learn</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="docs/guide/index.html">Guides</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">Python API</a></li>
|
|
</ul>
|
|
|
|
<div class="relations">
|
|
<h3>Related Topics</h3>
|
|
<ul>
|
|
<li><a href="#">Documentation overview</a><ul>
|
|
<li>Next: <a href="docs/app/index.html" title="next chapter">Application</a></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2022, Barbu IT.
|
|
|
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
|
|
|
|
|
<a href="_sources/index.rst.txt"
|
|
rel="nofollow">Page source</a>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |