System Setup

Welcome to KIOPS! This guide will walk you through the process of registering devices, runtimes, and services in the platform step by step.

Why Follow This Order?

To deploy services in KIOPS, you first need to define where to deploy them. That's why we follow the setup process in this order:

Device Registration → Runtime Registration → Service Registration

• Device Registration: Connect servers/physical devices to KIOPS (e.g., Cloud VMs, on-premises servers)
• Runtime Registration: Connect container environments running on devices (e.g., Kubernetes clusters, Docker hosts)
• Service Registration: Register applications to deploy (e.g., Git repository-based microservices)

New to KIOPS?

If you don't have a server yet, try connecting Docker on your local development environment first. You can experience KIOPS's features without setting up a cloud environment.

Single Entry Point for Runtime Environments

All runtime environments (K8s, Docker, Podman) start from the same [Runtime Environments] page > Add Runtime Environment button. Clicking it opens the Add Runtime Environment modal (AddInfraSelectModal), which offers two flows:

• Install New Runtime: KIOPS connects via SSH and installs kubeadm or Docker/Podman directly. For K8s this includes VIP/HA options.
• Connect Existing Runtime (Import): KIOPS connects to an already running cluster or host, performs preflight checks, and registers it. K8s, Docker, and Podman all follow the same flow.

Podman registration is covered in the docker-registration guide

KIOPS handles Docker and Podman through the same modal. Choosing Podman in the Environment Type selector follows the same flow as Docker. See Docker Runtime Registration for the detailed procedure.

Setup Scenarios

Follow these guides in order to completely set up the KIOPS platform:

• Device Registration - Register servers/devices to manage.
• K8s Cluster Registration - Install a new Kubernetes cluster or connect an existing one.
• Docker Runtime Registration - Install a new Docker/Podman runtime or connect an existing host.
• Service Registration - Register services from GitLab/GitHub/Docker Hub.
• Metrics Server Installation - Install metrics-server in your cluster to collect resource usage.
• Monitoring Extension - Collect extended metrics (network I/O, etc.) with cAdvisor or the Prometheus Stack.
• RBAC Management - Manage cluster permissions and integrated accounts.
• K8s Certificate Renewal - Renew kubeadm cluster certificates.

Which Runtime Should I Choose?

• Kubernetes: Ideal for large-scale production environments. Supports advanced features like auto-scaling and rolling updates.
• Docker/Podman: Ideal for small-scale environments or development/testing. Simple to set up and quick to get started.