Skip to content

Missing branch/tag checkout step in Kubernetes deployment documentation #1262

@DiegoRatto

Description

@DiegoRatto

Description

During community support for issue #60100, it was identified that the README files providing step-by-step Kubernetes configuration instructions are missing a critical step: checking out the appropriate branch or tag after cloning the repository.

This omission can lead to deployment issues, as users following the documentation may inadvertently use the main branch (which contains the latest development code and may have bugs) instead of a stable release version.

Problem Details

Current Documentation (Problematic)

The affected files currently instruct users to:

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

Expected Documentation (Correct)

Following the pattern from the official Wazuh documentation, the instructions should include the branch/tag specification:

git clone https://github.com/wazuh/wazuh-kubernetes.git -b v4.x.x --depth=1
cd wazuh-kubernetes

Or alternatively, add a checkout step after cloning:

git clone https://github.com/wazuh/wazuh-kubernetes.git
git checkout v4.x.x
cd wazuh-kubernetes

Affected Files

The following files have been identified as lacking this step:

Additional files to review

This pattern may be replicated in other documentation files within the repository:

  • README.md
  • upgrade.md
  • Any other files containing clone instructions

Impact

Users following the current documentation may:

  1. Deploy unstable/development code from the main branch
  2. Encounter unexpected bugs or incompatibilities
  3. Experience version mismatches between components
  4. Have difficulty troubleshooting issues due to undocumented changes in main

Suggested Fix

Update all affected documentation files to include the -b <version> flag in the git clone command

Related Issues

  • Community support issue: #60100

Environment

  • Repository: wazuh/wazuh-kubernetes
  • Branch: main

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions