From 79473343ceeaf501de810154f4741f911b6f5d63 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 23 Feb 2026 18:11:55 -0300 Subject: [PATCH 1/3] whats new --- .../pages/release-notes/redpanda.adoc | 175 ++---------------- 1 file changed, 14 insertions(+), 161 deletions(-) diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index 34765f5ded..f22dc138e1 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -7,171 +7,24 @@ This topic includes new content added in version {page-component-version}. For a * xref:redpanda-cloud:get-started:whats-new-cloud.adoc[] * xref:redpanda-cloud:get-started:cloud-overview.adoc#redpanda-cloud-vs-self-managed-feature-compatibility[Redpanda Cloud vs Self-Managed feature compatibility] -NOTE: Redpanda v25.3 introduces breaking schema changes for Iceberg topics. If you are using Iceberg topics and want to retain the data in the corresponding Iceberg tables, review xref:upgrade:iceberg-schema-changes-and-migration-guide.adoc[] before upgrading your cluster, and follow the required migration steps to avoid sending new records to a dead-letter queue table. - -== Iceberg topics with GCP BigLake - -A new xref:manage:iceberg/iceberg-topics-gcp-biglake.adoc[REST catalog integration] with Google Cloud BigLake allows you to add Redpanda topics as Iceberg tables in your data lakehouse. - -See xref:manage:iceberg/use-iceberg-catalogs.adoc[] for details on configuring Iceberg REST catalog integrations with Redpanda. - -== Shadowing - -Redpanda v25.3 introduces xref:deploy:redpanda/manual/disaster-recovery/shadowing/index.adoc[], an enterprise-licensed disaster recovery solution that provides asynchronous, offset-preserving replication between distinct Redpanda clusters. Shadowing enables cross-region data protection by replicating topic data, configurations, consumer group offsets, ACLs, and Schema Registry data with byte-level fidelity. - -The shadow cluster operates in read-only mode while continuously receiving updates from the source cluster. During a disaster, you can failover individual topics or an entire shadow link to make resources fully writable for production traffic. See xref:deploy:redpanda/manual/disaster-recovery/shadowing/failover-runbook.adoc[] for emergency procedures. - -Shadowing includes comprehensive metrics for monitoring replication health. See xref:manage:disaster-recovery/shadowing/monitor.adoc[] and xref:reference:public-metrics-reference.adoc#shadow-link-metrics[Shadow Link metrics reference]. - -== Connected client monitoring - -You can view details about Kafka client connections using `rpk` or the Admin API ListKafkaConnections endpoint. This allows you to view detailed information about active client connections on a cluster, and identify and troubleshoot problematic clients. For more information, see the xref:manage:cluster-maintenance/manage-throughput.adoc#view-connected-client-details[connected client details] example in the Manage Throughput guide. - -== New Admin API style - -Redpanda v25.3 introduces a new API style for the Admin API, powered by https://connectrpc.com/docs/introduction[ConnectRPC]. New Redpanda features and operations in v25.3 are available as ConnectRPC services, allowing you to use autogenerated Protobuf clients in addition to using HTTP clients such as `curl`. - -Use the new ConnectRPC endpoints with the following v25.3 features: - -* Shadowing -* Connected client monitoring - -Existing Admin API endpoints from versions earlier than 25.3 remain supported, and you can continue to use them as usual. See xref:manage:use-admin-api.adoc[Manage Redpanda with the Admin API] to learn more about Admin API, and the link:/api/doc/admin/v2/[Admin API reference] to view the new endpoints. - -== Schema Registry import mode - -Redpanda Schema Registry now supports an import mode that allows you to import existing schemas and retain their current IDs and version numbers. Import mode is useful when migrating from another schema registry. - -Starting with this release, import mode must be used when importing schemas. Read-write mode no longer allows specifying a schema ID and version when registering a schema. -See xref:manage:schema-reg/schema-reg-api.adoc#set-schema-registry-mode[Use the Schema Registry API]. - -== Security report - -You can now generate a security report for your Redpanda cluster using the link:/api/doc/admin/operation/operation-get_security_report[`/v1/security/report`] Admin API endpoint. The report provides detailed information about TLS configuration, authentication methods, authorization status, and security alerts across all Redpanda interfaces (Kafka, RPC, Admin, Schema Registry, HTTP Proxy). - -== Topic identifiers - -Redpanda v25.3 implements topic identifiers using 16 byte UUIDs as proposed in https://cwiki.apache.org/confluence/display/KAFKA/KIP-516%3A+Topic+Identifiers[KIP-516^]. - -== Shadowing metrics - -Redpanda v25.3 introduces comprehensive xref:reference:public-metrics-reference.adoc#shadow-link-metrics[Shadowing metrics] for monitoring disaster recovery replication: - -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_client_errors[`redpanda_shadow_link_client_errors`] - Track Kafka client errors during shadow link operations -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_shadow_lag[`redpanda_shadow_link_shadow_lag`] - Monitor replication lag between source and shadow partitions -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_shadow_topic_state[`redpanda_shadow_link_shadow_topic_state`] - Track shadow topic state distribution across links -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_total_bytes_fetched[`redpanda_shadow_link_total_bytes_fetched`] - Monitor data transfer volume from source cluster -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_total_bytes_written[`redpanda_shadow_link_total_bytes_written`] - Track data written to shadow cluster -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_total_records_fetched[`redpanda_shadow_link_total_records_fetched`] - Monitor total records fetched from source cluster -* xref:reference:public-metrics-reference.adoc#redpanda_shadow_link_total_records_written[`redpanda_shadow_link_total_records_written`] - Track total messages written to shadow cluster - -For monitoring guidance and alert recommendations, see xref:manage:disaster-recovery/shadowing/monitor.adoc[]. - == New commands -Redpanda v25.3 introduces the following xref:reference:rpk/rpk-shadow/rpk-shadow.adoc[`rpk shadow`] commands for managing Redpanda shadow links: - -* xref:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[`rpk shadow config generate`] - Generate configuration files for shadow links -* xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[`rpk shadow create`] - Create new shadow links -* xref:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[`rpk shadow update`] - Update existing shadow link configurations -* xref:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[`rpk shadow list`] - List all shadow links -* xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`] - View shadow link configuration details -* xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] - Monitor shadow link replication status -* xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[`rpk shadow failover`] - Perform emergency failover operations -* xref:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc[`rpk shadow delete`] - Delete shadow links - -In addition, the following commands have been added: - -* xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[`rpk cluster connections`] - Monitor cluster connections and client statistics. -* xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-print.adoc[`rpk redpanda config print`] - Display node configuration. - -== New configuration properties - -Redpanda 25.3 introduces the following configuration properties: - -**Shadowing:** - -* xref:reference:properties/cluster-properties.adoc#enable_shadow_linking[`enable_shadow_linking`]: Enable shadow links (Enterprise license required) - -**Timestamp validation:** - -* xref:reference:properties/cluster-properties.adoc#log_message_timestamp_after_max_ms[`log_message_timestamp_after_max_ms`]: Maximum timestamp difference for future records -* xref:reference:properties/cluster-properties.adoc#log_message_timestamp_before_max_ms[`log_message_timestamp_before_max_ms`]: Maximum timestamp difference for past records -* xref:reference:properties/topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`]: Topic-level timestamp validation (future) -* xref:reference:properties/topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`]: Topic-level timestamp validation (past) - -**Audit logging:** - -* xref:reference:properties/cluster-properties.adoc#audit_use_rpc[`audit_use_rpc`]: Use internal RPCs for audit logging - -**Object storage:** - -* xref:reference:properties/object-storage-properties.adoc#cloud_storage_client_lease_timeout_ms[`cloud_storage_client_lease_timeout_ms`]: Object storage connection timeout - -**Iceberg:** - -* xref:reference:properties/cluster-properties.adoc#iceberg_default_catalog_namespace[`iceberg_default_catalog_namespace`]: Default Iceberg catalog namespace for tables -* xref:reference:properties/cluster-properties.adoc#iceberg_dlq_table_suffix[`iceberg_dlq_table_suffix`]: Iceberg DLQ table name suffix -* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_gcp_user_project[`iceberg_rest_catalog_gcp_user_project`]: GCP project for Iceberg REST catalog billing -* xref:reference:properties/cluster-properties.adoc#iceberg_topic_name_dot_replacement[`iceberg_topic_name_dot_replacement`]: Dot replacement in Iceberg table names - -**TLS:** - -* xref:reference:properties/cluster-properties.adoc#tls_v1_2_cipher_suites[`tls_v1_2_cipher_suites`]: TLS 1.2 cipher suites for client connections -* xref:reference:properties/cluster-properties.adoc#tls_v1_3_cipher_suites[`tls_v1_3_cipher_suites`]: TLS 1.3 cipher suites for client connections - -**Tiered Storage:** - -* xref:reference:properties/cluster-properties.adoc#cloud_topics_epoch_service_epoch_increment_interval[`cloud_topics_epoch_service_epoch_increment_interval`]: Cluster epoch increment interval -* xref:reference:properties/cluster-properties.adoc#cloud_topics_epoch_service_local_epoch_cache_duration[`cloud_topics_epoch_service_local_epoch_cache_duration`]: Local epoch cache duration -* xref:reference:properties/cluster-properties.adoc#cloud_topics_short_term_gc_backoff_interval[`cloud_topics_short_term_gc_backoff_interval`]: Short-term garbage collection backoff interval -* xref:reference:properties/cluster-properties.adoc#cloud_topics_short_term_gc_interval[`cloud_topics_short_term_gc_interval`]: Short-term garbage collection interval -* xref:reference:properties/cluster-properties.adoc#cloud_topics_short_term_gc_minimum_object_age[`cloud_topics_short_term_gc_minimum_object_age`]: Minimum object age for garbage collection - -**Other configuration:** - -* xref:reference:properties/cluster-properties.adoc#controller_backend_reconciliation_concurrency[`controller_backend_reconciliation_concurrency`]: Maximum concurrent controller reconciliation operations -* xref:reference:properties/cluster-properties.adoc#fetch_max_read_concurrency[`fetch_max_read_concurrency`]: Maximum concurrent partition reads per fetch request -* xref:reference:properties/cluster-properties.adoc#kafka_max_message_size_upper_limit_bytes[`kafka_max_message_size_upper_limit_bytes`]: Maximum allowed `max.message.size` topic property value -* xref:reference:properties/cluster-properties.adoc#kafka_produce_batch_validation[`kafka_produce_batch_validation`]: Validation level for produced batches -* xref:reference:properties/cluster-properties.adoc#log_compaction_tx_batch_removal_enabled[`log_compaction_tx_batch_removal_enabled`]: Enable transactional batch removal during compaction -* xref:reference:properties/cluster-properties.adoc#sasl_mechanisms_overrides[`sasl_mechanisms_overrides`]: SASL authentication mechanisms per listener - -=== Changes to default values - -The following configuration properties have new default values in v25.3: - -* xref:reference:properties/cluster-properties.adoc#core_balancing_continuous[`core_balancing_continuous`]: Changed from `false` to `true` (Enterprise license required). -* xref:reference:properties/cluster-properties.adoc#partition_autobalancing_mode[`partition_autobalancing_mode`]: Changed from `node_add` to `continuous` (Enterprise license required). -* xref:reference:properties/cluster-properties.adoc#iceberg_throttle_backlog_size_ratio[`iceberg_throttle_backlog_size_ratio`]: Changed from `0.3` to `null`. - -[[behavior-changes]] -=== Behavior changes - -The following topic properties now support enhanced tristate behavior: - -* xref:reference:properties/topic-properties.adoc#segment-ms[`segment.ms`] -* xref:reference:properties/topic-properties.adoc#retention-bytes[`retention.bytes`] -* xref:reference:properties/topic-properties.adoc#retention-ms[`retention.ms`] -* xref:reference:properties/topic-properties.adoc#retention-local-target-bytes[`retention.local.target.bytes`] -* xref:reference:properties/topic-properties.adoc#retention-local-target-ms[`retention.local.target.ms`] -* xref:reference:properties/topic-properties.adoc#initial-retention-local-target-bytes[`initial.retention.local.target.bytes`] -* xref:reference:properties/topic-properties.adoc#initial-retention-local-target-ms[`initial.retention.local.target.ms`] -* xref:reference:properties/topic-properties.adoc#delete-retention-ms[`delete.retention.ms`] -* xref:reference:properties/topic-properties.adoc#min-cleanable-dirty-ratio[`min.cleanable.dirty.ratio`] - -Previously, these properties treated zero and negative values the same way. Now they support three distinct states: positive values set specific limits, zero provides immediate eligibility for cleanup/compaction, and negative values disable the feature entirely. Review your topic configurations if you currently use zero values for these properties. +* xref:reference:rpk/rpk-profile/rpk-profile-validate.adoc[`rpk profile validate`] - Validate profile configuration and detect common issues such as cloud settings, authentication references, and token expiry. -=== Deprecations +== New global flag -The following configuration properties have been deprecated in v25.3 and will be removed in a future release: +All `rpk` commands now support the `--ignore-profile` flag, which ignores `rpk.yaml` and `redpanda.yaml` and uses default settings instead. -* `kafka_memory_batch_size_estimate_for_fetch`: No replacement. Remove from configuration. -* `log_compaction_disable_tx_batch_removal`: Use xref:reference:properties/cluster-properties.adoc#log_compaction_tx_batch_removal_enabled[`log_compaction_tx_batch_removal_enabled`] instead. Note the inverted logic: the new property enables the behavior when set to `true`. -* `log_message_timestamp_alert_after_ms`: Use xref:reference:properties/cluster-properties.adoc#log_message_timestamp_after_max_ms[`log_message_timestamp_after_max_ms`] instead. -* `log_message_timestamp_alert_before_ms`: Use xref:reference:properties/cluster-properties.adoc#log_message_timestamp_before_max_ms[`log_message_timestamp_before_max_ms`] instead. -* `raft_recovery_default_read_size`: No replacement. Remove from configuration. +== Updated commands -== Deprecated features +The following `rpk` commands have been updated: -Redpanda has deprecated support for specific TLSv1.2 and TLSv1.3 cipher suites and now uses more secure defaults. See xref:upgrade:deprecated/index.adoc[Deprecated Features] for the complete list. +* xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[`rpk cluster quotas alter`] - Now supports three entity types: `user`, `client-id`, and `client-id-prefix`. +* xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[`rpk cluster storage restore start`] - Updated to restore full cluster data including metadata. New `--cluster-uuid-override` flag. +* xref:reference:rpk/rpk-profile/rpk-profile.adoc[`rpk profile`] - Documents the `RPK_PROFILE` environment variable for temporarily overriding the current profile. +* xref:reference:rpk/rpk-profile/rpk-profile-prompt.adoc[`rpk profile prompt`] - New `raw` modifier to disable ANSI color escapes. +* xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc[`rpk redpanda admin brokers decommission`] - New `--skip-liveness-check` flag replaces the hidden `--force` flag. +* xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc[`rpk redpanda admin config log-level set`] - New `--help-loggers` flag to display available loggers from the cluster. +* xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[`rpk registry schema create`] - New `--metadata-properties` flag for schema metadata. +* xref:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[`rpk registry schema get`] - New `--print-metadata` flag for schema metadata properties. +* xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`] - New `--format` flag for JSON/YAML output and `--print-registry` flag for schema registry configuration. From 207ae942572f7287abd134a1cb28214d4c64d9b8 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 23 Feb 2026 18:15:01 -0300 Subject: [PATCH 2/3] new changes to v26.1 --- modules/ROOT/nav.adoc | 1 + .../rpk-cluster/rpk-cluster-quotas-alter.adoc | 2 +- .../rpk-cluster-storage-restore-start.adoc | 8 +- .../rpk/rpk-group/rpk-group-describe.adoc | 4 +- .../rpk/rpk-profile/rpk-profile-edit.adoc | 2 + .../rpk/rpk-profile/rpk-profile-prompt.adoc | 10 + .../rpk/rpk-profile/rpk-profile-set.adoc | 2 +- .../rpk/rpk-profile/rpk-profile-validate.adoc | 55 +++++ .../pages/rpk/rpk-profile/rpk-profile.adoc | 2 + ...k-redpanda-admin-brokers-decommission.adoc | 4 +- ...k-redpanda-admin-config-log-level-set.adoc | 15 +- .../rpk-registry-compatibility-level-get.adoc | 72 ++++--- .../rpk-registry-compatibility-level-set.adoc | 114 +++++----- .../rpk-registry-compatibility-level.adoc | 64 +++--- .../rpk-registry-schema-create.adoc | 172 ++++++++------- .../rpk-registry/rpk-registry-schema-get.adoc | 116 +++++----- .../rpk-registry/rpk-registry-subject.adoc | 64 +++--- .../pages/rpk/rpk-registry/rpk-registry.adoc | 76 +++---- .../rpk/rpk-shadow/rpk-shadow-describe.adoc | 13 ++ .../rpk-transform/rpk-transform-build.adoc | 92 ++++---- .../rpk-transform/rpk-transform-deploy.adoc | 204 +++++++++--------- .../rpk/rpk-transform/rpk-transform-init.adoc | 100 ++++----- .../rpk/rpk-transform/rpk-transform.adoc | 78 +++---- 23 files changed, 703 insertions(+), 567 deletions(-) create mode 100644 modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 5eb34695dc..0e27f16916 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -418,6 +418,7 @@ **** xref:reference:rpk/rpk-profile/rpk-profile-set.adoc[] **** xref:reference:rpk/rpk-profile/rpk-profile-set-globals.adoc[] **** xref:reference:rpk/rpk-profile/rpk-profile-use.adoc[] +**** xref:reference:rpk/rpk-profile/rpk-profile-validate.adoc[] *** xref:reference:rpk/rpk-registry/rpk-registry.adoc[] **** xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level.adoc[] ***** xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc index 5d11cf7526..807b3a3b0e 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc @@ -5,7 +5,7 @@ Add or delete a client quota. A client quota consists of an entity (to which the quota is applied) and a quota type (what is being applied). -There are two entity types supported by Redpanda: client ID and client ID prefix. Use the `--default` flag to assign quotas to default entity types. +There are three entity types supported by Redpanda: user, client ID, and client ID prefix. Use the `--default` flag to assign quotas to default entity types. You can perform a dry run using the `--dry` flag. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc index 4a37a8c383..0087c91c28 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc @@ -1,9 +1,11 @@ = rpk cluster storage restore start :page-aliases: reference:rpk/rpk-cluster/rpk-cluster-storage-recovery-start.adoc -Start the topic restoration process. +Start the cluster restoration process. -This command starts the process of restoring topics from the archival bucket. If the wait flag (--wait/-w) is set, the command will poll the status of the recovery process until it's finished. +This command starts the process of restoring data from a failed cluster with Tiered Storage enabled, including its metadata, onto a new cluster. If the wait flag (--wait/-w) is set, the command will poll the status of the recovery process until it's finished. + +Use `--cluster-uuid-override` if you want to specify an explicit cluster UUID to restore from. See also: xref:manage:whole-cluster-restore.adoc[]. @@ -27,6 +29,8 @@ restore, recovery |=== |*Value* |*Type* |*Description* +|--cluster-uuid-override |string |Explicit cluster UUID to restore from; uses the latest if unset. + |-h, --help |- |Help for start. |--polling-interval |duration |The status check interval (e.g. '30s', '1.5m'); ignored if --wait is not used (default 5s). diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc index 35ccf8e46a..362f4917e0 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc @@ -53,11 +53,11 @@ Describe groups `` and ``: rpk group describe ---- -Describe any group starting with f and ending in r: +Describe any group starting with f or ending in r: [,bash] ---- -rpk group describe -r '^f.*' '.*r$' +rpk group describe '^f.*' '.*r$' --regex ---- diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc index 963061c38d..92fe485f0f 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc @@ -5,6 +5,8 @@ Edit an `rpk profile`. This command opens your default editor to edit the specified profile, or the current profile if no profile is specified. If the profile does not exist, this command creates it and switches to it. +The editor will display all available configuration fields. Fields that are not currently set are shown as comments with documentation. To set a field, uncomment it and provide a value. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc index 4251478181..052c6b92a0 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc @@ -51,6 +51,16 @@ The `bg-` prefix modifies the background color: `bg-black`, `bg-hi-red`, for exa Four modifiers are supported: "bold", "faint", "underline", and "invert". +== Raw mode + +The `raw` modifier disables ANSI color escapes entirely, outputting plain text. This is useful when your shell has issues with ANSI escape sequences affecting terminal width calculations. + +[,text] +---- +prompt: raw, "%n" +prompt: raw, "[%p]" +---- + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc index b882868624..5309b7f246 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc @@ -12,7 +12,7 @@ The key can either be the name of a `-X` flag or the path to the field in the pr `--set kafka_api.tls.enabled=true` -is equivalent. The former corresponds to the `-X` flag `tls.enabled`, while the latter corresponds to the path `kafka_api.tls.enabled` in the profile's yaml. +is equivalent. The former corresponds to the `-X` flag `tls.enabled`, while the latter corresponds to the path `kafka_api.tls.enabled` in the profile's yaml. To see all available `-X` fields, run `rpk -X help`. This command supports autocompletion of valid keys, suggesting the `-X` key format. If you begin writing a YAML path, this command will suggest the rest of diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc new file mode 100644 index 0000000000..0d882d0a83 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc @@ -0,0 +1,55 @@ += rpk profile validate +// tag::single-source[] + +Validate profile configuration and detect common issues. + +This command checks the current profile (or a specified profile) for: + +* Cloud settings: Whether the `from_cloud` setting matches the broker URLs +* Auth reference: Whether the profile references a valid authentication +* Auth kind: Whether the authentication type is correctly configured +* Auth token: Whether the token exists and has not expired + +== Usage + +[,bash] +---- +rpk profile validate [PROFILE_NAME] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for validate. + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +== Examples + +Validate the current profile: + +[,bash] +---- +rpk profile validate +---- + +Validate a specific profile: + +[,bash] +---- +rpk profile validate my-profile +---- + +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc index 9563885a09..91db109f9c 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc @@ -11,6 +11,8 @@ Multiple profiles may be useful if, for example, you use `rpk` to talk to a localhost cluster, a dev cluster, and a prod cluster, and you want to keep your configuration in one place. +You can also use the `RPK_PROFILE` environment variable to temporarily override the current profile without modifying your configuration. The `--profile` flag takes precedence over the environment variable if both are set. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc index 8387a0b77e..9d0a090b5c 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc @@ -14,7 +14,7 @@ NOTE: For safety on v22.x clusters, this command will not run if the requested broker is in maintenance mode. As of v23.x, Redpanda supports decommissioning a node that is currently in maintenance mode. If you are on a v22.x cluster and need to bypass the maintenance mode check (perhaps your -cluster is unreachable), use the hidden `--force` flag. +cluster is unreachable), use the `--skip-liveness-check` flag. == Usage @@ -31,6 +31,8 @@ rpk redpanda admin brokers decommission [BROKER ID] [flags] |-h, --help |- |Help for decommission. +|--skip-liveness-check |- |If enabled, rpk will issue the decommission request without checking if the broker is in maintenance mode. + |--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc index f5f2565ac0..eee14223ec 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc @@ -14,16 +14,19 @@ It is optional to specify a logger; if you do not, this command will prompt from the set of available loggers. The special logger `all` enables all loggers. Alternatively, you can specify -many loggers at once. To see all possible loggers, run the following command: - ----- -redpanda --help-loggers ----- +many loggers at once. This command accepts loggers that it does not know of to ensure you can independently update your redpanda installations from `rpk`. The success or failure of enabling each logger is individually printed. +You can use `--help-loggers` to display available loggers: + +[,bash] +---- +rpk redpanda admin config log-level set --help-loggers [--host ] +---- + == Usage [,bash] @@ -43,6 +46,8 @@ shutdown) (default 300). |-h, --help |- |Help for set. +|--help-loggers |- |Display the list of available loggers. + |--host |string |Either a hostname or an index into `rpk.admin_api.addresses` config section to select the hosts to issue the request to. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc index ce3c9b50bf..7a371c0e09 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc @@ -1,36 +1,38 @@ -= rpk registry compatibility-level get -// tag::single-source[] - -Get the global or per-subject compatibility levels. - -Running this command with no subject returns the global compatibility level. Use the `--global` flag to get the global level at the same time as per-subject levels. - -== Usage - -[,bash] ----- -rpk registry compatibility-level get [SUBJECT...] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--global |- |Return the global level in addition to subject levels. - -|-h, --help |- |Help for get. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry compatibility-level get +// tag::single-source[] + +Get the global or per-subject compatibility levels. + +Running this command with no subject returns the global compatibility level. Use the `--global` flag to get the global level at the same time as per-subject levels. + +== Usage + +[,bash] +---- +rpk registry compatibility-level get [SUBJECT...] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--global |- |Return the global level in addition to subject levels. + +|-h, --help |- |Help for get. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc index 4d7ae43f66..8ac097d5ae 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc @@ -1,57 +1,59 @@ -= rpk registry compatibility-level set -// tag::single-source[] - -Set the global or per-subject compatibility levels. - -Running this command without a subject sets the global compatibility level. To set the global level at the same time as per-subject levels, use the `--global` flag. - -== Concept - -=== Levels - -- BACKWARD (default): Consumers using the new schema (for example, version 10) can read data from producers using the previous schema (for example, version 9). - -- BACKWARD_TRANSITIVE: Consumers using the new schema (for example, version 10) can read data from producers using all previous schemas (for example, versions 1-9). - -- FORWARD: Consumers using the previous schema (for example, version 9) can read data from producers using the new schema (for example, version 10). - -- FORWARD_TRANSITIVE: Consumers using any previous schema (for example, versions 1-9) can read data from producers using the new schema (for example, version 10). - -- FULL: A new schema and the previous schema (for example, versions 10 and 9) are both backward and forward compatible with each other. - -- FULL_TRANSITIVE: Each schema is both backward and forward compatible with all registered schemas. - -- NONE: No schema compatibility checks are done. - - -== Usage - -[,bash] ----- -rpk registry compatibility-level set [SUBJECT...] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--global |- |Set the global level in addition to subject levels. - -|-h, --help |- |Help for set. - -|--level |string |Level to set, one of `NONE`, `BACKWARD`,`BACKWARD_TRANSITIVE`, `FORWARD`,`FORWARD_TRANSITIVE`, `FULL`, `FULL_TRANSITIVE`. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry compatibility-level set +// tag::single-source[] + +Set the global or per-subject compatibility levels. + +Running this command without a subject sets the global compatibility level. To set the global level at the same time as per-subject levels, use the `--global` flag. + +== Concept + +=== Levels + +- BACKWARD (default): Consumers using the new schema (for example, version 10) can read data from producers using the previous schema (for example, version 9). + +- BACKWARD_TRANSITIVE: Consumers using the new schema (for example, version 10) can read data from producers using all previous schemas (for example, versions 1-9). + +- FORWARD: Consumers using the previous schema (for example, version 9) can read data from producers using the new schema (for example, version 10). + +- FORWARD_TRANSITIVE: Consumers using any previous schema (for example, versions 1-9) can read data from producers using the new schema (for example, version 10). + +- FULL: A new schema and the previous schema (for example, versions 10 and 9) are both backward and forward compatible with each other. + +- FULL_TRANSITIVE: Each schema is both backward and forward compatible with all registered schemas. + +- NONE: No schema compatibility checks are done. + + +== Usage + +[,bash] +---- +rpk registry compatibility-level set [SUBJECT...] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--global |- |Set the global level in addition to subject levels. + +|-h, --help |- |Help for set. + +|--level |string |Level to set, one of `NONE`, `BACKWARD`,`BACKWARD_TRANSITIVE`, `FORWARD`,`FORWARD_TRANSITIVE`, `FULL`, `FULL_TRANSITIVE`. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc index 1e2c22be68..59b6725de5 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc @@ -1,32 +1,34 @@ -= rpk registry compatibility-level -// tag::single-source[] - -Manage global or per-subject compatibility levels. - -== Usage - -[,bash] ----- -rpk registry compatibility-level [flags] [command] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|-h, --help |- |Help for compatibility-level. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry compatibility-level +// tag::single-source[] + +Manage global or per-subject compatibility levels. + +== Usage + +[,bash] +---- +rpk registry compatibility-level [flags] [command] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|-h, --help |- |Help for compatibility-level. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc index 523a0815c2..847c3ed4e8 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc @@ -1,78 +1,96 @@ -= rpk registry schema create -// tag::single-source[] - -Create a schema for the given subject. - - -This uploads a schema to the registry, creating the schema if it does not exist. The schema type is detected by the filename extension: `.avro` or `.avsc` for Avro, `json` for JSON, and `.proto` for Protobuf. You can manually specify the type with the `--type` flag. - -You may pass the references using the --reference flag, which accepts either a comma separated list of `::` or a path to a file. The file must contain lines of name, subject, and version separated by a tab or space, or the equivalent in json / yaml format. - -== Examples - -Create a Protobuf schema with subject `foo`: - -[,bash] ----- -rpk registry schema create foo --schema path/to/file.proto ----- - -Create an avro schema, passing the type via flags: - -[,bash] ----- -rpk registry schema create foo --schema /path/to/file --type avro ----- - -Create a Protobuf schema that references the schema in subject `my_subject`, version 1: - -[,bash] ----- -rpk registry schema create foo --schema /path/to/file.proto --references my_name:my_subject:1 ----- - -Create a schema with a specific ID and version in import mode: - -[,bash] ----- -rpk registry schema create foo --schema /path/to/file.proto --id 42 --schema-version 3 ----- - -== Usage - -[,bash] ----- -rpk registry schema create SUBJECT --schema {filename} [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for create. - -|--id |int |Optional schema ID to use when creating the schema in import mode (default `-1`). - -|--references |string |Comma-separated list of references (name:subject:version) or path to reference file. - -|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, or `.proto`. - -|--schema-version |int |Optional schema version to use when creating the schema in import mode (requires `--id` and the default is `-1`). - - -|--type |string |Schema type `avro` or `protobuf` ; overrides schema file extension. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry schema create +// tag::single-source[] + +Create a schema for the given subject. + + +This uploads a schema to the registry, creating the schema if it does not exist. The schema type is detected by the filename extension: `.avro` or `.avsc` for Avro, `json` for JSON, and `.proto` for Protobuf. You can manually specify the type with the `--type` flag. + +You may pass the references using the --reference flag, which accepts either a comma separated list of `::` or a path to a file. The file must contain lines of name, subject, and version separated by a tab or space, or the equivalent in json / yaml format. + +== Examples + +Create a Protobuf schema with subject `foo`: + +[,bash] +---- +rpk registry schema create foo --schema path/to/file.proto +---- + +Create an avro schema, passing the type via flags: + +[,bash] +---- +rpk registry schema create foo --schema /path/to/file --type avro +---- + +Create a Protobuf schema that references the schema in subject `my_subject`, version 1: + +[,bash] +---- +rpk registry schema create foo --schema /path/to/file.proto --references my_name:my_subject:1 +---- + +Create a schema with a specific ID and version in import mode: + +[,bash] +---- +rpk registry schema create foo --schema /path/to/file.proto --id 42 --schema-version 3 +---- + +Create a schema with metadata properties: + +[,bash] +---- +rpk registry schema create foo --schema /path/to/file.proto --metadata-properties owner=team-a --metadata-properties env=prod +---- + +Create a schema with metadata properties using JSON format (useful for special characters): + +[,bash] +---- +rpk registry schema create foo --schema /path/to/file.proto --metadata-properties '{"owner":"team-a","env":"prod"}' +---- + +== Usage + +[,bash] +---- +rpk registry schema create SUBJECT --schema {filename} [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for create. + +|--id |int |Optional schema ID to use when creating the schema in import mode (default `-1`). + +|-p, --metadata-properties |stringArray |Schema metadata properties as key=value pairs or JSON (e.g., `{"key":"value"}`). + +|--references |string |Comma-separated list of references (name:subject:version) or path to reference file. + +|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, or `.proto`. + +|--schema-version |int |Optional schema version to use when creating the schema in import mode (requires `--id` and the default is `-1`). + + +|--type |string |Schema type `avro` or `protobuf` ; overrides schema file extension. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc index 16e88652c0..2c930e7ba7 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc @@ -1,56 +1,62 @@ -= rpk registry schema get -// tag::single-source[] - -Get a schema by version, ID, or by an existing schema. - -This returns a lookup of an existing schema or schemas in one of the following mutually exclusive ways: - -* By version, returning a schema for a required subject and version. - -* By ID, returning all subjects using the schema, or filtered by the provided subject. - -* By schema, checking if the schema has been created in the subject. - -To print the schema, use the `--print-schema` flag. - -== Usage - -[,bash] ----- -rpk registry schema get [SUBJECT] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--deleted |- |If `true`, also return deleted schemas. - -|-h, --help |- |Help for get. - -|--id |int | Schema ID to look up usage; subject optional. - -|--print-schema |- |Prints the schema in JSON format. - -|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, `json`, or `.proto`. - -|--schema-version |string |Schema version to check compatibility with (`latest`, `0`, `1`...). - -|--type |string |Schema type of the file used to lookup (`avro`, `json`, `protobuf`). Overrides schema file extension. - - -|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. - - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry schema get +// tag::single-source[] + +Get a schema by version, ID, or by an existing schema. + +This returns a lookup of an existing schema or schemas in one of the following mutually exclusive ways: + +* By version, returning a schema for a required subject and version. + +* By ID, returning all subjects using the schema, or filtered by the provided subject. + +* By schema, checking if the schema has been created in the subject. + +To print the schema, use the `--print-schema` flag. + +To print schema metadata properties, use the `--print-metadata` flag. + +== Usage + +[,bash] +---- +rpk registry schema get [SUBJECT] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--deleted |- |If `true`, also return deleted schemas. + +|-h, --help |- |Help for get. + +|--id |int | Schema ID to look up usage; subject optional. + +|--print-metadata |- |Print the schema metadata properties. + +|--print-schema |- |Prints the schema in JSON format. + +|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, `json`, or `.proto`. + +|--schema-version |string |Schema version to check compatibility with (`latest`, `0`, `1`...). + +|--type |string |Schema type of the file used to lookup (`avro`, `json`, `protobuf`). Overrides schema file extension. + + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc index 0586d29600..43d1482444 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc @@ -1,32 +1,34 @@ -= rpk registry subject -// tag::single-source[] - -List or delete Schema Registry subjects. - -== Usage - -[,bash] ----- -rpk registry subject [command] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|-h, --help |- |Help for subject. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry subject +// tag::single-source[] + +List or delete Schema Registry subjects. + +== Usage + +[,bash] +---- +rpk registry subject [command] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|-h, --help |- |Help for subject. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc index f093b026e7..c8bcd3201d 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc @@ -1,38 +1,40 @@ -= rpk registry -// tag::single-source[] -:description: pass:q[These commands let you manage Redpanda Schema Registry.] - -Commands to interact with the Schema Registry. - -== Usage - -[,bash] ----- -rpk registry [command] [flags] ----- - -== Aliases - -[,bash] ----- -registry, sr ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for registry. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry +// tag::single-source[] +:description: pass:q[These commands let you manage Redpanda Schema Registry.] + +Commands to interact with the Schema Registry. + +== Usage + +[,bash] +---- +rpk registry [command] [flags] +---- + +== Aliases + +[,bash] +---- +registry, sr +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for registry. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc index 8328e04c6d..3a73930de3 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc @@ -7,6 +7,8 @@ This command shows the shadow link configuration, including connection settings, By default, the command displays the overview and client configuration sections. Use the flags to display additional sections such as topic synchronization, consumer offset synchronization, and security synchronization settings. +Using the `--format` flag with JSON or YAML will output the full configuration in the specified format, ignoring section flags. + ifdef::env-cloud[] The command uses the Redpanda ID of the cluster you are currently logged into. To use a different cluster, either log in and create a profile for it, or use the `--redpanda-id` flag to specify it directly. endif::[] @@ -48,12 +50,21 @@ Display only the client configuration: rpk shadow describe my-shadow-link -c ---- +Display output as JSON: + +[,bash] +---- +rpk shadow describe my-shadow-link --format json +---- + == Flags [cols="1m,1a,2a"] |=== |*Value* |*Type* |*Description* +|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. + |-a, --print-all |- |Print all sections. |-c, --print-client |- |Print the client configuration section. @@ -62,6 +73,8 @@ rpk shadow describe my-shadow-link -c |-o, --print-overview |- |Print the overview section. +|-y, --print-registry |- |Print the detailed schema registry configuration section. + |-s, --print-security |- |Print the detailed security configuration section. |-t, --print-topic |- |Print the detailed topic configuration section. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc index 9ddbcdf5ae..87ce305c6e 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc @@ -1,46 +1,48 @@ -= rpk transform build -:page-aliases: labs:data-transform/rpk-transform-build.adoc -// tag::single-source[] - -Build a data transform. - -This command looks in the current working directory for a `transform.yaml` file. It installs the appropriate build plugin, then builds a `.wasm` file. - -When invoked, it passes extra arguments directly to the underlying toolchain. - -For example, to add debug symbols and use the `asyncify` scheduler for `tinygo`: - -[,bash] ----- -rpk transform build -- -scheduler=asyncify -no-debug=false ----- - -Language-specific details: - -TinyGo - By default, TinyGo are release builds (-opt=2) and goroutines are disabled, for maximum performance. - -== Usage - -[,bash] ----- -rpk transform build [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for build. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk transform build +:page-aliases: labs:data-transform/rpk-transform-build.adoc +// tag::single-source[] + +Build a data transform. + +This command looks in the current working directory for a `transform.yaml` file. It installs the appropriate build plugin, then builds a `.wasm` file. + +When invoked, it passes extra arguments directly to the underlying toolchain. + +For example, to add debug symbols and use the `asyncify` scheduler for `tinygo`: + +[,bash] +---- +rpk transform build -- -scheduler=asyncify -no-debug=false +---- + +Language-specific details: + +TinyGo - By default, TinyGo are release builds (-opt=2) and goroutines are disabled, for maximum performance. + +== Usage + +[,bash] +---- +rpk transform build [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for build. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc index ff6c0cf0d6..8526e8c913 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc @@ -1,102 +1,104 @@ -= rpk transform deploy -:page-aliases: labs:data-transform/rpk-transform-deploy.adoc -// tag::single-source[] - -Deploy a data transform. - -When run in the same directory as a `transform.yaml`, this reads the configuration file, then looks for a `.wasm` file with the same name as your project. If the input and output topics are specified in the configuration file, those are used. Otherwise, the topics can be specified on the command line using the `--input-topic` and `--output-topic` flags. - -You can specify environment variables for the transform using the `--var` flag. Variables are separated by an equal sign. For example: `--var=KEY=VALUE`. The `--var` flag can be repeated to specify multiple variables. - -You can specify the `--from-offset` flag to identify where on the input topic the transform should begin processing. Expressed as: - -- `@T` - Begin reading records with committed timestamp >= T (UNIX time, ms from epoch) - -- `+N` - Begin reading N records from the start of each input partition - -- `-N` - Begin reading N records prior to the end of each input partition - -Note that the broker will only respect `--from-offset` on the first deploy for a given transform. Re-deploying the transform will cause processing to pick up at the last committed offset. This state is maintained until the transform is deleted. - -== Usage - -[,bash] ----- -rpk transform deploy [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--compression |string |Output batch compression type. - -|--file |string |The WebAssembly module to deploy. - -|--from-offset |string |Process an input topic partition from a relative offset. - -|-h, --help |- |Help for deploy. - -|-i, --input-topic |string |The input topic to apply the transform to. - -|--name |string |The name of the transform. - -|-o, --output-topic |strings |The output topic to write the transform results to (repeatable). - -|--var |environmentVariable |Specify an environment variable in the form of KEY=VALUE. - -|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - - -== Examples - -Deploy Wasm files directly without a `transform.yaml` file: - -[,bash] ----- -rpk transform deploy --file transform.wasm --name myTransform \ ---input-topic my-topic-1 \ ---output-topic my-topic-2 ---output-topic my-topic-3 ----- - -Deploy a transformation with multiple environment variables: - -[,bash] ----- -rpk transform deploy --var FOO=BAR --var FIZZ=BUZZ ----- - -Configure compression for batches output by data transforms. The default setting is `none` but you can choose from the following options: - - -* none -* gzip -* snappy -* lz4 -* zstd - -Configure this at deployment using `rpk` with the `--compression` flag: - -[,bash] ----- -rpk transform deploy --compression ----- - -ifndef::env-cloud[] -Enabling compression may increase computation costs and could impact latency at the output topic. - -For more details, see xref:deploy:deployment-option/self-hosted/manual/sizing.adoc[]. -endif::[] - - += rpk transform deploy +:page-aliases: labs:data-transform/rpk-transform-deploy.adoc +// tag::single-source[] + +Deploy a data transform. + +When run in the same directory as a `transform.yaml`, this reads the configuration file, then looks for a `.wasm` file with the same name as your project. If the input and output topics are specified in the configuration file, those are used. Otherwise, the topics can be specified on the command line using the `--input-topic` and `--output-topic` flags. + +You can specify environment variables for the transform using the `--var` flag. Variables are separated by an equal sign. For example: `--var=KEY=VALUE`. The `--var` flag can be repeated to specify multiple variables. + +You can specify the `--from-offset` flag to identify where on the input topic the transform should begin processing. Expressed as: + +- `@T` - Begin reading records with committed timestamp >= T (UNIX time, ms from epoch) + +- `+N` - Begin reading N records from the start of each input partition + +- `-N` - Begin reading N records prior to the end of each input partition + +Note that the broker will only respect `--from-offset` on the first deploy for a given transform. Re-deploying the transform will cause processing to pick up at the last committed offset. This state is maintained until the transform is deleted. + +== Usage + +[,bash] +---- +rpk transform deploy [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--compression |string |Output batch compression type. + +|--file |string |The WebAssembly module to deploy. + +|--from-offset |string |Process an input topic partition from a relative offset. + +|-h, --help |- |Help for deploy. + +|-i, --input-topic |string |The input topic to apply the transform to. + +|--name |string |The name of the transform. + +|-o, --output-topic |strings |The output topic to write the transform results to (repeatable). + +|--var |environmentVariable |Specify an environment variable in the form of KEY=VALUE. + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + + +== Examples + +Deploy Wasm files directly without a `transform.yaml` file: + +[,bash] +---- +rpk transform deploy --file transform.wasm --name myTransform \ +--input-topic my-topic-1 \ +--output-topic my-topic-2 +--output-topic my-topic-3 +---- + +Deploy a transformation with multiple environment variables: + +[,bash] +---- +rpk transform deploy --var FOO=BAR --var FIZZ=BUZZ +---- + +Configure compression for batches output by data transforms. The default setting is `none` but you can choose from the following options: + + +* none +* gzip +* snappy +* lz4 +* zstd + +Configure this at deployment using `rpk` with the `--compression` flag: + +[,bash] +---- +rpk transform deploy --compression +---- + +ifndef::env-cloud[] +Enabling compression may increase computation costs and could impact latency at the output topic. + +For more details, see xref:deploy:deployment-option/self-hosted/manual/sizing.adoc[]. +endif::[] + + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc index 9c042322ec..e17181d06f 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc @@ -1,50 +1,52 @@ -= rpk transform init -:page-aliases: labs:data-transform/rpk-transform-init.adoc -// tag::single-source[] - -Initialize a transform. - -Create a new data transform using a template in the current directory. - -== Example - -Specify a new directory to create by specifying it in the command: - -[,bash] ----- -rpk transform init foobar ----- - -This initializes a transform project in the foobar directory. - -== Usage - -[,bash] ----- -rpk transform init [DIRECTORY] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for `rpk transform init`` - -|--install-deps |- |If dependencies should be installed for the project (default prompt). - -|-l, --language |string |The language used to develop the transform. - -|--name |string |The name of the transform. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk transform init +:page-aliases: labs:data-transform/rpk-transform-init.adoc +// tag::single-source[] + +Initialize a transform. + +Create a new data transform using a template in the current directory. + +== Example + +Specify a new directory to create by specifying it in the command: + +[,bash] +---- +rpk transform init foobar +---- + +This initializes a transform project in the foobar directory. + +== Usage + +[,bash] +---- +rpk transform init [DIRECTORY] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for `rpk transform init`` + +|--install-deps |- |If dependencies should be installed for the project (default prompt). + +|-l, --language |string |The language used to develop the transform. + +|--name |string |The name of the transform. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc index 892d1aa039..784da0e6fe 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc @@ -1,39 +1,41 @@ -= rpk transform -:page-aliases: labs:data-transform/rpk-transform.adoc -// tag::single-source[] -:description: pass:q[These commands let you build and manage data transforms with WebAssembly.] - -Develop, deploy, and manage Redpanda data transforms. - -== Usage - -[,bash] ----- -rpk transform [command] [flags] ----- - -== Aliases - -[,bash] ----- -transform, wasm, transfrom ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|-h, --help |- |Help for transform. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk transform +:page-aliases: labs:data-transform/rpk-transform.adoc +// tag::single-source[] +:description: pass:q[These commands let you build and manage data transforms with WebAssembly.] + +Develop, deploy, and manage Redpanda data transforms. + +== Usage + +[,bash] +---- +rpk transform [command] [flags] +---- + +== Aliases + +[,bash] +---- +transform, wasm, transfrom +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for transform. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file From e8838bfcd3accc94ec3f56768ff054ad7a7d26ca Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 23 Feb 2026 18:15:28 -0300 Subject: [PATCH 3/3] global flag change ignore-profile --- .../rpk-cluster/rpk-cluster-config-edit.adoc | 2 + .../rpk-cluster-config-export.adoc | 2 + .../rpk-cluster-config-force-reset.adoc | 2 + .../rpk-cluster/rpk-cluster-config-get.adoc | 2 + .../rpk-cluster-config-import.adoc | 2 + .../rpk-cluster/rpk-cluster-config-lint.adoc | 2 + .../rpk-cluster/rpk-cluster-config-list.adoc | 2 + .../rpk-cluster/rpk-cluster-config-set.adoc | 2 + .../rpk-cluster-config-status.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-config.adoc | 2 + .../rpk-cluster-connections-list.adoc | 2 + .../rpk-cluster/rpk-cluster-connections.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-health.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-info.adoc | 2 + .../rpk-cluster/rpk-cluster-license-info.adoc | 2 + .../rpk-cluster/rpk-cluster-license-set.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-license.adoc | 2 + .../rpk-cluster-logdirs-describe.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-logdirs.adoc | 2 + .../rpk-cluster-maintenance-disable.adoc | 2 + .../rpk-cluster-maintenance-enable.adoc | 2 + .../rpk-cluster-maintenance-status.adoc | 2 + .../rpk-cluster/rpk-cluster-maintenance.adoc | 2 + .../rpk-cluster-partitions-balance.adoc | 2 + ...pk-cluster-partitions-balancer-status.adoc | 2 + .../rpk-cluster-partitions-disable.adoc | 2 + .../rpk-cluster-partitions-enable.adoc | 2 + .../rpk-cluster-partitions-list.adoc | 2 + .../rpk-cluster-partitions-move-cancel.adoc | 2 + .../rpk-cluster-partitions-move-status.adoc | 2 + .../rpk-cluster-partitions-move.adoc | 2 + ...luster-partitions-transfer-leadership.adoc | 2 + ...rpk-cluster-partitions-unsafe-recover.adoc | 2 + .../rpk-cluster/rpk-cluster-partitions.adoc | 2 + .../rpk-cluster/rpk-cluster-quotas-alter.adoc | 2 + .../rpk-cluster-quotas-describe.adoc | 2 + .../rpk-cluster-quotas-import.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-quotas.adoc | 2 + .../rpk-cluster-self-test-start.adoc | 2 + .../rpk-cluster-self-test-status.adoc | 2 + .../rpk-cluster-self-test-stop.adoc | 2 + .../rpk-cluster/rpk-cluster-self-test.adoc | 2 + .../rpk-cluster-storage-cancel-mount.adoc | 2 + .../rpk-cluster-storage-list-mount.adoc | 2 + .../rpk-cluster-storage-list-mountable.adoc | 2 + .../rpk-cluster-storage-mount.adoc | 2 + .../rpk-cluster-storage-restore-start.adoc | 2 + .../rpk-cluster-storage-restore-status.adoc | 2 + .../rpk-cluster-storage-restore.adoc | 2 + .../rpk-cluster-storage-status-mount.adoc | 2 + .../rpk-cluster-storage-unmount.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-storage.adoc | 2 + .../rpk-cluster-txn-describe-producers.adoc | 2 + .../rpk-cluster/rpk-cluster-txn-describe.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-txn-list.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-txn.adoc | 2 + .../pages/rpk/rpk-cluster/rpk-cluster.adoc | 2 + .../rpk/rpk-connect/rpk-connect-install.adoc | 2 + .../rpk-connect/rpk-connect-uninstall.adoc | 2 + .../rpk/rpk-connect/rpk-connect-upgrade.adoc | 2 + .../pages/rpk/rpk-connect/rpk-connect.adoc | 2 + .../rpk-container/rpk-container-purge.adoc | 2 + .../rpk-container/rpk-container-start.adoc | 2 + .../rpk-container/rpk-container-status.adoc | 2 + .../rpk/rpk-container/rpk-container-stop.adoc | 2 + .../rpk/rpk-container/rpk-container.adoc | 2 + .../pages/rpk/rpk-debug/rpk-debug-bundle.adoc | 2 + .../rpk-debug-remote-bundle-cancel.adoc | 2 + .../rpk-debug-remote-bundle-download.adoc | 2 + .../rpk-debug-remote-bundle-start.adoc | 2 + .../rpk-debug-remote-bundle-status.adoc | 2 + .../rpk-debug/rpk-debug-remote-bundle.adoc | 2 + .../pages/rpk/rpk-debug/rpk-debug.adoc | 2 + .../rpk/rpk-generate/rpk-generate-app.adoc | 2 + .../rpk-generate-grafana-dashboard.adoc | 2 + .../rpk-generate/rpk-generate-license.adoc | 2 + .../rpk-generate-prometheus-config.adoc | 2 + .../rpk-generate-shell-completion.adoc | 2 + .../pages/rpk/rpk-generate/rpk-generate.adoc | 2 + .../pages/rpk/rpk-group/rpk-group-delete.adoc | 2 + .../rpk/rpk-group/rpk-group-describe.adoc | 2 + .../pages/rpk/rpk-group/rpk-group-list.adoc | 2 + .../rpk-group/rpk-group-offset-delete.adoc | 2 + .../pages/rpk/rpk-group/rpk-group-seek.adoc | 2 + .../pages/rpk/rpk-group/rpk-group.adoc | 2 + modules/reference/pages/rpk/rpk-help.adoc | 2 + modules/reference/pages/rpk/rpk-iotune.adoc | 2 + .../rpk/rpk-plugin/rpk-plugin-install.adoc | 2 + .../pages/rpk/rpk-plugin/rpk-plugin-list.adoc | 2 + .../rpk/rpk-plugin/rpk-plugin-uninstall.adoc | 2 + .../pages/rpk/rpk-plugin/rpk-plugin.adoc | 2 + .../rpk/rpk-profile/rpk-profile-clear.adoc | 2 + .../rpk/rpk-profile/rpk-profile-create.adoc | 2 + .../rpk/rpk-profile/rpk-profile-current.adoc | 2 + .../rpk/rpk-profile/rpk-profile-delete.adoc | 2 + .../rpk-profile/rpk-profile-edit-globals.adoc | 2 + .../rpk/rpk-profile/rpk-profile-edit.adoc | 2 + .../rpk/rpk-profile/rpk-profile-list.adoc | 2 + .../rpk-profile-print-globals.adoc | 2 + .../rpk/rpk-profile/rpk-profile-print.adoc | 2 + .../rpk/rpk-profile/rpk-profile-prompt.adoc | 2 + .../rpk-profile/rpk-profile-rename-to.adoc | 2 + .../rpk-profile/rpk-profile-set-globals.adoc | 2 + .../rpk/rpk-profile/rpk-profile-set.adoc | 2 + .../rpk/rpk-profile/rpk-profile-use.adoc | 2 + .../pages/rpk/rpk-profile/rpk-profile.adoc | 2 + ...nda-admin-brokers-decommission-status.adoc | 2 + ...k-redpanda-admin-brokers-decommission.adoc | 2 + .../rpk-redpanda-admin-brokers-list.adoc | 2 + ...k-redpanda-admin-brokers-recommission.adoc | 2 + .../rpk-redpanda-admin-brokers.adoc | 2 + ...k-redpanda-admin-config-log-level-set.adoc | 2 + .../rpk-redpanda-admin-config-log-level.adoc | 2 + .../rpk-redpanda-admin-config-print.adoc | 2 + .../rpk-redpanda-admin-config.adoc | 2 + .../rpk-redpanda-admin-partitions-list.adoc | 2 + .../rpk-redpanda-admin-partitions.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-admin.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-check.adoc | 2 + .../rpk-redpanda-config-bootstrap.adoc | 2 + .../rpk-redpanda-config-init.adoc | 2 + .../rpk-redpanda-config-print.adoc | 2 + .../rpk-redpanda/rpk-redpanda-config-set.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-config.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-mode.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-start.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-stop.adoc | 2 + .../rpk-redpanda/rpk-redpanda-tune-help.adoc | 2 + .../rpk-redpanda/rpk-redpanda-tune-list.adoc | 2 + .../rpk/rpk-redpanda/rpk-redpanda-tune.adoc | 2 + .../pages/rpk/rpk-redpanda/rpk-redpanda.adoc | 2 + .../rpk-registry/rpk-registry-mode-get.adoc | 2 + .../rpk-registry/rpk-registry-mode-reset.adoc | 2 + .../rpk-registry/rpk-registry-mode-set.adoc | 2 + .../rpk/rpk-registry/rpk-registry-mode.adoc | 2 + ...k-registry-schema-check-compatibility.adoc | 2 + .../rpk-registry-schema-delete.adoc | 2 + .../rpk-registry-schema-list.adoc | 2 + .../rpk-registry-schema-references.adoc | 2 + .../rpk/rpk-registry/rpk-registry-schema.adoc | 64 ++++++++++--------- .../rpk-registry-subject-delete.adoc | 2 + .../rpk-registry-subject-list.adoc | 2 + .../rpk-security/rpk-security-acl-create.adoc | 2 + .../rpk-security/rpk-security-acl-delete.adoc | 2 + .../rpk-security/rpk-security-acl-list.adoc | 2 + .../rpk/rpk-security/rpk-security-acl.adoc | 2 + .../rpk-security-role-assign.adoc | 2 + .../rpk-security-role-create.adoc | 2 + .../rpk-security-role-delete.adoc | 2 + .../rpk-security-role-describe.adoc | 2 + .../rpk-security/rpk-security-role-list.adoc | 2 + .../rpk-security-role-unassign.adoc | 2 + .../rpk/rpk-security/rpk-security-role.adoc | 2 + .../rpk-security-user-create.adoc | 2 + .../rpk-security-user-delete.adoc | 2 + .../rpk-security/rpk-security-user-list.adoc | 2 + .../rpk-security-user-update.adoc | 2 + .../rpk/rpk-security/rpk-security-user.adoc | 2 + .../pages/rpk/rpk-security/rpk-security.adoc | 2 + .../rpk-shadow-config-generate.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-create.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-delete.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-describe.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-failover.adoc | 2 + .../pages/rpk/rpk-shadow/rpk-shadow-list.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-status.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-update.adoc | 2 + .../pages/rpk/rpk-shadow/rpk-shadow.adoc | 2 + .../rpk-topic/rpk-topic-add-partitions.adoc | 2 + .../rpk/rpk-topic/rpk-topic-alter-config.adoc | 2 + .../rpk/rpk-topic/rpk-topic-analyze.adoc | 2 + .../rpk/rpk-topic/rpk-topic-consume.adoc | 2 + .../pages/rpk/rpk-topic/rpk-topic-create.adoc | 2 + .../pages/rpk/rpk-topic/rpk-topic-delete.adoc | 2 + .../rpk-topic/rpk-topic-describe-storage.adoc | 2 + .../rpk/rpk-topic/rpk-topic-describe.adoc | 2 + .../pages/rpk/rpk-topic/rpk-topic-list.adoc | 2 + .../rpk/rpk-topic/rpk-topic-produce.adoc | 2 + .../rpk/rpk-topic/rpk-topic-trim-prefix.adoc | 2 + .../pages/rpk/rpk-topic/rpk-topic.adoc | 2 + .../rpk-transform/rpk-transform-delete.adoc | 2 + .../rpk/rpk-transform/rpk-transform-list.adoc | 2 + .../rpk/rpk-transform/rpk-transform-logs.adoc | 2 + .../rpk-transform/rpk-transform-pause.adoc | 2 + .../rpk-transform/rpk-transform-resume.adoc | 2 + modules/reference/pages/rpk/rpk-version.adoc | 2 + 186 files changed, 403 insertions(+), 31 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc index a41689ceff..040c5e4e4f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc @@ -35,6 +35,8 @@ rpk cluster config edit [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc index b38515acba..e3c85c7386 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc @@ -32,6 +32,8 @@ rpk cluster config export [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc index 1afb545848..7b7597ad21 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc @@ -35,6 +35,8 @@ Redpanda `data` directory). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc index 5891a64570..ef9cfcf7e3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc @@ -27,6 +27,8 @@ rpk cluster config get [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc index 3bbaa185ed..4b0ab0f92f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc @@ -30,6 +30,8 @@ rpk cluster config import [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc index 5b80eccca2..f9d35847eb 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc @@ -24,6 +24,8 @@ rpk cluster config lint [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc index fddcf01a4e..7acac306b3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc @@ -78,6 +78,8 @@ rpk cluster config list --format=yaml |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc index 4b880acb84..10822d94ce 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc @@ -51,6 +51,8 @@ rpk cluster config set [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc index 118e0e9c2f..c6a9a3cfbd 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc @@ -53,6 +53,8 @@ rpk cluster config status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc index c8c5618aab..3d8d14a998 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -47,6 +47,8 @@ rpk cluster config [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc index 2202afa68c..fbc4ed0952 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc @@ -97,6 +97,8 @@ rpk cluster connections list --format=json --state="OPEN" |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc index dabb10806a..2c270e8dbd 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc @@ -29,6 +29,8 @@ connections, connection |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc index 8f21546be6..6c04dd743c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc @@ -33,6 +33,8 @@ rpk cluster health [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc index 1c2a9adf28..7b6f600fc3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc @@ -57,6 +57,8 @@ specified). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-info.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-info.adoc index bc4364fa6e..effaba2f8c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-info.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-info.adoc @@ -37,6 +37,8 @@ info, status |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc index efb2a127f2..ba437a9772 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc @@ -40,6 +40,8 @@ rpk cluster license set [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc index c12a3f0aa9..df3ef40dfd 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc @@ -21,6 +21,8 @@ rpk cluster license [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc index d27dfd1e5a..af12717229 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc @@ -45,6 +45,8 @@ form. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc index b400d448df..afa90c1100 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc @@ -22,6 +22,8 @@ rpk cluster logdirs [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-disable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-disable.adoc index dcaa9fe2e3..b0afe464ba 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-disable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-disable.adoc @@ -21,6 +21,8 @@ rpk cluster maintenance disable [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc index f21b60377b..67c8bc0031 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc @@ -26,6 +26,8 @@ rpk cluster maintenance enable [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc index f16e72a9b3..5bb3c221b8 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc @@ -52,6 +52,8 @@ rpk cluster maintenance status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc index 302c086beb..f5bc3de32c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc @@ -39,6 +39,8 @@ rpk cluster maintenance [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc index e87407bb06..25fd3a4385 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc @@ -36,6 +36,8 @@ rpk cluster partitions balance [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc index 23dea954b1..e61bec2fc7 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc @@ -84,6 +84,8 @@ rpk cluster partitions balancer-status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc index 69467de508..14a31798f3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc @@ -65,6 +65,8 @@ rpk cluster partitions disable [TOPIC] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc index 0e2a183111..9e9ad9afc4 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc @@ -59,6 +59,8 @@ rpk cluster partitions enable [TOPIC] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc index 595f0530de..871fcd6e3c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc @@ -52,6 +52,8 @@ list, ls, describe |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc index bd28695304..dce877f787 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc @@ -56,6 +56,8 @@ move-cancel, alter-cancel |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc index a4223efe80..e5ac045ec3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc @@ -62,6 +62,8 @@ rpk cluster partitions move-status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc index dfac03fa51..a7262fcecf 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc @@ -60,6 +60,8 @@ rpk cluster partitions move [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-transfer-leadership.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-transfer-leadership.adoc index e56c826031..097e1fc74b 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-transfer-leadership.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-transfer-leadership.adoc @@ -48,6 +48,8 @@ The preceding examples transfer leadership for the partition `kafka/test-topic/0 |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-unsafe-recover.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-unsafe-recover.adoc index 3162b8099f..65fbe5cefc 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-unsafe-recover.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-unsafe-recover.adoc @@ -36,6 +36,8 @@ rpk cluster partitions unsafe-recover [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc index a80ef8161c..dbe86da4aa 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc @@ -21,6 +21,8 @@ rpk cluster partitions [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc index 807b3a3b0e..ae760fe752 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc @@ -40,6 +40,8 @@ rpk cluster quotas alter [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc index b8e7422c2e..f35ca52554 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc @@ -37,6 +37,8 @@ rpk cluster quotas describe [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc index d2c1e6c640..f14104e324 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc @@ -69,6 +69,8 @@ rpk cluster quotas import [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc index 5961f9c2be..548b144f66 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc @@ -31,6 +31,8 @@ quotas, quota |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc index f74033b7a4..ef187e6570 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc @@ -68,6 +68,8 @@ on. If not set, tests will run for all node IDs. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc index 5163d60848..c3f65fdedc 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc @@ -40,6 +40,8 @@ rpk cluster self-test status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc index 9a27a3a4e4..bfe8eaa958 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc @@ -25,6 +25,8 @@ rpk cluster self-test stop [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc index 2afa0ff630..98b898f2d1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc @@ -19,6 +19,8 @@ rpk cluster self-test [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc index 92dd0e47fc..2fc0318a3d 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc @@ -45,6 +45,8 @@ rpk cluster storage cancel-mount 123 |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc index c2427e78cb..77d5f4f5a1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc @@ -67,6 +67,8 @@ rpk cluster storage list-mount --filter planned |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc index ec6e391a47..557c8597f7 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc @@ -40,6 +40,8 @@ rpk cluster storage list-mountable |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc index 362b5d5087..da7b99daad 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc @@ -61,6 +61,8 @@ rpk cluster storage mount / --to // |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc index 1cdb0b60f3..d0ebd027d8 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc @@ -27,6 +27,8 @@ rpk cluster storage [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc index 08cc4371a8..9fce1c7a38 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc @@ -41,6 +41,8 @@ rpk cluster txn describe-producers [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc index e1cce8ae51..3f1b7fe5d5 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc @@ -33,6 +33,8 @@ rpk cluster txn describe [TXN-IDS...] [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc index 60615494ae..ad826f091d 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc @@ -34,6 +34,8 @@ list, ls |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc index c1674c8612..78114c69f5 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc @@ -71,6 +71,8 @@ txn, transaction |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc index 965d385787..4bdbca9268 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc @@ -23,6 +23,8 @@ rpk cluster [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc index 397bd57069..f231f852d6 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc @@ -29,6 +29,8 @@ rpk connect install [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-uninstall.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-uninstall.adoc index d2879951d0..bbd9c82495 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-uninstall.adoc @@ -21,6 +21,8 @@ rpk connect uninstall [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-upgrade.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-upgrade.adoc index 9096bd8572..e35258f406 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-upgrade.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-upgrade.adoc @@ -23,6 +23,8 @@ rpk connect upgrade [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc index 3a3c79f04c..8842b13dc4 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc @@ -22,6 +22,8 @@ rpk connect [command] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container-purge.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container-purge.adoc index 5036ad255d..ae299289a7 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container-purge.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container-purge.adoc @@ -22,6 +22,8 @@ rpk container purge [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container-start.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container-start.adoc index 4858fbdc70..b529541238 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container-start.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container-start.adoc @@ -97,6 +97,8 @@ rpk container start --admin-ports 9644,9645,9646 |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc index c584345f99..022e7a0d89 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container-status.adoc @@ -49,6 +49,8 @@ broker addresses: |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container-stop.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container-stop.adoc index 2cda3addae..d50abf7087 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container-stop.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container-stop.adoc @@ -22,6 +22,8 @@ rpk container stop [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-container/rpk-container.adoc b/modules/reference/pages/rpk/rpk-container/rpk-container.adoc index 3876f9312e..d277b9023f 100644 --- a/modules/reference/pages/rpk/rpk-container/rpk-container.adoc +++ b/modules/reference/pages/rpk/rpk-container/rpk-container.adoc @@ -24,6 +24,8 @@ rpk container [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc index 5c9c21580b..f0bce7f7d2 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc @@ -140,6 +140,8 @@ addition to creating a copy on disk. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc index 544e53d159..8283b0a706 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc @@ -31,6 +31,8 @@ rpk debug remote-bundle cancel [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc index 869dab925d..0360acdbbc 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc @@ -37,6 +37,8 @@ rpk debug remote-bundle download [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc index 9379bc1050..46e8742a2d 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc @@ -57,6 +57,8 @@ rpk debug remote-bundle start [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc index 0e2930bea4..cc1c07ef43 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc @@ -27,6 +27,8 @@ rpk debug remote-bundle status [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc index 799e4c23d2..deed5f2252 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc @@ -23,6 +23,8 @@ rpk debug remote-bundle [command] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug.adoc index 6e2e755107..875dfa49b1 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug.adoc @@ -24,6 +24,8 @@ rpk debug [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc index 55fbbb0723..8771959ef6 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc @@ -86,6 +86,8 @@ these credentials (:). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc index 3b7d2c1b95..7f4abeda0f 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc @@ -70,6 +70,8 @@ Use --dashboard help for more info (default: `operations`). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc index 973a6c529d..a2133c872d 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc @@ -45,6 +45,8 @@ rpk generate license [flags] |-X, --config-opt |stringArray |Override rpk configuration settings. Use `-X help` for more details or `-X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |The rpk profile to use. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc index 067bca422c..115978f34e 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc @@ -98,6 +98,8 @@ communication with the broker. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc index 987b3a52e5..be80b27b18 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc @@ -94,6 +94,8 @@ rpk generate shell-completion [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc index d139046d4b..db0b5d1535 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc @@ -26,6 +26,8 @@ rpk generate [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc index 77426f8b74..187e5c2c58 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc @@ -34,6 +34,8 @@ rpk group delete [GROUPS...] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc index 362f4917e0..81f071d83b 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc @@ -39,6 +39,8 @@ rpk group describe [GROUPS...] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc index 3d8a750558..4f6e880e3a 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc @@ -48,6 +48,8 @@ list, ls |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc index 85da2b1a5b..60aafbe48e 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc @@ -47,6 +47,8 @@ foo:0,1,2 ). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc index 8762bd479f..82f5d0edea 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc @@ -112,6 +112,8 @@ nanosecond). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc index bf6003e4ff..1c9496b34c 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc @@ -69,6 +69,8 @@ group, g |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-help.adoc b/modules/reference/pages/rpk/rpk-help.adoc index cafdf6b9a2..e23bab1351 100644 --- a/modules/reference/pages/rpk/rpk-help.adoc +++ b/modules/reference/pages/rpk/rpk-help.adoc @@ -24,6 +24,8 @@ rpk help [command] [flags] |-X, --config-opt |stringArray |verride `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-iotune.adoc b/modules/reference/pages/rpk/rpk-iotune.adoc index 34e66b3ed1..92baa220bd 100644 --- a/modules/reference/pages/rpk/rpk-iotune.adoc +++ b/modules/reference/pages/rpk/rpk-iotune.adoc @@ -46,6 +46,8 @@ complete (for example, `300ms`, `1.5s`, `2h45m`). Default `1h0m0s`. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc index f5ab8b9a22..4dc298a854 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc @@ -41,6 +41,8 @@ the current remote version. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc index dfc438c0a4..7dd02f4a2b 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc @@ -33,6 +33,8 @@ rpk plugin list [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc index 3b0303eef1..4d4a1ada99 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc @@ -38,6 +38,8 @@ name. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc index 41f13f4d64..3c6753bf85 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc @@ -70,6 +70,8 @@ rpk plugin [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc index 521e378bc1..a6ab260ad4 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc @@ -24,6 +24,8 @@ rpk profile clear [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc index 36a9dd3af7..e3ae5faf97 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc @@ -69,6 +69,8 @@ fields with key=value pairs. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc index a4ca93972d..cfbf2f8ab6 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc @@ -26,6 +26,8 @@ rpk profile current [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc index 7a5d53f4a6..b4a7161769 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc @@ -26,6 +26,8 @@ rpk profile delete [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc index bbce54bd13..cea083fce5 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc @@ -24,6 +24,8 @@ rpk profile edit-globals [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc index 92fe485f0f..d9e1b9d155 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc @@ -26,6 +26,8 @@ rpk profile edit [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc index a65e0c0c49..634bd410f2 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc @@ -31,6 +31,8 @@ list, ls |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc index 60f0a72960..2fbe4236ae 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc @@ -22,6 +22,8 @@ rpk profile print-globals [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc index 900d325916..2b2e2c57e2 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc @@ -29,6 +29,8 @@ variables nor flags applied. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc index 052c6b92a0..b2aa89c1f8 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc @@ -82,6 +82,8 @@ rpk profile prompt [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc index dd265d2747..260dabf89e 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc @@ -29,6 +29,8 @@ rename-to, rename |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc index 2ab1f39c8f..99c886b70b 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc @@ -31,6 +31,8 @@ rpk profile set-globals [KEY=VALUE]+ [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc index 5309b7f246..0e019fef21 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc @@ -41,6 +41,8 @@ rpk profile set [KEY=VALUE]+ [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc index e1ded15ebc..c6f1c185b2 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc @@ -22,6 +22,8 @@ rpk profile use [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc index 91db109f9c..4a59e8aee1 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc @@ -32,6 +32,8 @@ rpk profile [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc index 55ef33bda9..053061c8ea 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc @@ -77,6 +77,8 @@ rpk redpanda admin brokers decommission-status [BROKER ID] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc index 9d0a090b5c..ca9031ed5e 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc @@ -37,6 +37,8 @@ rpk redpanda admin brokers decommission [BROKER ID] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-list.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-list.adoc index 5e9f81bae6..4dcbbdd9ef 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-list.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-list.adoc @@ -63,6 +63,8 @@ list, ls |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-recommission.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-recommission.adoc index 6839f3bd3e..7dc765fdb3 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-recommission.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-recommission.adoc @@ -32,6 +32,8 @@ rpk redpanda admin brokers recommission [BROKER ID] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc index 7484ea1ecb..f89793b7ed 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc @@ -22,6 +22,8 @@ rpk redpanda admin brokers [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc index eee14223ec..3b47ce9c01 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc @@ -59,6 +59,8 @@ the request to. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc index e4515312d3..e101ee60c5 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc @@ -24,6 +24,8 @@ rpk redpanda admin config log-level [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc index cf8d056435..3869231a9c 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc @@ -35,6 +35,8 @@ issue the request to. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config.adoc index 7d1166a0cd..bb9808b6a8 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-config.adoc @@ -24,6 +24,8 @@ rpk redpanda admin config [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc index ec3e711e35..2c8134a0d4 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc @@ -33,6 +33,8 @@ list, ls |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc index 5f9da9ab1d..0a08ccde3a 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc @@ -24,6 +24,8 @@ rpk redpanda admin partitions [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin.adoc index 4b070aecbd..c3e0b9d0fb 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin.adoc @@ -24,6 +24,8 @@ rpk redpanda admin [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-check.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-check.adoc index 26ae5502c3..f57d369956 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-check.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-check.adoc @@ -30,6 +30,8 @@ decimal numbers, each with optional fraction and a unit suffix, such as |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-bootstrap.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-bootstrap.adoc index 3a15dd7a53..763192a378 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-bootstrap.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-bootstrap.adoc @@ -49,6 +49,8 @@ empty, defaults to a private address. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-init.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-init.adoc index d3308e2b43..fd3b9bcf7c 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-init.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-init.adoc @@ -26,6 +26,8 @@ rpk redpanda config init [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-print.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-print.adoc index a16cebe6df..233bca13f5 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-print.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-print.adoc @@ -30,6 +30,8 @@ print, dump |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc index 8f35028cca..1157e41ed2 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc @@ -81,6 +81,8 @@ rpk redpanda config set [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc index e66a59e016..43ce1ceb09 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc @@ -25,6 +25,8 @@ rpk redpanda config [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc index 9cabe78320..eecad08655 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc @@ -48,6 +48,8 @@ rpk redpanda mode [flags] |-X, --config-opt |stringArray |Override rpk configuration settings; `-X help` for detail or `-X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc index 2a226b075f..46971ad320 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc @@ -148,6 +148,8 @@ numbers, each with optional fraction and a unit suffix, such as |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-stop.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-stop.adoc index 9a05eea1ce..e5094a58e1 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-stop.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-stop.adoc @@ -31,6 +31,8 @@ stop after each signal is sent (e.g. 300ms, 1.5s, 2h45m) (default 5s). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-help.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-help.adoc index 857b4cad99..582ba25022 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-help.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-help.adoc @@ -21,6 +21,8 @@ rpk redpanda tune help [TUNER] [flags] |-X, --config-opt |stringArray |Override rpk configuration settings; '-X help' for detail or '-X list' for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |rpk profile to use. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc index 96066afbd1..0e3c4c41e8 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc @@ -52,6 +52,8 @@ system reboot. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc index 65acc97f6a..6e827dc2e6 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc @@ -100,6 +100,8 @@ complete (e.g. 300ms, 1.5s, 2h45m) (default 10s). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc index 432affb1c4..2616d5854f 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc @@ -26,6 +26,8 @@ rpk redpanda [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc index b8ea53e4e4..72a35d6688 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc @@ -28,6 +28,8 @@ rpk registry mode get [SUBJECT...] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc index 69451a9a7e..a7ffc4579c 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc @@ -26,6 +26,8 @@ rpk registry mode reset [SUBJECT...] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc index 07a5e900fe..e6feb98557 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc @@ -68,6 +68,8 @@ NOTE: Replace the placeholder values with your own values. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc index ccae0d13c4..2c6d64af9b 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc @@ -24,6 +24,8 @@ rpk registry mode [command] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc index 6aca2fde1b..ba667968d3 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc @@ -31,6 +31,8 @@ rpk registry schema check-compatibility [SUBJECT] [flags] |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc index 7f8c321979..6f6048a3e6 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc @@ -28,6 +28,8 @@ rpk registry schema delete SUBJECT --schema-version {version} [flags] |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc index 8bd30a749d..fe0e4c6a2f 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc @@ -33,6 +33,8 @@ list, ls |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc index 2c7619c4a5..cde1ab3468 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc @@ -28,6 +28,8 @@ rpk registry schema references SUBJECT --schema-version {version} [flags] |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc index cc7c76b2bd..7ff2e4da9a 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc @@ -1,32 +1,34 @@ -= rpk registry schema -// tag::single-source[] - -Manage schemas in the Schema Registry. - -== Usage - -[,bash] ----- -rpk registry schema [command] [flags] ----- - -== Flags - -[cols="1m,1a,2a"] -|=== -|*Value* |*Type* |*Description* - -|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. - -|-h, --help |- |Help for schema. - -|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. - -|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. - -|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. - -|-v, --verbose |- |Enable verbose logging. -|=== - += rpk registry schema +// tag::single-source[] + +Manage schemas in the Schema Registry. + +== Usage + +[,bash] +---- +rpk registry schema [command] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. + +|-h, --help |- |Help for schema. + +|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + // end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc index da29be0a56..d76affbfb9 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc @@ -26,6 +26,8 @@ rpk registry subject delete [SUBJECT...] [flags] |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc index af49fbde3b..acf0075729 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc @@ -33,6 +33,8 @@ list, ls |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc index d4fc7b553c..7500234c6f 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc @@ -115,6 +115,8 @@ names (literal or prefixed) (default "literal"). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc index d9c4486c03..a47ceba0c1 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc @@ -104,6 +104,8 @@ names (any, match, literal, or prefixed) (default "any"). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc index 0eefbca52d..473cccee68 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc @@ -121,6 +121,8 @@ names (any, match, literal, or prefixed) (default "any"). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc index 8c4548dace..ce61498880 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc @@ -148,6 +148,8 @@ rpk security acl [command] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc index 5670fc9dd7..58e103a32a 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc @@ -49,6 +49,8 @@ assign, add |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc index 16613d58ea..2d0c8ef038 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc @@ -26,6 +26,8 @@ rpk security role create [ROLE] [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc index 07996272ef..bb9611f0e4 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc @@ -30,6 +30,8 @@ rpk security role delete [ROLE] [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc index bc98853d85..14a8f3d8c2 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc @@ -59,6 +59,8 @@ describe, info |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc index f6063bed5b..210340a055 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc @@ -55,6 +55,8 @@ list, ls |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc index 1343e6599c..71509aaf60 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc @@ -51,6 +51,8 @@ unassign, remove |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc index 045dae221f..d20e07dc83 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc @@ -31,6 +31,8 @@ role, access, roles |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc index eb3c2b2f75..a86f471cc1 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc @@ -45,6 +45,8 @@ the admin API, use --new-password). |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc index e936cdcc99..e55e4e467a 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc @@ -28,6 +28,8 @@ rpk security user delete [USER] [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc index 4ef1c741ab..99f6109b7b 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc @@ -32,6 +32,8 @@ list, ls |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc index 676fd11560..560a7200b6 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc @@ -31,6 +31,8 @@ rpk security user update [USER] --new-password [PW] --mechanism [MECHANISM] [fla |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc index 71aabc3433..b22d90d37e 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc @@ -31,6 +31,8 @@ rpk security user [command] [flags] |--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc index e7eac81f1d..be18c63f24 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc @@ -28,6 +28,8 @@ security, sec |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc index 30752fcad6..8e9353a531 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc @@ -71,6 +71,8 @@ endif::[] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc index 5414ffcb0e..73843ff846 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc @@ -54,6 +54,8 @@ rpk shadow create -c shadow-link.yaml --no-confirm |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc index a454de91cf..4069a14e66 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc @@ -55,6 +55,8 @@ rpk shadow delete my-shadow-link --force |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc index 3a73930de3..c2bd0e4462 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc @@ -85,6 +85,8 @@ rpk shadow describe my-shadow-link --format json |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc index 0749d4bf69..4fb5f09ce9 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc @@ -59,6 +59,8 @@ rpk shadow failover my-shadow-link --all --no-confirm |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc index f614ce3f78..88833b3954 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc @@ -26,6 +26,8 @@ rpk shadow list [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc index dac0efd985..dfb95e7bc2 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc @@ -52,6 +52,8 @@ rpk shadow status my-shadow-link --print-overview --print-topic |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc index 09fcf54c1c..c1cbb602a3 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc @@ -37,6 +37,8 @@ rpk shadow update my-shadow-link |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc index 884d407f29..d27e049d86 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc @@ -26,6 +26,8 @@ rpk shadow [command] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc index abb5d2b483..7152e7e824 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc @@ -29,6 +29,8 @@ For example, the internal topic __consumer_offsets. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc index ebd1ad971a..ec30dd2fbe 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc @@ -47,6 +47,8 @@ key (repeatable). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc index b16cb07b18..1a69e63c7d 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc @@ -96,6 +96,8 @@ rpk topic analyze [TOPIC] [flags] |-X, --config-opt |stringArray |Override rpk configuration settings. Use `-X help` for more details or `-X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |rpk profile to use. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc index 46842db279..1aee5eac55 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -252,6 +252,8 @@ any expression. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc index f2d2668d4a..0a78810884 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc @@ -43,6 +43,8 @@ the cluster's default_topic_replications (default -1). In Redpanda Cloud, the re |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc index 20ba8744cd..b193b10af0 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc @@ -62,6 +62,8 @@ any input topic expression. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc index f66fa3f567..bb1dcf643b 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc @@ -64,6 +64,8 @@ form. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc index 80bdee5e75..eb222a01fe 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc @@ -49,6 +49,8 @@ section; only relevant if you produce to this topic transactionally. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc index 9179bd1b0d..26f85bbbe9 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc @@ -54,6 +54,8 @@ input topic expression. |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc index 23adbf11b7..e761b643e8 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc @@ -151,6 +151,8 @@ non-negative (also allows %p parsing to set partitions) (default -1). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc index 520e4078f0..c15f601d27 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc @@ -85,6 +85,8 @@ to trim records from (default to all) (default []). |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc index 6e49d9bdcd..cf3dc342c1 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc @@ -25,6 +25,8 @@ rpk topic [flags] [command] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc index 76397d9bb1..585529fac2 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc @@ -25,6 +25,8 @@ rpk transform delete [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc index e891aaf6c0..ee90c72736 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc @@ -40,6 +40,8 @@ list, ls |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc index e128465cb7..fa6facde5a 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc @@ -111,6 +111,8 @@ logs, log |-X, --config-opt |stringArray |Override rpk configuration settings; '-X help' for detail or '-X list' for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |rpk profile to use. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc index 4d8315bb9a..e9f0ca9b8c 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc @@ -28,6 +28,8 @@ rpk transform pause [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc index 43a39219c8..e485f7fb7f 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc @@ -26,6 +26,8 @@ rpk transform resume [NAME] [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. diff --git a/modules/reference/pages/rpk/rpk-version.adoc b/modules/reference/pages/rpk/rpk-version.adoc index f1b3e0bc6f..f42f36f2b3 100644 --- a/modules/reference/pages/rpk/rpk-version.adoc +++ b/modules/reference/pages/rpk/rpk-version.adoc @@ -27,6 +27,8 @@ rpk version [flags] |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. + |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging.