diff --git a/docs/commands/rhoas_service-registry.md b/docs/commands/rhoas_service-registry.md index 7f1759d89..a2b0c5194 100644 --- a/docs/commands/rhoas_service-registry.md +++ b/docs/commands/rhoas_service-registry.md @@ -43,5 +43,6 @@ rhoas service-registry list * [rhoas service-registry list](rhoas_service-registry_list.md) - List Service Registry instances * [rhoas service-registry role](rhoas_service-registry_role.md) - Service Registry role management * [rhoas service-registry rule](rhoas_service-registry_rule.md) - Manage artifact rules in a Service Registry instance +* [rhoas service-registry setting](rhoas_service-registry_setting.md) - Configure settings for a Service Registry instance * [rhoas service-registry use](rhoas_service-registry_use.md) - Use a Service Registry instance diff --git a/docs/commands/rhoas_service-registry_setting.md b/docs/commands/rhoas_service-registry_setting.md new file mode 100644 index 000000000..83cc86eef --- /dev/null +++ b/docs/commands/rhoas_service-registry_setting.md @@ -0,0 +1,47 @@ +## rhoas service-registry setting + +Configure settings for a Service Registry instance + +### Synopsis + +Service Registry instance owners, instance administrators, and organization administrators can +configure settings for a Service Registry instance. + +The available settings include the following options: + +* registry.auth.basic-auth-client-credentials.enabled - Specifies whether Service Registry users can + authenticate using HTTP basic authentication, in addition to OAuth. Defaults to true. +* registry.auth.owner-only-authorization - Specifies whether only the user who creates an artifact can modify + that artifact. Defaults to false. +* registry.auth.owner-only-authorization.limit-group-access - When registry.auth.owner-only-authorization is + set to true, specifies whether only the user who creates an artifact group has write access to that artifact + group, for example, to add or remove artifacts. Defaults to false. +* registry.ccompat.legacy-id-mode.enabled - Specifies whether the Confluent Schema Registry compatibility API + uses globalId instead of contentId as an artifact identifier. Defaults to false. + + +### Examples + +``` +## List all settings for the current Service Registry instance +$ rhoas service-registry setting list + +## Set the value of setting +$ rhoas service-registry setting set --name registry.ccompat.legacy-id-mode.enabled --value true + +``` + +### Options inherited from parent commands + +``` + -h, --help Show help for a command + -v, --verbose Enable verbose mode +``` + +### SEE ALSO + +* [rhoas service-registry](rhoas_service-registry.md) - Service Registry commands +* [rhoas service-registry setting get](rhoas_service-registry_setting_get.md) - Get value of the setting for a Service Registry instance +* [rhoas service-registry setting list](rhoas_service-registry_setting_list.md) - List settings for a Service Registry instance +* [rhoas service-registry setting set](rhoas_service-registry_setting_set.md) - Set value of the setting for a Service Registry instance + diff --git a/docs/commands/rhoas_service-registry_setting_get.md b/docs/commands/rhoas_service-registry_setting_get.md new file mode 100644 index 000000000..04c946eac --- /dev/null +++ b/docs/commands/rhoas_service-registry_setting_get.md @@ -0,0 +1,42 @@ +## rhoas service-registry setting get + +Get value of the setting for a Service Registry instance + +### Synopsis + +Get the formatted value of the setting and other information for a Service Registry instance + +``` +rhoas service-registry setting get [flags] +``` + +### Examples + +``` +## Get the setting for a Service Registry instance by name +$ rhoas service-registry setting get --name registry.ccompat.legacy-id-mode.enabled + +## Get the setting for a Service Registry instance in YAML format by name +$ rhoas service-registry setting get --name registry.ccompat.legacy-id-mode.enabled --output yaml + +``` + +### Options + +``` + --instance-id string ID of the Service Registry instance to be used (by default, uses the currently selected instance) + -n, --name string Name of the setting for a Service Registry instance + -o, --output string Specify the output format. Choose from: "json", "yaml", "yml" +``` + +### Options inherited from parent commands + +``` + -h, --help Show help for a command + -v, --verbose Enable verbose mode +``` + +### SEE ALSO + +* [rhoas service-registry setting](rhoas_service-registry_setting.md) - Configure settings for a Service Registry instance + diff --git a/docs/commands/rhoas_service-registry_setting_list.md b/docs/commands/rhoas_service-registry_setting_list.md new file mode 100644 index 000000000..65492f429 --- /dev/null +++ b/docs/commands/rhoas_service-registry_setting_list.md @@ -0,0 +1,40 @@ +## rhoas service-registry setting list + +List settings for a Service Registry instance + +### Synopsis + +List all settings for a Service Registry instance with their values and types + +``` +rhoas service-registry setting list [flags] +``` + +### Examples + +``` +## List all settings for the current Service Registry instance +$ rhoas service-registry setting list + +## List all settings for a specific Service Registry instance +$ rhoas service-registry setting list --instance-id=8ecff228-1ffe-4cf5-b38b-55223885ee00 + +``` + +### Options + +``` + --instance-id string ID of the Service Registry instance to be used (by default, uses the currently selected instance) +``` + +### Options inherited from parent commands + +``` + -h, --help Show help for a command + -v, --verbose Enable verbose mode +``` + +### SEE ALSO + +* [rhoas service-registry setting](rhoas_service-registry_setting.md) - Configure settings for a Service Registry instance + diff --git a/docs/commands/rhoas_service-registry_setting_set.md b/docs/commands/rhoas_service-registry_setting_set.md new file mode 100644 index 000000000..da2bae8f0 --- /dev/null +++ b/docs/commands/rhoas_service-registry_setting_set.md @@ -0,0 +1,43 @@ +## rhoas service-registry setting set + +Set value of the setting for a Service Registry instance + +### Synopsis + +Set the value of the Service Registry setting to a specific value or reset to default + +``` +rhoas service-registry setting set [flags] +``` + +### Examples + +``` +## Set value of setting by name +$ rhoas service-registry setting set --name registry.ccompat.legacy-id-mode.enabled --value true + +## Reset value of setting by name +$ rhoas service-registry setting set --name registry.ccompat.legacy-id-mode.enabled --default + +``` + +### Options + +``` + --default Restore value of the Service Registry setting to default + --instance-id string ID of the Service Registry instance to be used (by default, uses the currently selected instance) + -n, --name string Name of the Service Registry setting + --value string New value of the Service Registry setting +``` + +### Options inherited from parent commands + +``` + -h, --help Show help for a command + -v, --verbose Enable verbose mode +``` + +### SEE ALSO + +* [rhoas service-registry setting](rhoas_service-registry_setting.md) - Configure settings for a Service Registry instance + diff --git a/pkg/cmd/registry/setting/setting.go b/pkg/cmd/registry/setting/setting.go index e164e9081..19f162a58 100644 --- a/pkg/cmd/registry/setting/setting.go +++ b/pkg/cmd/registry/setting/setting.go @@ -15,7 +15,6 @@ func NewSettingCommand(f *factory.Factory) *cobra.Command { Long: f.Localizer.MustLocalize("setting.cmd.description.long"), Example: f.Localizer.MustLocalize("setting.cmd.example"), Args: cobra.MinimumNArgs(1), - Hidden: true, } // add sub-commands