Configure and Deploy overview¶
This page introduces the Configure and Deploy section, which covers installing, tuning, securing, and upgrading a KX Sensors deployment for your environment.
Once your schemas and ingestion pipelines are defined, this section shows you how to bring KX Sensors up in your environment and tune it for your workload — from service class layout and system parameters through high availability, data retention, security, networking, and upgrades.
Install¶
Set up the core building blocks of a deployment.
- Configure service classes in manifest.yaml — define service classes per node
- Set up a message queue — configure your message queue
- Set up your EMS streams in ems.yaml — configure EMS streams
- Add a node — add a node to your cluster
Fine tuning configuration¶
Tune the system for your workload.
- Configure your environment variables
- System parameters systemParams.yaml
- TP configuration
- Stagger your EOIs
- Set up query processing
High availability¶
Run across multiple nodes with automatic failover.
- Overview — topology options, failover, and failback
- Set up your system parameters
- HA clients quorum
Data retention¶
Manage compression, storage, and the data lifecycle.
- Compression
- Row-level retention
- HDB files
- IDB files
- Delete historical partitions
- Recover your data
- Export your sensor data
- Validate data migrated from other systems
Security¶
Authenticate users, encrypt data, and validate readings.
- User authentication
- Encryption
- In-transit TLS encryption
- IDB/HDB encryption management
- Validation, Estimation and Editing (VEE)
Network/Hardware¶
Configure networking and hardware prerequisites.
- HAProxy
- Docker containers and swarm network (v3 before 3.3) — superseded by host-based RT in 3.3
- Network conditioning fast failure detection
- Tasksets
- Disk requirements layouts
- Network requirements
- OS settings
Upgrade¶
Move to a new version safely.
- Before you begin
- Overview of dynamic upgrades
- Dynamic upgrades using the KX Sensors CLI
- Perform an offline upgrade
- Troubleshooting
Where to next¶
- Architecture — understand the system you are deploying
- Develop — customize schemas, APIs, and ingestion
- Operate — run and monitor a live deployment