Skip to content

Latest commit

 

History

History
77 lines (67 loc) · 2.58 KB

deployment_guide.md

File metadata and controls

77 lines (67 loc) · 2.58 KB
Raw

Deployment Guide

If you do not already have a k8s cluster, check the pre-requisites to setup one.

Deployment Steps

1. Download and install karmor cli-tool

curl -sfL https://raw.githubusercontent.com/kubearmor/kubearmor-client/main/install.sh | sudo sh -s -- -b /usr/local/bin

2. Install KubeArmor

karmor install

This assumes you have your k8s cluster/env ready (check prerequisites).

Output of karmor install 
aws@pandora:~$ karmor install
Auto Detected Environment : docker
CRD kubearmorpolicies.security.kubearmor.com ...
CRD kubearmorhostpolicies.security.kubearmor.com ...
Service Account ...
Cluster Role Bindings ...
KubeArmor Relay Service ...
KubeArmor Relay Deployment ...
KubeArmor DaemonSet ...
KubeArmor Policy Manager Service ...
KubeArmor Policy Manager Deployment ...
KubeArmor Host Policy Manager Service ...
KubeArmor Host Policy Manager Deployment ...

It is assumed that the k8s cluster is already present/reachable setup with the required prerequisites and the user has rights to create service-accounts and cluster-role-bindings.

3. Deploying sample app and policies

a. Deploy sample multiubuntu app

kubectl apply -f https://raw.githubusercontent.com/kubearmor/KubeArmor/main/examples/multiubuntu/multiubuntu-deployment.yaml

b. Deploy sample policies

kubectl apply -f https://raw.githubusercontent.com/kubearmor/KubeArmor/main/examples/multiubuntu/security-policies/ksp-group-1-proc-path-block.yaml

This sample policy blocks execution of sleep command in ubuntu-1 pods.

c. Simulate policy violation

$ kubectl -n multiubuntu exec -it POD_NAME_FOR_UBUNTU_1 -- bash
# sleep 1
(Permission Denied)

Substitute POD_NAME_FOR_UBUNTU_1 with the actual pod name from kubectl get pods -n multiubuntu.

4. Getting Alerts/Telemetry from KubeArmor

a. Enable port-forwarding for KubeArmor relay

kubectl port-forward -n kube-system svc/kubearmor 32767:32767

b. Observing logs using karmor cli

karmor log

K8s platforms tested

  1. Google Kubernetes Engine (GKE) Container Optimized OS (COS)
  2. GKE Ubuntu image
  3. Amazon Elastic Kubernetes Service (EKS)
  4. Self-managed (on-prem) k8s
  5. Local k8s engines (microk8s, k3s, minikube)

Prerequisites

  1. k3s
  2. Amazon Elastic Kubernetes Service (EKS)
  3. Minikube