Skip to content

Latest commit

 

History

History
215 lines (147 loc) · 8.5 KB

instructions.md

File metadata and controls

215 lines (147 loc) · 8.5 KB
Raw

Usage

This guide describes the necessary steps to deploy Wazuh on Kubernetes.

Pre-requisites

  • Kubernetes cluster already deployed.
  • Kubernetes can run on a wide range of Cloud providers and bare-metal environments, this repository focuses on AWS. It was tested using Amazon EKS. You should be able to:
    • Create Persistent Volumes on top of AWS EBS when using a volumeClaimTemplates
    • Create a record set in AWS Route 53 from a Kubernetes LoadBalancer.
  • Having at least two Kubernetes nodes in order to meet the podAntiAffinity policy.
  • For Kubernetes version 1.23 or higher, the assignment of an IAM Role is necessary for the CSI driver to function correctly. Within the AWS documentation you can find the instructions for the assignment: https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html
  • The installation of the CSI driver is necessary for new and old deployments, since it is a Kubernetes feature.

Overview

StateFulSet and Deployments Controllers

Like a Deployment, a StatefulSet manages Pods that are based on an identical container specification, but it maintains an identity attached to each of its pods. These pods are created from the same specification, but they are not interchangeable: each one has a persistent identifier maintained across any rescheduling.

It is useful for stateful applications like databases that save the data to a persistent storage. The states of each Wazuh manager as well as Wazuh indexer are desirable to maintain, so we declare them using StatefulSet to ensure that they maintain their states in every startup.

Deployments are intended for stateless use and are quite lightweight and seem to be appropriate for Wazuh dashboard and Nginx, where it is not necessary to maintain the states.

Pods

Wazuh master

This pod contains the master node of the Wazuh cluster. The master node centralizes and coordinates worker nodes, making sure the critical and required data is consistent across all nodes. The management is performed only in this node, so the agent registration service (authd) and the API are placed here.

Details:

  • Image: Docker Hub 'wazuh/wazuh-manager'
  • Controller: StatefulSet

Wazuh worker 0 / 1

These pods contain a worker node of the Wazuh cluster. They will receive the agent events.

Details:

  • Image: Docker Hub 'wazuh/wazuh-manager'
  • Controller: StatefulSet

Wazuh indexer

Wazuh indexer pod. Used to build an Wazuh indexer cluster.

Details:

  • Image: wazuh/wazuh-indexer
  • Controller: StatefulSet

Wazuh dashboard

Wazuh dashboard pod. It lets you visualize your Wazuh indexer data, along with other features as the Wazuh app.

Details:

  • image: Docker Hub 'wazuh/wazuh-dashboard'
  • Controller: Deployment

Services

Indexer stack

  • wazuh-indexer:
    • Communication for Wazuh indexer nodes.
  • indexer:
    • Wazuh indexer API. Used by Wazuh dashboard to write/read alerts.
  • dashboard:

Wazuh

  • wazuh:
    • Wazuh API: wazuh-master.your-domain.com:55000
    • Agent registration service (authd): wazuh-master.your-domain.com:1515
  • wazuh-workers:
    • Reporting service: wazuh-manager.your-domain.com:1514
  • wazuh-cluster:
    • Communication for Wazuh manager nodes.

Deploy

Step 1: Deploy Kubernetes

Deploying the Kubernetes cluster is out of the scope of this guide.

This repository focuses on AWS but it should be easy to adapt it to another Cloud provider. In case you are using AWS, we recommend EKS.

Step 2: Create domains to access the services

We recommend creating domains and certificates to access the services. Examples:

  • wazuh-master.your-domain.com: Wazuh API and authd registration service.
  • wazuh-manager.your-domain.com: Reporting service.
  • wazuh.your-domain.com: Wazuh dashboard app.

Note: You can skip this step and the services will be accessible using the Load balancer DNS from the VPC.

Step 3: Deployment

Clone this repository to deploy the necessary services and pods.

$ git clone https://github.com/wazuh/wazuh-kubernetes.git
$ cd wazuh-kubernetes

Step 3.1: Setup SSL certificates

You can generate self-signed certificates for the Wazuh indexer cluster using the script at wazuh/certs/indexer_cluster/generate_certs.sh or provide your own.

