Deploy & Operate
Deploy & Operate enables you to install the tiCrypt backend, configure the services it is composed of, and keep the deployment healthy. It covers the layer beneath the application: the hosts, the microservices, the mail path, and the TLS termination that everything else depends on.
This is the only part of the documentation that assumes shell access to the servers. Everything a researcher or an administrator does happens through the browser; everything here happens through the operating system.
Deploy & Operate contains the following functionality
- Installation: prepare the environment, then deploy the backend with the Ansible-based installer.
- Backend Services: the architecture of the backend microservices and the full configuration reference for each.
- Operations: monitor system services, manage API keys, configure external SFTP servers, and run the offline Python package mirror.
- Mailbox: configure the mailbox service that accepts encrypted file submissions from external contributors.
- NGINX & TLS: reference configuration and TLS verification for the reverse proxy.
Standing up a new deployment
| Step | Action | Guide |
|---|---|---|
| 1 | Prepare the environment: hardware, operating system, network, DNS, and TLS | Pre-Installation Checklist |
| 2 | Install the backend with the Ansible installer | Install Guide |
| 3 | Configure the services: review every service's settings against the reference | Configuration |
| 4 | Terminate TLS: put NGINX in front and verify the certificate chain | NGINX & TLS |
| 5 | Prepare VM images so researchers have something to boot | Building VM Images |
| 6 | Configure governance: settings, teams, profiles, and escrow | Governance |
| 7 | Deploy audit if you need retained evidence | Audit Service |
Installation
Prepare the environment, then deploy the backend with the Ansible-based installer.
Backend Services
Architecture overview and configuration reference for the backend microservices.
Operations
System services, API keys, external SFTP, and the offline Python package mirror.
Mailbox
Encrypted file submissions from external contributors.
NGINX & TLS
Reference configuration and TLS verification for the reverse proxy.
Config Reference
Every configuration parameter across all backend services, searchable.
Deep dives
These articles explore the infrastructure architecture underlying the components you deploy.
- Infrastructure Overview: components, connectivity, and deployment options.
- VM Network Isolation: how tiCrypt isolates virtual machines at the network level.
- OpenVSwitch Networking: the network architecture based on OpenVSwitch.
- Libvirt Storage Pools: network block devices over iSCSI and Ceph RBD.