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 f7f0da45 about 16 hours Marc Dequènes dc-web: remove manually managed vhost confdir
  doc 02d7c212 5 months Marc Dequènes Elwing: switch to new ISP
  pki c1c28bf2 about 17 hours Marc Dequènes added duckland/calibre.hq.duckcorp.org (web only)
  scripts 171152bb 8 days Marc Dequènes lib/ansible_inventory: find_host_by_fqdn() is n...
.gitignore 221 Bytes 134fa877 8 days Marc Dequènes ignore '__pycache__' directories
.gitmodules 2.37 KB 16c6bf14 10 days Marc Dequènes mail: create mail storage partition
COPYING 34.3 KB 5d76f2d8 about 1 year Marc Dequènes First public version
README.md 3.85 KB 6f55d8c4 7 months Marc Dequènes document a better way to access DC's VCS as a c...
mkcert.conf 154 Bytes 5d76f2d8 about 1 year Marc Dequènes First public version
services 347 Bytes e9b7d9a0 8 months Marc Dequènes removed obsolete im_gateway service #2

Latest revisions

# Date Author Comment
f7f0da45 2018-12-14 02:47 Marc Dequènes

dc-web: remove manually managed vhost confdir

b18c4706 2018-12-14 02:47 Marc Dequènes

added duckcorp/lists.duckcorp.org (web only)

c1c28bf2 2018-12-14 02:33 Marc Dequènes

added duckland/calibre.hq.duckcorp.org (web only)

3c210693 2018-12-14 02:13 Marc Dequènes

www.hq.duckcorp.org: fix DN for 'dc-duckland' group

cbeb6a63 2018-12-14 02:09 Marc Dequènes

added duckcorp/photos-ng.duckcorp.org (web only)

c8355c25 2018-12-13 14:03 Marc Dequènes

added duckcorp/wiki.duckcorp.org (web only)

cd87ba9a 2018-12-13 12:50 Marc Dequènes

www.duckcorp.org: prune useless files

77ff0dab 2018-12-13 12:11 Marc Dequènes

dc-web: install indexoverride data and config

50d2c386 2018-12-13 11:51 Marc Dequènes

dc-web: install shared data

04054cfc 2018-12-13 11:12 Marc Dequènes

pki: remove useless certs

View all revisions | View revisions

Also available in: Atom