Skip to content

ROX-33248: deprecate helm/manifest install endpoints#20583

Open
porridge wants to merge 1 commit into
masterfrom
deprecate-helm-manifest-grpc-endpoints
Open

ROX-33248: deprecate helm/manifest install endpoints#20583
porridge wants to merge 1 commit into
masterfrom
deprecate-helm-manifest-grpc-endpoints

Conversation

@porridge
Copy link
Copy Markdown
Contributor

@porridge porridge commented May 14, 2026

Description

Deprecated gRPC endpoints:

  • ClusterInitService.GetCAConfig — returns helm_values_bundle for helm-based setup
  • SensorUpgradeService (all RPCs) — GetSensorUpgradeConfig, UpdateSensorUpgradeConfig,
    TriggerSensorUpgrade, TriggerSensorCertRotation; the operator handles upgrades and cert rotation
  • ClustersService.PostCluster and PutCluster — used by roxctl sensor generate to register
    clusters; with operator, clusters auto-register via CRS
  • DeploymentFormat enum (KUBECTL, HELM, HELM_VALUES)

REST endpoints noted as deprecated in CHANGELOG (no code changes in this PR):

  • /api/extensions/clusters/zip
  • /api/extensions/clusters/helm-config.yaml
  • /api/extensions/helm-charts/

User-facing documentation

Testing and quality

  • the change is production ready: the change is GA, or otherwise the functionality is gated by a feature flag
  • CI results are inspected

Automated testing

No test changes needed: this is a proto annotation-only change that adds option deprecated = true;
to existing endpoints. No behavior is changed, only deprecation metadata is added.

How I validated my change

  • make proto-generated-srcs completed successfully
  • make roxvet passed with no issues
  • golangci-lint passed with 0 issues
  • Verified generated Go files contain // Deprecated: Do not use. annotations on all targeted methods

Mark gRPC endpoints related to helm/manifest-based installation as
deprecated in proto files, since operator-based installation with CRS
is now the recommended approach.

Deprecated endpoints:
- ClusterInitService.GetCAConfig (returns helm_values_bundle)
- SensorUpgradeService (all 4 RPCs: GetSensorUpgradeConfig,
  UpdateSensorUpgradeConfig, TriggerSensorUpgrade,
  TriggerSensorCertRotation)
- ClustersService.PostCluster and PutCluster
- DeploymentFormat enum (KUBECTL, HELM, HELM_VALUES)

REST endpoints noted as deprecated in CHANGELOG but not changed in
this commit: /api/extensions/clusters/zip,
/api/extensions/clusters/helm-config.yaml,
/api/extensions/helm-charts/

Partially generated by AI.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 14, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@porridge porridge changed the title chore: deprecate helm/manifest install gRPC endpoints ROX-33248: deprecate helm/manifest install endpoints May 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

🚀 Build Images Ready

Images are ready for commit a07df8e. To use with deploy scripts:

export MAIN_IMAGE_TAG=4.11.x-970-ga07df8ea37

@porridge porridge marked this pull request as ready for review May 14, 2026 09:02
@porridge porridge requested a review from vladbologa May 14, 2026 09:04
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 14, 2026

@porridge: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/ocp-4-12-qa-e2e-tests a07df8e link false /test ocp-4-12-qa-e2e-tests
ci/prow/ocp-4-21-ui-e2e-tests a07df8e link false /test ocp-4-21-ui-e2e-tests

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant