Development - Kubernetes - Update documentation

[vcerenu]

Description

The objective of this step is to adapt the documentation for the Wazuh deployment in Kubernetes with all the changes made during the repository overhaul process, which will include a review of the dependencies required for the deployment and the modification of the information necessary for customization by users.

Tasks

• Update deployment dependencies in Kubernetes
• Modify the steps required for deployment
• Verify the data related to the deployed environment and update the changes that have been made in the Overhaul process

[YisDav]

Docs structure

The following structure has been proposed for the Wazuh Kubernetes documentation. The following elements have been selected to be included in the initial docs structure:

• Dev (Development documentation)

  • Set up the development environment.
    Instructions to prepare the environment for using wazuh-kubernetes.
    • Set up the toolchain.
      Guide to install and configure required tools (kubectl, kustomize, etc.) for development.
    • Set up editor/debugger.
      Steps to configure the editor and debugger for efficient Kubernetes development.
  • How to run the tests.
    Description of implemented tests for wazuh-kubernetes.

• Ref (Reference manual)

  • Introduction.
    Overview of wazuh-kubernetes and its purpose.
    • Description.
      Detailed explanation of wazuh-kubernetes features and functionality.
    • Architecture.
      Explanation of wazuh-kubernetes architecture.
    • Compatibility.
      Supported Kubernetes versions, cloud providers, and dependencies for wazuh-kubernetes.
  • Getting started.
    Quick-start guide for deploying Wazuh using wazuh-kubernetes.
    • Requirements.
      Prerequisites for deploying Wazuh with wazuh-kubernetes (cluster requirements, storage classes, etc.).
    • Usage.
      Instructions to deploy Wazuh using wazuh-kubernetes.
  • Configuration.
    Instructions to configure wazuh-kubernetes for deployment (kustomization, resources, etc.).
    • Environment variables.
      List and usage of environment variables in wazuh-kubernetes manifests.
    • Command line options.
      Description of command line options for deploying and managing wazuh-kubernetes.
    • Configuration files.
      Explanation of configuration files and their parameters (kustomization.yml, resource files, etc.).
  • Modules
    • Description
      Overview of each module/component and its role in the Wazuh deployment.
    • Architecture
      Detailed architecture of each module/component.
    • API Reference
      API endpoints and usage for each module/component, if applicable.
  • Security.
    Best practices for securing wazuh-kubernetes deployments (secrets management, RBAC, etc.).
  • Glossary.
    Definitions of key terms used in wazuh-kubernetes documentation.