Since Wazuh dashboard has HTTPS enabled it will require its own certificates, these may be generated with: openssl req -x509 -batch -nodes -days 365 -newkey rsa:2048 -keyout key.pem -out cert.pem, there is an utility script at wazuh/certs/dashboard_http/generate_certs.sh to help with this.

The required certificates are imported via secretGenerator on the kustomization.yml file:

secretGenerator:
- name: indexer-certs
    files:
    - certs/indexer_cluster/root-ca.pem
    - certs/indexer_cluster/node.pem
    - certs/indexer_cluster/node-key.pem
    - certs/indexer_cluster/dashboard.pem
    - certs/indexer_cluster/dashboard-key.pem
    - certs/indexer_cluster/admin.pem
    - certs/indexer_cluster/admin-key.pem
    - certs/indexer_cluster/filebeat.pem
    - certs/indexer_cluster/filebeat-key.pem
- name: dashboard-certs
    files:
    - certs/dashboard_http/cert.pem
    - certs/dashboard_http/key.pem

Step 3.2: Apply all manifests using kustomize

We are using the overlay feature of kustomize to create two variants: eks and local-env, in this guide we're using eks. (For a deployment on a local environment check the guide on local-environment.md)

You can adjust resources for the cluster on envs/eks/, you can tune cpu, memory as well as storage for persistent volumes of each of the cluster objects.

By using the kustomization file on the eks variant we can now deploy the whole cluster with a single command:

$ kubectl apply -k envs/eks/

Verifying the deployment

Namespace

$ kubectl get namespaces | grep wazuh
wazuh         Active    12m

Services

$ kubectl get services -n wazuh
NAME            TYPE           CLUSTER-IP       EXTERNAL-IP             PORT(S)                          AGE
dashboard       LoadBalancer   10.100.55.244    <entrypoint_assigned>   443:31670/TCP                    4h13m
indexer         LoadBalancer   10.100.199.148   <entrypoint_assigned>   9200:32270/TCP                   4h13m
wazuh           LoadBalancer   10.100.176.82    <entrypoint_assigned>   1515:32602/TCP,55000:32116/TCP   4h13m
wazuh-cluster   ClusterIP      None             <none>                  1516/TCP                         4h13m
wazuh-indexer   ClusterIP      None             <none>                  9300/TCP                         4h13m
wazuh-workers   LoadBalancer   10.100.165.20    <entrypoint_assigned>   1514:30128/TCP                   4h13m

Deployments

$ kubectl get deployments -n wazuh
NAME              READY   UP-TO-DATE   AVAILABLE   AGE
wazuh-dashboard   1/1     1            1           4h16m

Statefulsets

$ kubectl get statefulsets -n wazuh
NAME                   READY   AGE
wazuh-indexer          3/3     4h17m
wazuh-manager-master   1/1     4h17m
wazuh-manager-worker   2/2     4h17m

Pods

$ kubectl get pods -n wazuh
NAME                               READY   STATUS    RESTARTS   AGE
wazuh-dashboard-57d455f894-ffwsk   1/1     Running   0          4h17m
wazuh-indexer-0                    1/1     Running   0          4h17m
wazuh-indexer-1                    1/1     Running   0          4h17m
wazuh-indexer-2                    1/1     Running   0          4h17m
wazuh-manager-master-0             1/1     Running   0          4h17m
wazuh-manager-worker-0             1/1     Running   0          4h17m
wazuh-manager-worker-1             1/1     Running   0          4h17m

Accessing Wazuh dashboard

In case you created domain names for the services, you should be able to access Wazuh dashboard using the proposed domain name: https://wazuh.your-domain.com.

Also, you can access using the External-IP (from the VPC): https://internal-xxx-yyy.us-east-1.elb.amazonaws.com:443

$ kubectl get services -o wide -n wazuh
NAME        TYPE           CLUSTER-IP       EXTERNAL-IP                                                              PORT(S)        AGE     SELECTOR
dashboard   LoadBalancer   10.100.55.244    a91dadfdf2d33493dad0a267eb85b352-1129724810.us-west-1.elb.amazonaws.com  443:31670/TCP  4h19m   app=wazuh-dashboard