This ticket tracks documentation work for Cluster Autoscaling - Stateful Services (K8S-1906). This is This should also include overall fit and finish improvements to the autoscaling documentation that was introduced in 2.1.

Documentation Plan

Introduction. What’s New

• New section - Add a section describing new auto-scaling features and best practices in 2.2

Learn. Couchbase Cluster Concepts. Couchbase Cluster Autoscaling

• Remove section -  Enabling Couchbase Autoscaling. All content that is explicitly related to enabling and configuring auto-scaling will move to the new manage page.
• Expand section - How Autoscaling Works
• Remove section - Preview Autoscaling Mode. Convert to note about migrating from preview mode to GA mode.
• Update section - Exporting Metrics. Convert to conceptual content, move management content to new manage page.
• Update section - Connecting Horizontal Pod Autoscaler. Convert to conceptual content, move management content to new manage page.

Manage. Couchbase Cluster. Lifecycle. Scale a Couchbase Deployment

• Add a disclaimer at the top of this page stating that this page does not apply to server classes that use auto-scaling

(NEW PAGE) Manage. Couchbase Cluster. Configure. Configure Cluster Auto-scaling

• Will include content migrated from concept topic, expanded into the following sections:
  • Sections:
  • Preparing for Cluster Auto-Scaling
  • Enabling Cluster Auto-scaling
  • Exposing Cluster Metrics
  • Connecting Horizontal Pod Autoscaler
  • Verifying Cluster Auto-scaling
  • Using Cluster Auto-scaling in Practice

Reference. Resource Types. CouchbaseCluster Resource

• New sections - Add new spec fields with their descriptions. Deprecate old fields.

Reference. Resource Types. CouchbaseAutoscaler Resource

• New sections - Add new spec fields with their descriptions. Deprecate old fields.

Release Notes. Release Notes

• New section - Add a section describing new auto-scaling functionality in 2.2

Draft Documentation

Introduction. What's New

• Couchbase Cluster Auto-scaling - New section promoting auto-scaling

Learn. Couchbase Cluster Concepts. Couchbase Cluster Auto-scaling

• Overhauled the whole concept page page

Manage. Couchbase Cluster. Configure. Configure Couchbase Cluster Auto-scaling

• New page dedicated to auto-scaling howto topics

Reference. Resource Types. CouchbaseAutoscaler Resource

• New auto-generated page describing CouchbaseAutoscaler spec

Reference. Resource Types. CouchbaseCluster Resource

• couchbaseclusters.spec.autoscaleStabilizationPeriod - New field for setting the Couchbase Stabilization Period
• couchbaseclusters.spec.servers.autoscaleEnabled - New section describing the field that enables auto-scaling for a server class.

Reference. Couchbase Cluster. CouchbaseCluster Events

• Auto-scaling Lifecycle - New section describing auto-scaling lifecycle events

Release Notes. Release Notes

• Couchbase Cluster Auto-scaling - New section describing auto-scaling changes