Skip to content

Commit 5f0fd4b

Browse files
committed
Enhance documentation to attend 1319
- Add compatibility section - Performance recommendations - And security guidelines; - Remove change password instructions
1 parent 28ed6cd commit 5f0fd4b

7 files changed

Lines changed: 318 additions & 212 deletions

File tree

docs/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@
1010
# Reference Manual
1111

1212
- [Introduction](ref/introduction.md)
13+
- [Compatibility](ref/introduction/compatibility.md)
1314
- [Getting Started](ref/getting-started/getting-started.md)
1415
- [Requirements](ref/getting-started/requirements.md)
1516
- [Usage](ref/getting-started/usage/usage.md)
1617
- [Deployment](ref/getting-started/usage/deployment/deployment.md)
1718
- [AWS EKS Deployment](ref/getting-started/usage/deployment/eks.md)
1819
- [Local Deployment](ref/getting-started/usage/deployment/local.md)
1920
- [Verify deployment](ref/getting-started/usage/deployment/verify.md)
20-
- [Change Passwords](ref/getting-started/usage/change-password.md)
2121
- [Upgrade](ref/getting-started/usage/upgrade.md)
2222
- [Cleanup](ref/getting-started/usage/cleanup.md)
2323
- [Security](ref/getting-started/usage/security.md)
2424
- [Backup and Restore](ref/getting-started/usage/backup-restore.md)
25+
- [Performance](ref/getting-started/usage/performance.md)
2526
- [Configuration](ref/getting-started/configuration.md)
2627
- [Glossary](ref/glossary.md)

docs/ref/getting-started/configuration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,23 @@ Main secrets:
7777
Wazuh dashboard (Kibana) username and password.
7878
- `wazuh/secrets/indexer-cred-secret.yaml`
7979
Wazuh indexer username and password.
80+
81+
## Persistence configuration
82+
83+
When customizing your Wazuh Kubernetes deployment, certain files and directories must be persisted to retain your changes across pod restarts and recreations. This is critical for maintaining custom configurations, user credentials, and security settings.
84+
85+
### PersistentVolumeClaims and ConfigMaps
86+
87+
Kubernetes uses PersistentVolumeClaims (PVCs) and ConfigMaps to persist data outside of pod lifecycles:
88+
89+
- **PersistentVolumeClaims**: Used for stateful data like logs, queues, and Indexer data. When a pod is deleted and recreated, data in PVCs remains intact.
90+
- **ConfigMaps**: Used for configuration files. ConfigMaps can be mounted as files in pods and updated independently of the pod lifecycle.
91+
92+
The Wazuh deployment already uses PVCs for critical directories like `/var/ossec/etc`, `/var/ossec/logs`, and `/var/lib/wazuh-indexer`. For additional configuration files, use ConfigMaps as described above.
93+
94+
> **Important**: When creating ConfigMaps for configuration files, ensure the file content is properly formatted and validated before applying. Malformed configuration files can prevent pods from starting.
95+
96+
For more information on Kubernetes storage concepts, refer to the official Kubernetes documentation:
97+
98+
- [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
99+
- [ConfigMaps](https://kubernetes.io/docs/concepts/configuration/configmap/)
Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
# Backup and Restore
1+
# Backup and restore
2+
3+
For backup and restore procedures, refer to the documentation for each component:
4+
5+
- [Wazuh manager](https://github.com/wazuh/wazuh/blob/v5.0.0/docs/ref/backup-restore.md)
6+
- [Wazuh agent](https://github.com/wazuh/wazuh-agent/blob/v5.0.0/docs/ref/backup-restore.md)
7+
8+
## Kubernetes-specific considerations
9+
10+
When backing up Wazuh deployments on Kubernetes, also consider:
11+
12+
### PersistentVolume backups
13+
14+
- Wazuh Manager and Indexer data are stored in PersistentVolumes.
15+
- The indexer PersistentVolume contains the index data and indexer security state (including internal users).
16+
- Use your storage provider's snapshot or backup capabilities:
17+
- **AWS EBS**: EBS snapshots via AWS Backup or manual snapshots
18+
- **GCP Persistent Disk**: Disk snapshots
19+
- **Azure Disk**: Disk snapshots
20+
- **On-premises**: Storage backend-specific backup tools
21+
- Consider using Kubernetes backup tools like Velero for automated PV backups.
22+
23+
### Secrets and configuration
24+
25+
Back up the following Kubernetes Secrets containing credentials and certificates:
26+
27+
- `wazuh/secrets/wazuh-api-cred-secret.yaml` - Wazuh API credentials
28+
- `wazuh/secrets/dashboard-cred-secret.yaml` - Dashboard credentials
29+
- `wazuh/secrets/indexer-cred-secret.yaml` - Indexer credentials
30+
- `wazuh/secrets/wazuh-authd-pass-secret.yaml` - Agent enrollment password
31+
- `wazuh/secrets/wazuh-cluster-key-secret.yaml` - Cluster communication key
32+
- Certificate secrets generated by the `wazuh-certs-tool.sh` script
33+
34+
Also back up any custom ConfigMaps you have created for configuration file persistence.
35+
36+
Store backups securely and encrypt them if they contain sensitive data.
37+
38+
### Manifest files
39+
40+
- Maintain version-controlled copies of all Kubernetes manifests, including customizations in `envs/`.
41+
- This allows you to recreate the deployment configuration even if the cluster is lost.

docs/ref/getting-started/usage/change-password.md

Lines changed: 0 additions & 209 deletions
This file was deleted.

0 commit comments

Comments
 (0)