812 lines
No EOL
42 KiB
HTML
812 lines
No EOL
42 KiB
HTML
|
|
|
|
<!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>9. Dive into real world cdist — cdist 4.10.7 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="10. cdist(1)" href="man1/cdist.html" />
|
|
<link rel="prev" title="8. Quickstart" href="cdist-quickstart.html" />
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<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.10.7
|
|
</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"><a class="reference internal" href="cdist-update.html">5. How to update cdist</a></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 current"><a class="current reference internal" href="#">9. Dive into real world cdist</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#introduction">9.1. Introduction</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-type-layout">9.2. Creating type layout</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-sample-bottle-hosting-type-parameters">9.3. Creating __sample_bottle_hosting type parameters</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-sample-bottle-hosting-type-manifest">9.4. Creating __sample_bottle_hosting type manifest</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#creating-user-and-user-directories">9.4.1. Creating user and user directories</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#installing-packages">9.4.2. Installing packages</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#creating-postgresql-database">9.4.3. Creating PostgreSQL database</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#configuring-uwsgi">9.4.4. Configuring uWSGI</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#configuring-nginx-for-let-s-encrypt-and-https-redirection">9.4.5. Configuring nginx for Let's Encrypt and HTTPS redirection</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#configuring-certificate-creation">9.4.6. Configuring certificate creation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#configuring-nginx-https-server-with-uwsgi-upstream">9.4.7. Configuring nginx HTTPS server with uWSGI upstream</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#complete-sample-bottle-hosting-type-manifest-listing">9.4.8. Complete __sample_bottle_hosting type manifest listing</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-sample-bottle-hosting-type-gencode-remote">9.5. Creating __sample_bottle_hosting type gencode-remote</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type">9.6. Creating __sample_nginx_http_letsencrypt_and_ssl_redirect type</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-init-manifest">9.7. Creating init manifest</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#configuring-host">9.8. Configuring host</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-python-bottle-application">9.9. Creating python bottle application</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#preparing-database">9.9.1. Preparing database</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#creating-application">9.9.2. Creating application</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#openning-application">9.9.3. Openning application</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#what-s-next">9.10. What's next?</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="man1/cdist.html">10. cdist(1)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">11. Bootstrap</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-configuration.html">12. Configuration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">13. Manifest</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">14. cdist type</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">15. cdist types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">16. Explorer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">17. Messaging</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">18. Parallelization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">19. Inventory</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">20. cdist integration / using cdist as library</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">21. Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">22. Best practice</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">23. Execution stages</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">24. Local cache overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">25. Saving output streams</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">26. Remote exec and copy commands</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">27. Hacking</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">28. Troubleshooting</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" 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>9. Dive into real world cdist</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/cdist-real-world.rst.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="dive-into-real-world-cdist">
|
|
<h1>9. Dive into real world cdist<a class="headerlink" href="#dive-into-real-world-cdist" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="introduction">
|
|
<h2>9.1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
|
|
<p>This walkthrough shows real world cdist configuration example.</p>
|
|
<p>Sample target host is named <strong>test.ungleich.ch</strong>.
|
|
Just replace <strong>test.ungleich.ch</strong> with your target hostname.</p>
|
|
<p>Our goal is to configure python application hosting. For writing sample
|
|
application we will use <a class="reference external" href="http://bottlepy.org">Bottle</a> WSGI micro web-framework.
|
|
It will use PostgreSQL database and it will list items from <strong>items</strong> table.
|
|
It will be served by uWSGI server. We will also use the Nginx web server
|
|
as a reverse proxy and we want HTTPS.
|
|
For HTTPS we will use Let's Encrypt certificate.</p>
|
|
<p>For setting up hosting we want to use cdist so we will write a new type
|
|
for that. This type will:</p>
|
|
<ul class="simple">
|
|
<li>install required packages</li>
|
|
<li>create OS user, user home directory and application home directory</li>
|
|
<li>create PostgreSQL database</li>
|
|
<li>configure uWSGI</li>
|
|
<li>configure Let's Encrypt certificate</li>
|
|
<li>configure nginx.</li>
|
|
</ul>
|
|
<p>Our type will not create the actual python application. Its intention is only
|
|
to configure hosing for specified user and project. It is up to the user to
|
|
create his/her applications.</p>
|
|
<p>So let's start.</p>
|
|
</div>
|
|
<div class="section" id="creating-type-layout">
|
|
<h2>9.2. Creating type layout<a class="headerlink" href="#creating-type-layout" title="Permalink to this headline">¶</a></h2>
|
|
<p>We will create a new custom type. Let's call it <strong>__sample_bottle_hosting</strong>.</p>
|
|
<p>Go to <strong>~/.cdist/type</strong> directory (create it if it does not exist) and create
|
|
new type layout:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
|
|
<span class="n">mkdir</span> <span class="n">__sample_bottle_hosting</span>
|
|
<span class="n">cd</span> <span class="n">__sample_bottle_hosting</span>
|
|
<span class="n">touch</span> <span class="n">manifest</span> <span class="n">gencode</span><span class="o">-</span><span class="n">remote</span>
|
|
<span class="n">mkdir</span> <span class="n">parameter</span>
|
|
<span class="n">touch</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-sample-bottle-hosting-type-parameters">
|
|
<h2>9.3. Creating __sample_bottle_hosting type parameters<a class="headerlink" href="#creating-sample-bottle-hosting-type-parameters" title="Permalink to this headline">¶</a></h2>
|
|
<p>Our type will be configurable through the means of parameters. Let's define
|
|
the following parameters:</p>
|
|
<dl class="docutils">
|
|
<dt>projectname</dt>
|
|
<dd>name for the project, needed for uWSGI ini file</dd>
|
|
<dt>user</dt>
|
|
<dd>user name</dd>
|
|
<dt>domain</dt>
|
|
<dd>target host domain, needed for Let's Encrypt certificate.</dd>
|
|
</dl>
|
|
<p>We define parameters to make our type reusable for different projects, user and domain.</p>
|
|
<p>Define required parameters:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">printf</span> <span class="s2">"projectname</span><span class="se">\n</span><span class="s2">"</span> <span class="o">>></span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
|
|
<span class="n">printf</span> <span class="s2">"user</span><span class="se">\n</span><span class="s2">"</span> <span class="o">>></span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
|
|
<span class="n">printf</span> <span class="s2">"domain</span><span class="se">\n</span><span class="s2">"</span> <span class="o">>></span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>For details on type parameters see <a class="reference external" href="cdist-type.html#defining-parameters">Defining parameters</a>.</p>
|
|
</div>
|
|
<div class="section" id="creating-sample-bottle-hosting-type-manifest">
|
|
<h2>9.4. Creating __sample_bottle_hosting type manifest<a class="headerlink" href="#creating-sample-bottle-hosting-type-manifest" title="Permalink to this headline">¶</a></h2>
|
|
<p>Next step is to define manifest (~/.cdist/type/__sample_bottle_hosting/manifest).
|
|
We also want our type to currently support only Devuan. So we will start by
|
|
checking target host OS. We will use <a class="reference external" href="cdist-reference.html#explorers">os</a>
|
|
global explorer:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>os=$(cat "$__global/explorer/os")
|
|
|
|
case "$os" in
|
|
devuan)
|
|
:
|
|
;;
|
|
*)
|
|
echo "OS $os currently not supported" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
</pre></div>
|
|
</div>
|
|
<p>If target host OS is not Devuan then we print error message to stderr
|
|
and exit. For other OS-es support we should check and change package names
|
|
we should install, because packages differ in different OS-es and in different
|
|
OS distributions like GNU/Linux distributions. There can also be a different
|
|
configuration locations (e.g. nginx config directory could be in /usr/local tree).
|
|
If we detected unsupported OS we should error out. cdist will stop configuration
|
|
process and output error message.</p>
|
|
<div class="section" id="creating-user-and-user-directories">
|
|
<h3>9.4.1. Creating user and user directories<a class="headerlink" href="#creating-user-and-user-directories" title="Permalink to this headline">¶</a></h3>
|
|
<p>Then we create user and his/her home directory and application home directory.
|
|
We will use existing cdist types <a class="reference external" href="man7/cdist-type__user.html">__user</a> and <a class="reference external" href="man7/cdist-type__directory.html">__directory</a>:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>user="$(cat "$__object/parameter/user")"
|
|
home="/home/$user"
|
|
apphome="$home/app"
|
|
|
|
# create user
|
|
__user "$user" --home "$home" --shell /bin/bash
|
|
# create user home dir
|
|
require="__user/$user" __directory "$home" \
|
|
--owner "$user" --group "$user" --mode 0755
|
|
# create app home dir
|
|
require="__user/$user __directory/$home" __directory "$apphome" \
|
|
--state present --owner "$user" --group "$user" --mode 0755
|
|
</pre></div>
|
|
</div>
|
|
<p>First we define <em>user</em>, <em>home</em> and <em>apphome</em> variables. User is defined by type's
|
|
<strong>user</strong> parameter. Here we use <strong>require</strong> which is cdist's way to define dependencies.
|
|
User home directory should be created <strong>after</strong> user is created. And application
|
|
home directory is created <strong>after</strong> both user and user home directory are created.
|
|
For details on <strong>require</strong> see <a class="reference external" href="cdist-manifest.html#dependencies">Dependencies</a>.</p>
|
|
</div>
|
|
<div class="section" id="installing-packages">
|
|
<h3>9.4.2. Installing packages<a class="headerlink" href="#installing-packages" title="Permalink to this headline">¶</a></h3>
|
|
<p>Install required packages using existing <a class="reference external" href="man7/cdist-type__package.html">__package</a> type.
|
|
Before installing package we want to update apt package index using
|
|
<a class="reference external" href="man7/cdist-type__apt_update_index.html">__apt_update_index</a>:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># define packages that need to be installed
|
|
packages_to_install="nginx uwsgi-plugin-python3 python3-dev python3-pip postgresql postgresql-contrib libpq-dev python3-venv uwsgi python3-psycopg2"
|
|
|
|
# update package index
|
|
__apt_update_index
|
|
# install packages
|
|
for package in $packages_to_install
|
|
do require="__apt_update_index" __package $package --state=present
|
|
done
|
|
</pre></div>
|
|
</div>
|
|
<p>Here we use shell for loop. It executes <strong>require="__apt_update_index" __package</strong>
|
|
for each member in a list we define in <strong>packages_to_install</strong> variable.
|
|
This is much nicer then having as many <strong>require="__apt_update_index" __package</strong>
|
|
lines as there are packages we want to install.</p>
|
|
<p>For python packages we use <a class="reference external" href="man7/cdist-type__package_pip.html">__package_pip</a>:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># install pip3 packages
|
|
for package in bottle bottle-pgsql; do
|
|
__package_pip --pip pip3 $package
|
|
done
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-postgresql-database">
|
|
<h3>9.4.3. Creating PostgreSQL database<a class="headerlink" href="#creating-postgresql-database" title="Permalink to this headline">¶</a></h3>
|
|
<p>Create PostgreSQL database using <a class="reference external" href="man7/cdist-type__postgres_database.html">__postgres_database</a>
|
|
and <a class="reference external" href="man7/cdist-type__postgres_role.html">__postgres_role</a> for creating database user:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>#PostgreSQL db & user
|
|
postgres_server=postgresql
|
|
|
|
# create PostgreSQL db user
|
|
require="__package/postgresql" __postgres_role $user --login --createdb
|
|
# create PostgreSQL db
|
|
require="__postgres_role/$user __package/postgresql" __postgres_database $user \
|
|
--owner $user
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="configuring-uwsgi">
|
|
<h3>9.4.4. Configuring uWSGI<a class="headerlink" href="#configuring-uwsgi" title="Permalink to this headline">¶</a></h3>
|
|
<p>Configure uWSGI using <a class="reference external" href="man7/cdist-type__file.html">__file</a> type:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># configure uWSGI
|
|
projectname="$(cat "$__object/parameter/projectname")"
|
|
require="__package/uwsgi" __file /etc/uwsgi/apps-enabled/$user.ini \
|
|
--owner root --group root --mode 0644 \
|
|
--state present \
|
|
--source - << EOF
|
|
[uwsgi]
|
|
socket = $apphome/uwsgi.sock
|
|
chdir = $apphome
|
|
wsgi-file = $projectname/wsgi.py
|
|
touch-reload = $projectname/wsgi.py
|
|
processes = 4
|
|
threads = 2
|
|
chmod-socket = 666
|
|
daemonize=true
|
|
vacuum = true
|
|
uid = $user
|
|
gid = $user
|
|
EOF
|
|
</pre></div>
|
|
</div>
|
|
<p>We require package uWSGI present in order to create <strong>/etc/uwsgi/apps-enabled/$user.ini</strong> file.
|
|
Installation of uWSGI also creates configuration layout: <strong>/etc/uwsgi/apps-enabled</strong>.
|
|
If this directory does not exist then <strong>__file</strong> type would error.
|
|
We also use stdin as file content source. For details see <a class="reference external" href="cdist-type.html#input-from-stdin">Input from stdin</a>.
|
|
For feading stdin we use here-document (<strong><<</strong> operator). It allows redirection of subsequent
|
|
lines read by the shell to the input of a command until a line containing only the delimiter
|
|
and a newline, with no blank characters in between (EOF in our case).</p>
|
|
</div>
|
|
<div class="section" id="configuring-nginx-for-let-s-encrypt-and-https-redirection">
|
|
<h3>9.4.5. Configuring nginx for Let's Encrypt and HTTPS redirection<a class="headerlink" href="#configuring-nginx-for-let-s-encrypt-and-https-redirection" title="Permalink to this headline">¶</a></h3>
|
|
<p>Next configure nginx for Let's Encrypt and for HTTP -> HTTPS redirection. For this
|
|
purpose we will create new type <strong>__sample_nginx_http_letsencrypt_and_ssl_redirect</strong>
|
|
and use it here:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>domain="$(cat "$__object/parameter/domain")"
|
|
webroot="/var/www/html"
|
|
__sample_nginx_http_letsencrypt_and_ssl_redirect "$domain" --webroot "$webroot"
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="configuring-certificate-creation">
|
|
<h3>9.4.6. Configuring certificate creation<a class="headerlink" href="#configuring-certificate-creation" title="Permalink to this headline">¶</a></h3>
|
|
<p>After HTTP nginx configuration we will create Let's Encrypt certificate using
|
|
<a class="reference external" href="man7/cdist-type__letsencrypt_cert.html">__letsencrypt_cert</a> type.
|
|
For Let's Encrypt cert configuration ensure that there is a DNS entry for your
|
|
domain. We assure that cert creation is applied after nginx HTTP is configured
|
|
for Let's Encrypt to work:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create SSL cert</span>
|
|
<span class="n">require</span><span class="o">=</span><span class="s2">"__package/nginx __sample_nginx_http_letsencrypt_and_ssl_redirect/$domain"</span> \
|
|
<span class="n">__letsencrypt_cert</span> <span class="o">--</span><span class="n">admin</span><span class="o">-</span><span class="n">email</span> <span class="n">admin</span><span class="nd">@test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span> \
|
|
<span class="o">--</span><span class="n">webroot</span> <span class="s2">"$webroot"</span> \
|
|
<span class="o">--</span><span class="n">automatic</span><span class="o">-</span><span class="n">renewal</span> \
|
|
<span class="o">--</span><span class="n">renew</span><span class="o">-</span><span class="n">hook</span> <span class="s2">"service nginx reload"</span> \
|
|
<span class="o">--</span><span class="n">domain</span> <span class="s2">"$domain"</span> \
|
|
<span class="s2">"$domain"</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="configuring-nginx-https-server-with-uwsgi-upstream">
|
|
<h3>9.4.7. Configuring nginx HTTPS server with uWSGI upstream<a class="headerlink" href="#configuring-nginx-https-server-with-uwsgi-upstream" title="Permalink to this headline">¶</a></h3>
|
|
<p>Then we can configure nginx HTTPS server that will use created Let's Encrypt certificate:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># configure nginx
|
|
require="__package/nginx __letsencrypt_cert/$domain" \
|
|
__file "/etc/nginx/sites-enabled/https-$domain" \
|
|
--source - --mode 0644 << EOF
|
|
upstream _bottle {
|
|
server unix:$apphome/uwsgi.sock;
|
|
}
|
|
|
|
server {
|
|
listen 443;
|
|
listen [::]:443;
|
|
|
|
server_name $domain;
|
|
|
|
access_log /var/log/nginx/access.log;
|
|
|
|
ssl on;
|
|
ssl_certificate /etc/letsencrypt/live/$domain/fullchain.pem;
|
|
ssl_certificate_key /etc/letsencrypt/live/$domain/privkey.pem;
|
|
|
|
client_max_body_size 256m;
|
|
|
|
location / {
|
|
try_files \$uri @uwsgi;
|
|
}
|
|
|
|
location @uwsgi {
|
|
include uwsgi_params;
|
|
uwsgi_pass _bottle;
|
|
}
|
|
}
|
|
EOF
|
|
</pre></div>
|
|
</div>
|
|
<p>Now our manifest is finished.</p>
|
|
</div>
|
|
<div class="section" id="complete-sample-bottle-hosting-type-manifest-listing">
|
|
<h3>9.4.8. Complete __sample_bottle_hosting type manifest listing<a class="headerlink" href="#complete-sample-bottle-hosting-type-manifest-listing" title="Permalink to this headline">¶</a></h3>
|
|
<p>Here is complete __sample_bottle_hosting type manifest listing,
|
|
located in ~/.cdist/type/__sample_bottle_hosting/manifest:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>#!/bin/sh
|
|
|
|
os=$(cat "$__global/explorer/os")
|
|
|
|
case "$os" in
|
|
devuan)
|
|
:
|
|
;;
|
|
*)
|
|
echo "OS $os currently not supported" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
projectname="$(cat "$__object/parameter/projectname")"
|
|
user="$(cat "$__object/parameter/user")"
|
|
home="/home/$user"
|
|
apphome="$home/app"
|
|
domain="$(cat "$__object/parameter/domain")"
|
|
|
|
# create user
|
|
__user "$user" --home "$home" --shell /bin/bash
|
|
# create user home dir
|
|
require="__user/$user" __directory "$home" \
|
|
--owner "$user" --group "$user" --mode 0755
|
|
# create app home dir
|
|
require="__user/$user __directory/$home" __directory "$apphome" \
|
|
--state present --owner "$user" --group "$user" --mode 0755
|
|
|
|
# define packages that need to be installed
|
|
packages_to_install="nginx uwsgi-plugin-python3 python3-dev python3-pip postgresql postgresql-contrib libpq-dev python3-venv uwsgi python3-psycopg2"
|
|
|
|
# update package index
|
|
__apt_update_index
|
|
# install packages
|
|
for package in $packages_to_install
|
|
do require="__apt_update_index" __package $package --state=present
|
|
done
|
|
# install pip3 packages
|
|
for package in bottle bottle-pgsql; do
|
|
__package_pip --pip pip3 $package
|
|
done
|
|
|
|
#PostgreSQL db & user
|
|
postgres_server=postgresql
|
|
|
|
# create PostgreSQL db user
|
|
require="__package/postgresql" __postgres_role $user --login --createdb
|
|
# create PostgreSQL db
|
|
require="__postgres_role/$user __package/postgresql" __postgres_database $user \
|
|
--owner $user
|
|
# configure uWSGI
|
|
require="__package/uwsgi" __file /etc/uwsgi/apps-enabled/$user.ini \
|
|
--owner root --group root --mode 0644 \
|
|
--state present \
|
|
--source - << EOF
|
|
[uwsgi]
|
|
socket = $apphome/uwsgi.sock
|
|
chdir = $apphome
|
|
wsgi-file = $projectname/wsgi.py
|
|
touch-reload = $projectname/wsgi.py
|
|
processes = 4
|
|
threads = 2
|
|
chmod-socket = 666
|
|
daemonize=true
|
|
vacuum = true
|
|
uid = $user
|
|
gid = $user
|
|
EOF
|
|
|
|
# setup nginx HTTP for Let's Encrypt and SSL redirect
|
|
domain="$(cat "$__object/parameter/domain")"
|
|
webroot="/var/www/html"
|
|
__sample_nginx_http_letsencrypt_and_ssl_redirect "$domain" --webroot "$webroot"
|
|
|
|
# create SSL cert
|
|
require="__package/nginx __sample_nginx_http_letsencrypt_and_ssl_redirect/$domain" \
|
|
__letsencrypt_cert --admin-email admin@test.ungleich.ch \
|
|
--webroot "$webroot" \
|
|
--automatic-renewal \
|
|
--renew-hook "service nginx reload" \
|
|
--domain "$domain" \
|
|
"$domain"
|
|
|
|
# configure nginx
|
|
require="__package/nginx __letsencrypt_cert/$domain" \
|
|
__file "/etc/nginx/sites-enabled/https-$domain" \
|
|
--source - --mode 0644 << EOF
|
|
upstream _bottle {
|
|
server unix:$apphome/uwsgi.sock;
|
|
}
|
|
|
|
server {
|
|
listen 443;
|
|
listen [::]:443;
|
|
|
|
server_name $domain;
|
|
|
|
access_log /var/log/nginx/access.log;
|
|
|
|
ssl on;
|
|
ssl_certificate /etc/letsencrypt/live/$domain/fullchain.pem;
|
|
ssl_certificate_key /etc/letsencrypt/live/$domain/privkey.pem;
|
|
|
|
client_max_body_size 256m;
|
|
|
|
location / {
|
|
try_files \$uri @uwsgi;
|
|
}
|
|
|
|
location @uwsgi {
|
|
include uwsgi_params;
|
|
uwsgi_pass _bottle;
|
|
}
|
|
}
|
|
EOF
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-sample-bottle-hosting-type-gencode-remote">
|
|
<h2>9.5. Creating __sample_bottle_hosting type gencode-remote<a class="headerlink" href="#creating-sample-bottle-hosting-type-gencode-remote" title="Permalink to this headline">¶</a></h2>
|
|
<p>Now define <strong>gencode-remote</strong> script: ~/.cdist/type/__sample_bottle_hosting/gencode-remote.
|
|
After manifest is applied it should restart uWSGI and nginx services so that our
|
|
configuration is active. Our gencode-remote looks like the following:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">"service uwsgi restart"</span>
|
|
<span class="n">echo</span> <span class="s2">"service nginx restart"</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Our <strong>__sample_bottle_hosting</strong> type is now finished.</p>
|
|
</div>
|
|
<div class="section" id="creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type">
|
|
<h2>9.6. Creating __sample_nginx_http_letsencrypt_and_ssl_redirect type<a class="headerlink" href="#creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type" title="Permalink to this headline">¶</a></h2>
|
|
<p>Let's now create <strong>__sample_nginx_http_letsencrypt_and_ssl_redirect</strong> type:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
|
|
<span class="n">mkdir</span> <span class="n">__sample_nginx_http_letsencrypt_and_ssl_redirect</span>
|
|
<span class="n">cd</span> <span class="n">__sample_nginx_http_letsencrypt_and_ssl_redirect</span>
|
|
<span class="n">mkdir</span> <span class="n">parameter</span>
|
|
<span class="n">echo</span> <span class="n">webroot</span> <span class="o">></span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
|
|
<span class="n">touch</span> <span class="n">manifest</span>
|
|
<span class="n">touch</span> <span class="n">gencode</span><span class="o">-</span><span class="n">remote</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Edit manifest:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>domain="$__object_id"
|
|
webroot="$(cat "$__object/parameter/webroot")"
|
|
# make sure we have nginx package
|
|
__package nginx
|
|
# setup Let's Encrypt HTTP acme challenge, redirect HTTP to HTTPS
|
|
require="__package/nginx" __file "/etc/nginx/sites-enabled/http-$domain" \
|
|
--source - --mode 0644 << EOF
|
|
server {
|
|
listen *:80;
|
|
listen [::]:80;
|
|
|
|
server_name $domain;
|
|
|
|
# Let's Encrypt
|
|
location /.well-known/acme-challenge/ {
|
|
root $webroot;
|
|
}
|
|
|
|
# Everything else -> SSL
|
|
location / {
|
|
return 301 https://\$host\$request_uri;
|
|
}
|
|
}
|
|
|
|
EOF
|
|
</pre></div>
|
|
</div>
|
|
<p>Edit gencode-remote:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">"service nginx reload"</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-init-manifest">
|
|
<h2>9.7. Creating init manifest<a class="headerlink" href="#creating-init-manifest" title="Permalink to this headline">¶</a></h2>
|
|
<p>Next create init manifest:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span>
|
|
<span class="n">printf</span> <span class="s2">"__sample_bottle_hosting --projectname sample --user app --domain \$__target_host sample</span><span class="se">\n</span><span class="s2">"</span> <span class="o">></span> <span class="n">sample</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Using this init manifest our target host will be configured using our <strong>__sample_bottle_hosting</strong>
|
|
type with projectname <em>sample</em>, user <em>app</em> and domain equal to <strong>__target_host</strong>.
|
|
Here the last positional argument <em>sample</em> is type's object id. For details on
|
|
<strong>__target_host</strong> and <strong>__object_id</strong> see
|
|
<a class="reference external" href="cdist-reference.html#environment-variables-for-reading">Environment variables (for reading)</a>
|
|
reference.</p>
|
|
</div>
|
|
<div class="section" id="configuring-host">
|
|
<h2>9.8. Configuring host<a class="headerlink" href="#configuring-host" title="Permalink to this headline">¶</a></h2>
|
|
<p>Finally configure test.ungleich.ch:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span> <span class="n">config</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">i</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span><span class="o">/</span><span class="n">sample</span> <span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>After cdist configuration is successfully finished our host is ready.</p>
|
|
</div>
|
|
<div class="section" id="creating-python-bottle-application">
|
|
<h2>9.9. Creating python bottle application<a class="headerlink" href="#creating-python-bottle-application" title="Permalink to this headline">¶</a></h2>
|
|
<p>We now need to create Bottle application. As you remember from the beginning
|
|
of this walkthrough our type does not create the actual python application,
|
|
its intention is only to configure hosing for specified user and project.
|
|
It is up to the user to create his/her applications.</p>
|
|
<p>Become app user:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">su</span> <span class="o">-</span><span class="n">l</span> <span class="n">app</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="preparing-database">
|
|
<h3>9.9.1. Preparing database<a class="headerlink" href="#preparing-database" title="Permalink to this headline">¶</a></h3>
|
|
<p>We need to prepare database for our application. Create table and
|
|
insert some items:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"create table items (item varchar(255));"</span>
|
|
|
|
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"insert into items(item) values('spam');"</span>
|
|
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"insert into items(item) values('eggs');"</span>
|
|
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"insert into items(item) values('sausage');"</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-application">
|
|
<h3>9.9.2. Creating application<a class="headerlink" href="#creating-application" title="Permalink to this headline">¶</a></h3>
|
|
<p>Next create sample app:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">app</span>
|
|
<span class="n">mkdir</span> <span class="n">sample</span>
|
|
<span class="n">cd</span> <span class="n">sample</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Create app.py with the following content:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">bottle</span>
|
|
<span class="kn">import</span> <span class="nn">bottle_pgsql</span>
|
|
|
|
<span class="n">app</span> <span class="o">=</span> <span class="n">application</span> <span class="o">=</span> <span class="n">bottle</span><span class="o">.</span><span class="n">Bottle</span><span class="p">()</span>
|
|
<span class="n">plugin</span> <span class="o">=</span> <span class="n">bottle_pgsql</span><span class="o">.</span><span class="n">Plugin</span><span class="p">(</span><span class="s1">'dbname=app user=app password='</span><span class="p">)</span>
|
|
<span class="n">app</span><span class="o">.</span><span class="n">install</span><span class="p">(</span><span class="n">plugin</span><span class="p">)</span>
|
|
|
|
<span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span>
|
|
<span class="k">def</span> <span class="nf">show_index</span><span class="p">(</span><span class="n">db</span><span class="p">):</span>
|
|
<span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s1">'select * from items'</span><span class="p">)</span>
|
|
<span class="n">items</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span> <span class="ow">or</span> <span class="p">[]</span>
|
|
<span class="n">rv</span> <span class="o">=</span> <span class="s1">'<html><body><h3>Items:</h3><ul>'</span>
|
|
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
|
|
<span class="n">rv</span> <span class="o">+=</span> <span class="s1">'<li>'</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="s1">'item'</span><span class="p">])</span> <span class="o">+</span> <span class="s1">'</li>'</span>
|
|
<span class="n">rv</span> <span class="o">+=</span> <span class="s1">'</ul></body></html>'</span>
|
|
<span class="k">return</span> <span class="n">rv</span>
|
|
|
|
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
|
|
<span class="n">bottle</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">app</span><span class="o">=</span><span class="n">app</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s1">'0.0.0.0'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">8080</span><span class="p">)</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Create wsgi.py with the following content:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
|
|
|
|
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">app</span>
|
|
<span class="n">application</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">app</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>We have configured uWSGI with <strong>touch-reload = $projectname/wsgi.py</strong> so after
|
|
we have changed our <strong>wsgi.py</strong> file uWSGI reloads the application.</p>
|
|
<p>Our application selects and lists items from <strong>items</strong> table.</p>
|
|
</div>
|
|
<div class="section" id="openning-application">
|
|
<h3>9.9.3. Openning application<a class="headerlink" href="#openning-application" title="Permalink to this headline">¶</a></h3>
|
|
<p>Finally try the application:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span><span class="o">/</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>It should redirect to HTTPS and return:</p>
|
|
<div class="highlight docutils container">
|
|
<h3>Items:</h3>
|
|
|
|
<ul>
|
|
<li>spam</li>
|
|
<li>eggs</li>
|
|
<li>sausage</li>
|
|
</ul></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="what-s-next">
|
|
<h2>9.10. What's next?<a class="headerlink" href="#what-s-next" title="Permalink to this headline">¶</a></h2>
|
|
<p>Continue reading next sections ;)</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="man1/cdist.html" class="btn btn-neutral float-right" title="10. cdist(1)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="cdist-quickstart.html" class="btn btn-neutral" title="8. Quickstart" accesskey="p" rel="prev"><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/rtfd/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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |