Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning about 4.8.0 upgrade #7135

Merged
merged 3 commits into from
Mar 22, 2024
Merged

Add warning about 4.8.0 upgrade #7135

merged 3 commits into from
Mar 22, 2024

Conversation

vcerenu
Copy link
Member

@vcerenu vcerenu commented Mar 20, 2024

Description

This PR adds a warning into the Wazuh Kubernetes upgrade.

Related Issue #7122 wazuh/wazuh-kubernetes#589

First change

image

Last change

image

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@vcerenu vcerenu requested a review from a team March 20, 2024 13:24
@vcerenu vcerenu self-assigned this Mar 20, 2024
@vcerenu vcerenu linked an issue Mar 20, 2024 that may be closed by this pull request
@vcerenu vcerenu requested a review from javimed March 20, 2024 13:25
teddytpc1
teddytpc1 previously approved these changes Mar 20, 2024
@teddytpc1 teddytpc1 added level/task Task issue type/enhancement Enhancement issue labels Mar 20, 2024
Copy link
Member

@javimed javimed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we add a step to recreate SSL ceritificates rather than warning the user about it?

I can see we currently have the following steps:

  1. Checking which files are exported to the volume
  2. Configuring the upgrade
  3. Apply the new configuration

Maybe adding a new step with specific instructions on recreating the certificates would help. Or alternatively a step with the reference to the section on how to do this.

I don't think we should worry the user with a warning, just instruct them on how to proceed as part of the upgrade workflow.

@vcerenu
Copy link
Member Author

vcerenu commented Mar 21, 2024

The change was made with a warning because the only way to explain it is to refer to the code and internal configurations of Wazuh, so instead of carrying out the step explaining it seemed more correct to add a warning so that they take it into account.

I have already modified the warning and added it as an additional step to the upgrade process, clarifying that any update from a version prior of 4.8.0 to a version equal to or later than 4.8.0 requires it.

@@ -15,6 +15,7 @@ Clone this repository to deploy the necessary services and pods.
$ git clone https://github.com/wazuh/wazuh-kubernetes.git -b v|WAZUH_CURRENT_KUBERNETES| --depth=1
$ cd wazuh-kubernetes

.. _kubernetes_ssl_certificates:

Setup SSL certificates
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First lines below are duplicated. We could fix this.

@vcerenu vcerenu requested review from javimed and teddytpc1 March 21, 2024 12:41
@javimed javimed merged commit 4955f32 into 4.8.0 Mar 22, 2024
3 checks passed
@javimed javimed deleted the 7122-new-step-k8s-upgrade branch March 22, 2024 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

New step for Wazuh upgrade in Kubernetes
3 participants