Project

General

Profile

README

DuckCorp Infrastructure

This is the root of the DuckCorp Admin Team materials used to install, configure and manage services.

DuckCorp is commited to Free Software, thus all materials are published under the GPL v3 License (see details of the license in the COPYING file).

Materials

All sensitive materials are encrypted, read the Dealing with Secrets chapter to know more about this.

Configuration Management & Deployment

We use Ansible to help us automate as much as possible; you'll find more about it in the ansible directory.

Still, many things are handled manually, this is WIP.

PKI

Our TLS certificates are managed using mkcert. The mkcert.conf file holds the DuckCorp-specific configuration, and services contains the specific service names not in /etc/services. The keys configuration and resulting certificates are stored in the pki directory.

With this layout, mkcert can be run in-place (at the top-level of this repository), automagically finding its configuration and work directories.

Scripts

In the scripts directory are the following scripts:

  • adm_check_*: this series of scripts check various resources hosted by DuckCorp against the outside world to see if there is any misconfiguration or if the hosting became obsolete (without the user telling us, which happen very often…)
  • adm_publish_tlsa: compute TLSA DNS RR for DNSSEC-enabled DNS zones based on the available TLS certificates
  • check_certs_expiration: warn when certificates are nearly expired (or already expired)

They are meant to be run in-place from the top of this repository. The lib subdirectory contains code factorized between the scripts.

Documentation

The admin-oriented documentation can be found alongside the other materials, but for some topics we might write a dedicated explanation and store it in the doc directory.

For Admin Team Members

Sensitive Data

You need to set the ANSIBLE_VAULT_PASSWORD_FILE environment variable with the path to the password file.

Requirements

First, clone [the repository](ssh://vcs-git.duckcorp.org/srv/vcs/git/duckcorp/duckcorp-infra.git). You should probably have a look at the Requirements in the underlying directories too.

Git configuration

  • Always create a merge commit : $ git config --local merge.ff false
  • Allow fast-forward merges when using pull : $ git config --local pull.ff only
  • All commits must be GPG signed : $ git config --local commit.gpgSign true

Dealing with Secrets

We use Ansible Vault to hide some parameters like service credentials, user personal information or emails to avoid SPAM.

To make it easy git attributes are defined to make diff-ing and merging easy.

Your configuration needs to be enhanced to tel git how to handle these files. This is very easy, look at this URL for more info:

: https://github.com/building5/ansible-vault-tools

Git usage

When merging a branch, use --verify-signatures switch. If this fails, then DO NOT MERGE!!!

When adding submodule, please use the HTTPs URL to allow contributors to clone. Also use --name to set the submodule name or the path is taken by default. Then, you can ask git to automatically rewrite the URL to the right form with this command:

git config --global url.ssh://vcs-git.duckcorp.org/srv/vcs/git/.insteadOf https://vcs-git.duckcorp.org/

For External Contributor

You're welcome to contribute ideas, report problems, send patches… using our Ticket Tracker (in the Contribution tracker).

You can clone this repository or browse it.

Statistics
| Branch: | Revision:

duckcorp-infra @ master

Name Size Revision Age Author Comment
  ansible 5eb3559f 3 days Arnaud Fontaine add email address for 'arnau' user account.
  doc 171e8beb 3 months Marc Dequènes leftover stuff from the gone Korutopi
  pki 01ba944e 25 days Marc Dequènes mail: add smtp.duckcorp.org to mta/Toushirou ce...
  scripts 0e7c665f 3 months Marc Dequènes scripts: fix LDAP init improve Ansible output ...
.gitignore 209 Bytes 43a99ed7 6 months Marc Dequènes (Duck) ensute Ansible retry files are not included by ...
.gitmodules 2.25 KB 5cab3616 25 days Marc Dequènes monitoring: dc-monitoring role has moved in its...
COPYING 34.3 KB 5d76f2d8 10 months Marc Dequènes First public version
README.md 3.85 KB 6f55d8c4 about 2 months Marc Dequènes document a better way to access DC's VCS as a c...
mkcert.conf 154 Bytes 5d76f2d8 10 months Marc Dequènes First public version
services 347 Bytes e9b7d9a0 3 months Marc Dequènes removed obsolete im_gateway service #2

Latest revisions

# Date Author Comment
5eb3559f 2018-07-19 03:47 Arnaud Fontaine

add email address for 'arnau' user account.

39fc7e48 2018-07-16 23:04 Arnaud Fontaine

add/remove email addresses for 'arnau' user account.

7072e63d 2018-07-11 20:59 Marc Dequènes

monitoring: use host registration feature

b155e7a1 2018-07-10 21:42 Marc Dequènes

monitoring: adjust number of DB syncers

8b1975c3 2018-06-27 16:51 Marc Dequènes

fix firewall rule for backup on Nicecity

5cab3616 2018-06-27 15:53 Marc Dequènes

monitoring: dc-monitoring role has moved in its own repo

ddd49adc 2018-06-27 12:56 Marc Dequènes

dc-monitoring: move UI installation into the role

dead00ce 2018-06-27 11:49 Marc Dequènes

monitoring: update number of poller processes to our need

b4c385fe 2018-06-27 09:09 Marc Dequènes

dc-monitoring: move hardcoded DC poller settings as parameters

5eb5d41f 2018-06-27 05:41 Marc Dequènes

dc-monitoring: add cgroup path for filtering in 'linux_systemd' agent script

View all revisions | View revisions

Also available in: Atom