168 lines
5.1 KiB
HTML
168 lines
5.1 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>
|
||
File: README
|
||
|
||
— Documentation by YARD 0.9.36
|
||
|
||
</title>
|
||
|
||
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
||
|
||
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
||
|
||
<script type="text/javascript">
|
||
pathId = "";
|
||
relpath = '';
|
||
</script>
|
||
|
||
|
||
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
||
|
||
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
||
|
||
|
||
</head>
|
||
<body>
|
||
<div class="nav_wrap">
|
||
<iframe id="nav" src="puppet_class_list.html?1"></iframe>
|
||
<div id="resizer"></div>
|
||
</div>
|
||
|
||
<div id="main" tabindex="-1">
|
||
<div id="header">
|
||
<div id="menu">
|
||
|
||
<a href="_index.html">Index</a> »
|
||
<span class="title">File: README</span>
|
||
|
||
</div>
|
||
|
||
<div id="search">
|
||
|
||
<a class="full_list_link" id="puppet_class_list_link"
|
||
href="puppet_class_list.html">
|
||
|
||
<svg width="24" height="24">
|
||
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
||
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
||
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
||
</svg>
|
||
</a>
|
||
|
||
</div>
|
||
<div class="clear"></div>
|
||
</div>
|
||
|
||
<div id="content"><div id='filecontents'>
|
||
<h1 id="label-README">README</h1>
|
||
|
||
<p><a href="https://jenkins.confdroid.com/job/confdroid_gitea/"><img src="https://jenkins.confdroid.com/job/confdroid_gitea/badge/icon?style=plastic"></a></p>
|
||
<ul><li>
|
||
<p><a href="#readme">README</a></p>
|
||
</li></ul>
|
||
|
||
<h2 id="label-Synopsis">Synopsis</h2>
|
||
|
||
<p><code>Gitea</code> is a very nice lightweight git server and ideal for selfhosting repos i.e. for single developers without vendor lock. It can be installed standalone or as Docker / Kubernetes instance.</p>
|
||
|
||
<p><code>confdroid_gitea</code> automates the installation and configuration of gitea as standalone instance. It uses the provided downloadable binaries and sets up a full server instance based on that.</p>
|
||
|
||
<h2 id="label-WARNING">WARNING</h2>
|
||
|
||
<p>—Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production—</p>
|
||
|
||
<h2 id="label-Features">Features</h2>
|
||
|
||
<p>Installation</p>
|
||
<ul><li>
|
||
<p>install required binaries</p>
|
||
</li></ul>
|
||
|
||
<p>Configuration</p>
|
||
<ul><li>
|
||
<p>install required system user</p>
|
||
</li><li>
|
||
<p>manage directory structure</p>
|
||
</li><li>
|
||
<p>manage configuration files</p>
|
||
</li><li>
|
||
<p>file system permissions</p>
|
||
</li><li>
|
||
<p>selinux context</p>
|
||
</li><li>
|
||
<p>manage firewall settings (optional)</p>
|
||
</li><li>
|
||
<p>configure & manage the service</p>
|
||
</li></ul>
|
||
|
||
<h3 id="label-Dependencies">Dependencies</h3>
|
||
|
||
<p>All listed dependencies must be included in the catalogue.</p>
|
||
|
||
<h2 id="label-Deployment">Deployment</h2>
|
||
<ul><li>
|
||
<p>native Puppet deployment</p>
|
||
</li></ul>
|
||
|
||
<p>via site.pp or nodes.pp</p>
|
||
|
||
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
||
include confdroid_apache
|
||
}
|
||
</code></pre>
|
||
<ul><li>
|
||
<p>through Foreman:</p>
|
||
</li></ul>
|
||
|
||
<p>In order to apply parameters through Foreman, –<em>confdroid_apache::params</em>– must be added to the host or host group in question.</p>
|
||
|
||
<p>See <a href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more details about class deployment on Confdroid.com</a>.</p>
|
||
|
||
<h2 id="label-Parameters">Parameters</h2>
|
||
|
||
<p>The parameters are documented via puppet strings and <a href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
||
|
||
<h2 id="label-SELINUX">SELINUX</h2>
|
||
|
||
<p>All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.</p>
|
||
|
||
<h2 id="label-Support">Support</h2>
|
||
<ul><li>
|
||
<p>OS: Rocky 9</p>
|
||
</li><li>
|
||
<p>Puppet 8</p>
|
||
</li></ul>
|
||
|
||
<h2 id="label-Tests">Tests</h2>
|
||
<ul><li>
|
||
<p>Puppet Lint</p>
|
||
</li><li>
|
||
<p>Puppet Parser</p>
|
||
</li><li>
|
||
<p>ERB Template Parser</p>
|
||
</li><li>
|
||
<p>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</p>
|
||
</li><li>
|
||
<p>Sonar Quality Gate</p>
|
||
</li></ul>
|
||
|
||
<h2 id="label-Contact+Us">Contact Us</h2>
|
||
|
||
<p><a href="https://confdroid.com/contact/">contact Us</a> <a href="https://feedback.confdroid.com/">Feedback Portal</a></p>
|
||
|
||
<h2 id="label-Disclaimer">Disclaimer</h2>
|
||
|
||
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments. The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.</p>
|
||
</div></div>
|
||
|
||
<div id="footer">
|
||
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
|
||
</div>
|
||
|
||
</div>
|
||
</body>
|
||
</html> |