Administration
Administration covers the complete Linkiir platform lifecycle.
Areas
- Installation: Windows, Linux, and macOS.
- Licensing: Activation, capacity and expiry, and transfer to a replacement installation.
- Upgrades: In-place procedures by operating system.
- Deployment: DEV, TEST, PROD, HA, and moving projects between environments.
- Configurations: Project settings, users and roles, migration, Log Archive DB, Kafka, and Redpanda.
- Backup and Restore: Protect and recover the Linkiir working directory.
- Alerting and Notifications: Monitoring Linkiir, and alerting from a workflow.
- Security: First-login hardening, remote access, secrets, and patient data in logs.
- Troubleshooting: Runtime crashes, crash reports, and Log Archiver connectivity.
Common tasks
| I want to | Go to |
|---|---|
| Activate a license | License ID and License Code |
| Move a project to another environment | Import and Export |
| Add a user and control what they can do | Users and Roles |
| Set project variables and credentials | Project Settings |
| Connect my own Kafka or Redpanda cluster | Kafka and Redpanda |
| Replace the server Linkiir runs on | Backup and Restore, then License Transfer |
| Get alerted when an interface fails | Alerting and Notifications |
Daily operational checks
- Confirm
/api/healthreportshealthy, or that you understand everydegradedsub-check. - Confirm the Runtime and Log Archiver checks in that response are
ok. - Review consumer lag against broker retention, and Log DB capacity.
- Review ERROR and WARN events.
- Confirm workflows that should be running are, and that none sit in a failed state holding license capacity.
- Confirm scheduled backups completed and include the master encryption key.
- Confirm production workflow changes were approved and auditable.
:::note Alerting is not built in Linkiir has no built-in error or inactivity notifications. These checks need to come from your own monitoring system — see Alerting and Notifications. :::