Page MenuHomePhorge
Files F117877552

README.md
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

README.md
View Options

# Overview
Run kolab with all components on a single host.
This deployment consists of a single vm, and all workloads are executed in k3s.
This is the simplest deployment mode and suitable if the workload load fits on a single system,
and downtime for maintenance or failure is acceptable.
# Deployment method
The deployment is managed by:
* Ansible playbooks (configured via inventory.yaml) to manage the VM.
* A helm chart (configured via values.yaml) to manage the kolab deployment running on k3s.
The following systems are assumed:
* Control host: A workstation with access to the hypervisor is used to manage the environment.
* Hypervisor: A hypervisor to run the Kolab VM
The ansible playbooks are executed from the control host.
It is required that passwordless ssh logins are configured (for the user executing the ansible scripts),
from the control host to the hypervisor for the virtual machine setup.
* First an inventory.yaml file must be created to describe the deployment.
* An initial run of the ansible playbook will provision the vms on the hypervisors, setup k3s, and deploy kolab on k3s.
* An initial values.yaml will be generated from a template next to the inventory file.
Going forward the inventory.yaml and values.yaml files should be added to version control. Changes to the environment can be applied by either executing the full ansible script, or by only redeploying the helm chart (configured via values.yaml)
# Setup Instructions
Executed from the control host.
* Create a directory where you intend to manage the kolab installation from
* Download the latest release here: https://mirror.apheleia-it.ch/pub/kolab-kubernetes-latest.tar.gz
* Extract the tarball.
* Copy deployments/k3s-single-node/inventory.example.yaml to inventory.yaml
* Adjust the new inventory.yaml, by default it will deploy everything on localhost
* Run the ansible provisioning process: ansible-playbook -v -i inventory.yaml -D deployments/k3s-single-node/ansible/playbook.yaml
* Navigate to the configured url (if dns is already, prepared, otherwise via /etc/hosts entry)
* Login with the admin@YOURDOMAIN user
* Future changes can be applied via: ./kolabctl apply
# Installing on a pre-existing vm (bypass vm provisioning)
It is possible to either manually provision a Virtual Machine or connect to an existing system to install Kolab.
Please note that the ansible scripts assume the environment as prepared by the kvm ansible role.
Follow the above instructions with the following adjustments:
* When adjusting the new inventory.yaml:
* Disable vm provisioning by setting 'provision_vm: false'
* Set the ip to connect to your vm (only necessary if the hostname is not resolved to the correct ip on the control host):
* Set 'ansible_host: ip of your vm'
# Special SOP considerations
## Backup & Restore
During backup and restore the k3s cluster state needs to be handled as well.
Back up and restore:
* /var/lib/rancher/k3s/server/token
* /var/lib/rancher/k3s/server/db/

File Metadata

Mime Type
text/plain
Expires
Sun, Apr 5, 9:31 PM (3 w, 3 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18734715
Default Alt Text
README.md (2 KB)

Event Timeline