Prerequisites #
- A running Kubernetes cluster.
- kubectl installed and configured to communicate with the cluster.
- Network connectivity between NiralOS EDGE and the Kubernetes cluster.
- Internet connectivity to download the NiralOS EDGE Agent deployment manifest.
Step 1. Navigate to the Site #
From the left navigation menu:
- Expand the Management section.
- Click Site.
The Site Management page displays all configured Sites
Step 2. Open the Environment Management Page #
Locate the Site where you want to add the Kubernetes environment.
- Click the Action button corresponding to the desired Site.
- Select Environments.
The Environments page for the selected Site opens.
Step 3. Add a New Environment #
Scroll to the bottom of the Environments page.
Click Add Environment.
The Add Environment wizard appears.
Step 4. Select the Environment Type #
Select:
Kubernetes
Step 5. Enter the Environment Name #
Provide a friendly name for the Kubernetes environment.
Examples
- Production Kubernetes
- Edge Cluster
- Development Cluster
- K3s Cluster
This name is used throughout NiralOS EDGE to identify the Kubernetes cluster.
Step 6. Deploy the NiralOS EDGE Agent #
To allow NiralOS EDGE to communicate with your Kubernetes cluster, the NiralOS EDGE Agent must be deployed inside the cluster.
Choose one of the following deployment methods.
Option 1. Deploy Using a LoadBalancer (Recommended) #
If your Kubernetes environment supports LoadBalancer services, deploy the agent using the following command:
curl -fsSL https://niraledge.com/niralos-edge-agent-k8s-lb.yaml | kubectl apply -f -The Kubernetes platform will provision an external LoadBalancer IP that NiralOS EDGE uses to communicate with the cluster.
Option 2. Deploy Using a NodePort #
If your Kubernetes environment does not support LoadBalancer services, deploy the agent using a NodePort service.
Run:
curl -fsSL https://niraledge.com/niralos-edge-agent-k8s-nodeport.yaml | kubectl apply -f -The agent will be exposed on a NodePort, allowing NiralOS EDGE to communicate with the cluster through any reachable worker or control-plane node.
Step 7. Enter Kubernetes Connection Details #
Provide the connection information.
| Field | Description |
|---|---|
| Field | Description |
| Kubernetes Environment IP | IP address of the Kubernetes API Server or cluster endpoint |
| Agent IP / Port | Enter the LoadBalancer IP or Node IP and the exposed Agent Port |
Recommendation
The default Agent port is automatically populated by NiralOS EDGE. Do not modify the port number unless the agent has been deployed using a custom configuration.
Click Scan Environment to verify connectivity with the deployed NiralOS EDGE Agent.
If the connection is successful, continue to the next step.
Step 8. Enable NiralOS EDGE Insights (Optional) #
If infrastructure observability is required, enable NiralOS EDGE Insights.
NiralOS EDGE Insights provides comprehensive visibility into your Kubernetes environment through:
- Real-time metrics
- Cluster telemetry
- Pod and node monitoring
- Infrastructure logs
- Resource utilization analytics
- Performance monitoring
- Operational insights
If observability is not required, leave this option disabled.
Step 9. Connect the Environment #
Click Connect.
NiralOS EDGE registers the Kubernetes cluster and completes the environment onboarding process.
If NiralOS EDGE Insights was enabled, the required observability components are automatically deployed within the cluster.
