Skip to content

Conversation

ggray-cb
Copy link
Contributor

This updates the documentation to state that Couchbase Server on x86 now requires AVX2 instructions.

Preview URL:
https://preview.docs-test.couchbase.com/docs-server-DOC-12540_AVX_requirements

You will need the Docs Team credentials on Confluence.

Main changes, with links to preview:

  • Removed non-AVX2 x86 processor deprecation notice from Release Notes page (AVX2 is now required, not derepcated). Note that the release note for the JIRA ticket for preventing Couchbase Server from starting without AVX2 is not finished yet, so it does not appear in this preview.
  • In System Resource Requirements:
    • Removed "deprecated" and state that AVX2 is required on x86 platforms.
    • Removed language that tied the requirement to vector indexes at PM's request.
    • Simplified the presentation by taking information spread across a table, admonition, and several paragraphs and put it into one table per platform. Something to take particular note of: we didn't actually specify requirements for using XDCR on the ARM platform before. I assume we have similar requirements to the x86 platform, so I added that entry in. If that's wrong, please let me know.

…ments.

* Also consolidated the per-CPU requirements, which had been in a table, admonition, and some paragraphs, into a single table.
…ent for 8.0, not deprecated.

Also changed the consequences mentioned in the CPU requirements.
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation to reflect that Couchbase Server on x86 platforms now requires AVX2 instructions instead of just deprecating non-AVX2 processors. The change moves from a deprecation notice to a hard requirement for AVX2 support.

Key changes:

  • Removes the deprecation notice for non-AVX2 x86 processors from release notes
  • Updates system requirements to make AVX2 mandatory for x86 platforms
  • Restructures the processor requirements documentation with clearer tables and consolidated information

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
modules/release-notes/pages/relnotes.adoc Removes deprecated platforms section that warned about AVX2 requirement
modules/install/pages/pre-install.adoc Updates system requirements to make AVX2 mandatory and restructures documentation with clearer tables

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.


NOTE: For all storage configuration, network file systems such as CIFS and NFS are not supported.

The recommendations in the table ae a baseline that do not take into account the services you will run on your nodes.
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

Corrected spelling of 'ae' to 'are'.

Suggested change
The recommendations in the table ae a baseline that do not take into account the services you will run on your nodes.
The recommendations in the table are a baseline that do not take into account the services you will run on your nodes.

Copilot uses AI. Check for mistakes.

The recommended hardware is sixteen CPU cores, 16GiB RAM, and SSD disks.
If the command returns the text `Processor has AVX2`, your processor meets Couchbase Server's AVX2 requirement.
If the command returns `AVX2 not found`, your processor does not have AVX2 instructions is not supported.
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

This sentence has incorrect grammar. It should read 'your processor does not have AVX2 instructions and is not supported' or 'your processor does not have AVX2 instructions, so it is not supported'.

Suggested change
If the command returns `AVX2 not found`, your processor does not have AVX2 instructions is not supported.
If the command returns `AVX2 not found`, your processor does not have AVX2 instructions and is not supported.

Copilot uses AI. Check for mistakes.

For the best performance on Apple Silicon systems, use the native Apple Silicon build of Couchbase Server instead of the x86 build running in Rosetta.
NOTE: For all storage configuration, network file systems such as CIFS and NFS are not supported.

The recommendations in the table ae a baseline that do not take into account the services you will run on your nodes.
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

Corrected spelling of 'ae' to 'are' (duplicate of earlier occurrence).

Suggested change
The recommendations in the table ae a baseline that do not take into account the services you will run on your nodes.
The recommendations in the table are a baseline that do not take into account the services you will run on your nodes.

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant