Quick Installation

Hızlı Kurulum

Get Poyraz-K8s platform up and running in under 5 minutes. This guide covers the essential steps for a basic deployment.

Poyraz-K8s platformunu 5 dakikadan kısa sürede çalışır duruma getirin. Bu kılavuz, temel dağıtım için gerekli adımları kapsar.

Prerequisites

Gereksinimler

• Docker & Docker Compose installed
• Kubernetes cluster with admin access
• kubectl configured
• Git installed

• Docker ve Docker Compose kurulu
• Admin erişimi olan Kubernetes kümesi
• kubectl yapılandırılmış
• Git kurulu

Step 1: Clone Repository

Adım 1: Depoyu Klonlayın

git clone https://github.com/capta1nBee/poyrazk8s.git
cd poyrazk8s/deploy/compose

git clone https://github.com/capta1nBee/poyrazk8s.git
cd poyrazk8s/deploy/compose

Step 2: Port & Configuration Settings

Adım 2: Port ve Yapılandırma Ayarları

You can modify proxy exposed ports and backend API paths.

Proxy aracılığıyla dışarıya açılan portları ve backend API yollarını değiştirebilirsiniz.

Port Change

Port Değişikliği

If you modify the UI proxy port in `compose.yaml` (e.g., `- "30025:30025"`), you must also update the corresponding port path in frontend/nginx.conf.

`compose.yaml` içerisindeki UI proxy portunu (örn. `- "30025:30025"`) değiştirirseniz, frontend/nginx.conf içerisindeki ilgili port yolunu da güncellemeniz gerekir.

Network Policy Selectors Configuration

Ağ Politikası Seçici (Selector) Yapılandırması

To accurately define default ingress and egress policy generation targets, customize your environment labels in `compose.yaml`:

Ağ trafik kuralları oluşturulurken hedef alınacak etiketleri (label) seçmek için `compose.yaml` dosyasını özelleştirin:

POLICY_LABELS=app,uygulama,deploy,project

Step 3: Start Services in Docker

Adım 3: Docker Servislerini Başlatın

docker compose up -d

Step 4: Network Agent Setup

Adım 4: Ağ Ajanı Kurulumu

Note: Tested on Kernel 5.8 and above. Requires BTF support.

Not: Kernel 5.8 ve üzeri ile test edilmiştir. BTF desteği gerektirir.

🔧 Important Settings

🔧 Önemli Ayarlar

Do not forget to update the backend IP address and adjust exclude_ips and exclude_port fields in the agent YAML according to your specific environment:

Ajan YAML yapılandırmasındaki backend IP adresini güncellemeyi unutmayın ve exclude_ips ve exclude_port alanlarını kendi ortamınıza göre ayarlayın:

http_endpoint: "BACKEND_IP:8686"

Network Specific Recommendations:

Ağa Özgü Öneriler:

If using Flannel: CIDR: 10.244.0.0/16 (Exclude IPs ending with .0 and .1)
If using Cilium: Exclude the cilium_host interface IP.

Flannel kullanıyorsanız: CIDR: 10.244.0.0/16 (.0 ve .1 ile biten IP adreslerini hariç tutun)
Cilium kullanıyorsanız: cilium_host arayüz (interface) IP adresini hariç tutun.

Apply the agent to your cluster directly from the remote raw URL after you've prepared an updated config map, or point it directly if using default configurations:

Yapılandırmalarınızı barındıran ConfigMap'i kurduktan sonra doğrudan uzak raw URL'yi kullanarak ajanı kümeye kurun:

kubectl apply -f https://raw.githubusercontent.com/capta1nBee/poyrazk8s/main/deploy/k8s/network-agent.yaml

Step 5: Security Agent Setup

Adım 5: Güvenlik Ajanı Kurulumu

Note: Tested on Kernel 5.8 and above.

Not: Kernel 5.8 ve üzeri ile test edilmiştir.

⚠️ Important Settings

⚠️ Önemli Ayarlar

Ensure the API key perfectly matches the one you specified in `compose.yaml`. Also, update the backend base URL in the ConfigMap:

API anahtarının `compose.yaml` içerisinde belirttiğinizle tamamen eşleştiğinden emin olun. Ayrıca ConfigMap içindeki backend base URL'sini güncelleyin:

BACKEND__BASE_URL: "http://BACKEND_IP:8686"
BACKEND__AGENT_API_KEY: "<YOUR_API_KEY>"

Installation

Kurulum

kubectl apply -f https://raw.githubusercontent.com/capta1nBee/poyrazk8s/main/deploy/k8s/security-agent.yaml

📝 Operational Notes

📝 İşletim Notları

Ensure your kernel version is 5.8 or higher.
Update all IP addresses and ports according to your specific environment.
Make sure agents can seamlessly communicate with the backend service over firewalls.

Çekirdek (kernel) sürümünüzün 5.8 veya üzerinde olduğundan emin olun.
Tüm IP adreslerini ve portlarını ortamınıza göre ayarladığınızdan emin olun.
Ajanların güvenlik duvarı kuralları (firewall) veya benzeri engellere takılmadan backend servisi ile iletişim kurabildiğinden emin olun.

Step 6: Access the Platform

Adım 6: Platforma Erişim

🌐 Frontend Dashboard

🌐 Frontend Kontrol Paneli

Access the web interface:

Web arayüzüne erişin:

http://localhost:8787

Default credentials: admin / admin123

Varsayılan kimlik bilgileri: admin / admin123

🔧 Backend API

Direct API access:

Doğrudan API erişimi:

http://localhost:8686

API Documentation: /swagger-ui.html

API Dokümantasyonu: /swagger-ui.html

Verification Steps

Doğrulama Adımları

Component	Bileşen	Check Command
Docker ServicesDocker Servisleri	`docker-compose ps`	All containers runningTüm konteynerler çalışıyor
Network AgentsAğ Ajanları	`kubectl get pods -n poyraz-network-observability`	All pods readyTüm pod'lar hazır
Runtime AgentsRuntime Ajanları	`kubectl get pods -n poyraz-runtime-security`	All pods readyTüm pod'lar hazır

🚀 Next Steps

🚀 Sonraki Adımlar

• Configure Network Agent Settings
• Set up Runtime Security Rules
• Explore Advanced Configuration

• Ağ Ajanı Ayarlarını yapılandırın
• Runtime Güvenlik Kurallarını ayarlayın
• Gelişmiş Yapılandırmayı keşfedin