Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Mar 28, 2025

Description

This adds cluster config via the Cloud API into Cloud docs, which enables Iceberg topics, data transforms, and audit logging.
NOTE: Single sourcing and conditionalizing Cloud/Self-Managed content for this PR is done in redpanda-data/docs#1041.

Resolves https://redpandadata.atlassian.net/browse/DOC-666
Review deadline: April 7

New sections for cluster maintenance:

  • Added new files under modules/manage/pages/cluster-maintenance/ to provide detailed information on configuring cluster properties and audit logging. [1] [2] [3] [4]

Content updates for existing features:

  • Updated modules/get-started/pages/cloud-overview.adoc to reflect new beta features and changes in Redpanda Cloud functionality. [1] [2]
  • Updated modules/get-started/pages/whats-new-cloud.adoc to announce the general availability of data transforms and new cluster configuration capabilities.

Updates to navigation:

  • modules/ROOT/nav.adoc: Reorganized the navigation to include new sections for data transforms and cluster maintenance, and moved some existing links to more appropriate sections. [1] [2] [3] [4]

New sections for data transforms:

  • Added multiple new files under modules/develop/pages/data-transforms/ to cover various aspects of data transforms, including building, configuring, deploying, monitoring, and testing data transforms. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Page previews

Configure Cluster Properties
Cluster Configuration Properties
What's New
Cloud Overview (supported features, features in beta)
Data Transforms
Audit Logging

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link

netlify bot commented Mar 28, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 075b1c3
🔍 Latest deploy log https://app.netlify.com/sites/rp-cloud/deploys/67f5879cfd8c910008843457
😎 Deploy Preview https://deploy-preview-245--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hyperlint-ai-deprecated
Copy link
Contributor

PR Change Summary

Updated documentation for cluster configuration in Redpanda Cloud, including new features and limitations.

  • Added a new page on configuring clusters with the Cloud API.
  • Updated existing pages to reflect the integration of Apache Iceberg and data transforms.
  • Clarified limitations for cluster configuration on different deployment types.

Modified Files

  • modules/ROOT/nav.adoc
  • modules/get-started/pages/cloud-overview.adoc
  • modules/get-started/pages/whats-new-cloud.adoc

Added Files

  • modules/manage/pages/config-cluster.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@micheleRP micheleRP marked this pull request as ready for review March 28, 2025 21:34
@micheleRP micheleRP requested a review from a team as a code owner March 28, 2025 21:34
@micheleRP micheleRP force-pushed the DOC-666-Document-feature-Manage-form-factor-appropriate-cluster-configuration-properties-in-Console branch from 4cddb94 to a89d19d Compare March 31, 2025 22:53
JakeSCahill and others added 2 commits April 1, 2025 12:08
…appropriate-cluster-configuration-properties-in-Console

# Conflicts:
#	modules/ROOT/nav.adoc
@micheleRP micheleRP marked this pull request as draft April 1, 2025 23:05

== Cluster configuration

include::ROOT:reference:properties/cluster-properties.adoc[tags=audit_enabled;audit_enabled_event_types;audit_excluded_principals;audit_excluded_topics;data_transforms_enabled;data_transforms_logging_line_max_bytes;iceberg_catalog_type;iceberg_delete;iceberg_enabled;iceberg_rest_catalog_client_id;iceberg_rest_catalog_client_secret;iceberg_rest_catalog_token;iceberg_rest_catalog_authentication_mode;iceberg_rest_catalog_endpoint;iceberg_rest_catalog_oauth2_server_uri;iceberg_rest_catalog_prefix;iceberg_rest_catalog_request_timeout_ms;iceberg_default_partition_spec;iceberg_invalid_record_action;iceberg_target_lag_ms;iceberg_rest_catalog_trust;iceberg_rest_catalog_crl] No newline at end of file

Choose a reason for hiding this comment

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

@micheleRP audit_enabled_event_types is being removed from cloud. The rest stay.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

micheleRP and others added 2 commits April 7, 2025 13:03
…appropriate-cluster-configuration-properties-in-Console

# Conflicts:
#	modules/get-started/pages/whats-new-cloud.adoc
:description: Learn how to use Redpanda's audit logging capabilities.
:page-context-links: [{"name": "Linux", "to": "manage:audit-logging.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/k-audit-logging.adoc" } ]
:page-categories: Management, Security
:env-linux: true
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this attribute required in cloud-docs?

@micheleRP micheleRP merged commit 486095b into main Apr 8, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-666-Document-feature-Manage-form-factor-appropriate-cluster-configuration-properties-in-Console branch April 8, 2025 20:45
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.

5 participants