Skip to content

Commit 0533d44

Browse files
committed
[wazuh](docs) update README
1 parent 5ee8e5e commit 0533d44

File tree

3 files changed

+102
-14
lines changed

3 files changed

+102
-14
lines changed

charts/wazuh/Chart.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 1.0.2
18+
version: 1.0.3
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to
2222
# follow Semantic Versioning. They should reflect the version the application is using.
2323
# It is recommended to use it with quotes.
24-
appVersion: "4.8.2"
24+
appVersion: "4.8.3"

charts/wazuh/README.md

+97-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,99 @@
11
# wazuh
22

3-
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.8.1](https://img.shields.io/badge/AppVersion-4.8.1-informational?style=flat-square)
3+
![Version: 1.0.3](https://img.shields.io/badge/Version-1.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.8.3](https://img.shields.io/badge/AppVersion-4.8.3-informational?style=flat-square)
44

55
A Helm chart for Wazuh the open source security platform that unifies XDR and SIEM protection for endpoints and cloud workloads.
66

7+
## Getting started
8+
9+
To get started, first install our helm repo
10+
11+
```bash
12+
helm repo add josa https://charts.josa.ngo
13+
helm repo update
14+
```
15+
16+
Once your values.yaml configuration is ready use
17+
18+
**Read the [Configurations notes](#configurations-notes) before installing the chart**
19+
20+
```bash
21+
helm install wazuh josa/wazuh
22+
```
23+
24+
### Configurations notes
25+
26+
#### Release Name
27+
28+
We strongly recommend setting the release name to "wazuh" in order to avoid issues with the manager configuration. The reason for this is that the wazuh manager nodes uses the name "wazuh" by default.
29+
30+
If you want to change the name you will need to provide your own wazuh-manager configuration under `manager.config.customManagerConfig`.
31+
32+
You will need to provide your own `master.conf` and `worker.conf` in your config maps, containing the your release name.
33+
34+
**Example on the release name:**
35+
36+
If your release name is `my-release`, the manager node references in the configuration files should look like:
37+
38+
```yaml
39+
my-release-manager-master-0.my-release-cluster
40+
```
41+
42+
> Make sure that the cluster name matches the release name (my-release in this example)
43+
44+
**Example of the node name under `master.conf` and `worker.conf`:**
45+
46+
```conf
47+
<cluster>
48+
<name>my-release</name>
49+
<node_name>my-release-manager-master</node_name>
50+
<node_type>master</node_type>
51+
<key>to_be_replaced_by_cluster_key</key>
52+
<port>1516</port>
53+
<bind_addr>0.0.0.0</bind_addr>
54+
<nodes>
55+
<node>my-release-manager-master-0.my-release-cluster</node>
56+
</nodes>
57+
<hidden>no</hidden>
58+
<disabled>no</disabled>
59+
</cluster>
60+
```
61+
62+
You can take a look at our configuration in our templates [here](./configs/wazuh_conf/).
63+
64+
#### TLS
65+
66+
We need to note that TLS is enabled and required at all times in our chart. In order to get this chart working you will need to provide the following tls configuration.
67+
68+
The easiest way, and the one we recommend is that you enable the certification creation in our chart if your cluster has [cert-manager](https://cert-manager.io/docs/installation/helm/) installed.
69+
70+
If you don't have a cert-manager. You can generate the required certificates and provide them as secrets under `tls.secretName`
71+
72+
The required certificates you will need in your secrets are the following:
73+
74+
- admin-key.pem
75+
- admin.pem
76+
- node-key.pem (referenced in the docs as index-key.pem and indexer.pem)
77+
- node.pem
78+
- root-ca.pem
79+
- server.key
80+
- server.cert
81+
- key.pem
82+
- cert.pem
83+
- filebeat-key.pem
84+
- filebeat.pem
85+
86+
For more information on how to generate these .pem files refer to the [wazuh Deployment kubernets](https://documentation.wazuh.com/current/deployment-options/deploying-with-kubernetes/kubernetes-deployment.html#setup-ssl-certificates)
87+
> You may notice that we did not provide the files dashboard-key.pem and dashboard.pem.
88+
>
89+
>This is because the Wazuh Kubernetes setup uses multiple names for the same certificate. Specifically, it utilizes key.pem and cert.pem alongside dashboard.pem and dashboard-key.pem, even though they refer to the same underlying certificates.
90+
>
91+
>In other words, different names are used interchangeably for the same certificate files across the setup.
92+
93+
## Helpful links
94+
95+
- [Wazuh documentation](https://documentation.wazuh.com/current/deployment-options/deploying-with-kubernetes/index.html)
96+
797
## Values
898

999
| Key | Type | Default | Description |
@@ -16,7 +106,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
16106
| dashboard.config.secrets.existingSecretName | string | `""` | ----------------- The secret must have the following keys DASHBOARD_USERNAME, DASHBOARD_PASSWORD |
17107
| dashboard.image.pullPolicy | string | `"IfNotPresent"` | |
18108
| dashboard.image.repository | string | `"wazuh/wazuh-dashboard"` | |
19-
| dashboard.image.tag | string | `"4.8.1"` | |
109+
| dashboard.image.tag | string | `"4.8.2"` | |
20110
| dashboard.imagePullSecrets | list | `[]` | |
21111
| dashboard.ingress.annotations | object | `{}` | |
22112
| dashboard.ingress.className | string | `"nginx"` | |
@@ -60,7 +150,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
60150
| indexer.config.sslEnabled | bool | `true` | |
61151
| indexer.image.pullPolicy | string | `"IfNotPresent"` | |
62152
| indexer.image.repository | string | `"wazuh/wazuh-indexer"` | |
63-
| indexer.image.tag | string | `"4.8.1"` | |
153+
| indexer.image.tag | string | `"4.8.2"` | |
64154
| indexer.imagePullSecrets | list | `[]` | |
65155
| indexer.nodeSelector | object | `{}` | |
66156
| indexer.podAnnotations | object | `{}` | |
@@ -70,7 +160,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
70160
| indexer.resources | object | `{}` | |
71161
| indexer.securityContext.capabilities.add[0] | string | `"SYS_CHROOT"` | |
72162
| indexer.storage.existingClaim | string | `""` | |
73-
| indexer.storage.size | string | `"1Gi"` | |
163+
| indexer.storage.size | string | `"25Gi"` | |
74164
| indexer.storage.storageClassName | string | `""` | |
75165
| indexer.tolerations | list | `[]` | |
76166
| indexer.volumeMounts | list | `[]` | |
@@ -86,7 +176,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
86176
| manager.config.secrets.wazuhClusterKey | string | `"123a45bc67def891gh23i45jk67l8mn9"` | |
87177
| manager.image.pullPolicy | string | `"IfNotPresent"` | |
88178
| manager.image.repository | string | `"wazuh/wazuh-manager"` | |
89-
| manager.image.tag | string | `"4.8.1"` | |
179+
| manager.image.tag | string | `"4.8.2"` | |
90180
| manager.imagePullSecrets | list | `[]` | |
91181
| manager.master.affinity | object | `{}` | |
92182
| manager.master.nodeSelector | object | `{}` | |
@@ -96,7 +186,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
96186
| manager.master.resources | object | `{}` | |
97187
| manager.master.securityContext.capabilities.add[0] | string | `"SYS_CHROOT"` | |
98188
| manager.master.storage.existingClaim | string | `""` | |
99-
| manager.master.storage.size | string | `"1Gi"` | |
189+
| manager.master.storage.size | string | `"25Gi"` | |
100190
| manager.master.storage.storageClassName | string | `""` | |
101191
| manager.master.tolerations | list | `[]` | |
102192
| manager.master.volumeMounts | list | `[]` | |
@@ -112,7 +202,7 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
112202
| manager.workers.resources | object | `{}` | |
113203
| manager.workers.securityContext.capabilities.add[0] | string | `"SYS_CHROOT"` | |
114204
| manager.workers.storage.existingClaim | string | `""` | |
115-
| manager.workers.storage.size | string | `"1Gi"` | |
205+
| manager.workers.storage.size | string | `"25Gi"` | |
116206
| manager.workers.storage.storageClassName | string | `""` | |
117207
| manager.workers.tolerations | list | `[]` | |
118208
| manager.workers.volumeMounts | list | `[]` | |
@@ -131,7 +221,6 @@ A Helm chart for Wazuh the open source security platform that unifies XDR and SI
131221
| tls.certManager.issuer.kind | string | `"ClusterIssuer"` | |
132222
| tls.certManager.issuer.name | string | `"your-issuer"` | |
133223
| tls.certManager.renewBefore | string | `"360h"` | |
134-
| tls.enabled | bool | `true` | |
135224
| tls.secretName | string | `""` | |
136225

137226
----------------------------------------------

charts/wazuh/values.yaml

+3-4
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,15 @@ global:
1313
## With the updated wazuh manager nodes in the cluster section in the [master.conf,worker.conf] files
1414
## example: {release-name}-manager-master-0.{release-name}-cluster
1515
## and the cluster name should be the same as the {release-name}
16-
## go to the manager.config section in the values file to see how you can add your own configuration files
16+
## go to the manager.config.customManagerConfig section in the values file to see how you can add your own configuration files
1717
nameOverride: ""
1818
fullnameOverride: ""
1919

2020
tls:
21-
# You either need to provide a secrete name containing specific keys as certs or enable the creation of certifications if
22-
# your cluster supports issuing certificates.
21+
# You either need to provide a secrete name containing specific keys as certs or enable the creation of certifications if your cluster supports cert manager.
2322
# **REQUIRED** when you want to provide your own certificate
2423
# The Secret name for the certs must have the following keys within it
25-
# admin-key.pem, admin.pem, dashboard-key.pem, dashboard.pem
24+
# admin-key.pem, admin.pem
2625
# filebeat-key.pem, filebeat.pem, node-key.pem, node.pem, root-ca.pem,
2726
# key.pem, cert.pem, server.key, server.cert
2827
secretName: ""

0 commit comments

Comments
 (0)