Skip to content

docs(starrocks): migrate release-1_0_1 docs from v1alpha1 to v1 API #197

@weicao

Description

@weicao

Summary

Three StarRocks documents in release-1_0_1 still use the deprecated apps.kubeblocks.io/v1alpha1 Cluster API, while all other addon docs in the same release have already migrated to v1.

Affected Files

File v1alpha1 Fields Used
kubeblocks-for-starrocks/03-scale.mdx apiVersion: v1alpha1, clusterDefinitionRef, clusterVersionRef
kubeblocks-for-starrocks/04-stop-and-start.mdx apiVersion: v1alpha1, clusterDefinitionRef, clusterVersionRef, spec.affinity.topologyKeys
kubeblocks-for-starrocks/06-expand-volume.mdx apiVersion: v1alpha1, clusterDefinitionRef, clusterVersionRef

Details

These docs explicitly use apiVersion: apps.kubeblocks.io/v1alpha1 and reference deprecated fields:

  • spec.clusterDefinitionRef / spec.clusterVersionRef — replaced by spec.clusterDef + spec.topology in v1
  • spec.affinity.topologyKeys — deprecated since KB v0.10, replaced by spec.componentSpecs[*].schedulingPolicy

While v1alpha1 still works in KB 1.0.x (backwards compatible), the docs should use the current v1 API to stay consistent with all other addon docs in release-1_0_1 and avoid misleading users.

Expected Fix

Update the three files to use apiVersion: apps.kubeblocks.io/v1 with the current field names, consistent with how other addons (e.g. MySQL, PostgreSQL) are documented in the same release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions