Skip to content

Commit 36a5da2

Browse files
authored
docs: describe available service registry instance settings, minor edits (#1694)
1 parent 792df70 commit 36a5da2

File tree

2 files changed

+42
-29
lines changed

2 files changed

+42
-29
lines changed

WHATS_NEW.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@ For information on what was included in latest release please refer to our [chan
55

66
## Unrelased (main branch)
77

8-
### Support for configuration of service registry
9-
`rhoas service-registry setting get` for getting the value of setting. Supports `--name` flag to define name of the setting.
8+
### Support for configuration of Service Registry instances
9+
`rhoas service-registry setting get` for getting the value of a setting for a Service Registry instance. Supports the `--name` flag to define the setting name.
1010

11-
Name of the setting can also be prompted by running command in interactive mode:
11+
The setting name can also be prompted by running the command in interactive mode:
1212
```
1313
rhoas service-registry setting get
1414
```
1515

16-
`rhoas service-registry setting set` for configuring the value of setting. Supports `--name` flag to define name of the setting and `--value` to define new value of the setting. `--default` flag can be used to restore default value of the setting.
16+
`rhoas service-registry setting set` for configuring the value of a setting for a Service Registry instance. Supports the `--name` flag to define the setting name and `--value` to define the setting value. `--default` restores the default value.
1717

18-
Name of the setting and the value can also be prompted by running command in interactive mode:
18+
The setting name and value can also be prompted by running the command in interactive mode:
1919
```
2020
rhoas service-registry setting set
2121
```
2222

23-
`rhoas service-registry setting list` for listing all settings of a service registry instance.
23+
`rhoas service-registry setting list` for listing all settings for a Service Registry instance.
2424

25-
> NOTE: setting command is only for owners and admins of the service registry instance
25+
> NOTE: The `service-registry setting` command is only available to Service Registry instance owners, instance adminstrators, and organization administrators.
2626
2727
## 0.46.0
2828

Original file line numberDiff line numberDiff line change
@@ -1,61 +1,74 @@
11
[setting.cmd.description.short]
2-
one = 'Configure settings of a Service Registry instance'
2+
one = 'Configure settings for a Service Registry instance'
33

44
[setting.cmd.description.long]
55
one = '''
6-
Configure settings of a Service Registry instance
6+
Service Registry instance owners, instance administrators, and organization administrators can
7+
configure settings for a Service Registry instance.
8+
9+
The available settings include the following options:
10+
11+
* registry.auth.basic-auth-client-credentials.enabled - Specifies whether Service Registry users can
12+
authenticate using HTTP basic authentication, in addition to OAuth. Defaults to true.
13+
* registry.auth.owner-only-authorization - Specifies whether only the user who creates an artifact can modify
14+
that artifact. Defaults to false.
15+
* registry.auth.owner-only-authorization.limit-group-access - When registry.auth.owner-only-authorization is
16+
set to true, specifies whether only the user who creates an artifact group has write access to that artifact
17+
group, for example, to add or remove artifacts. Defaults to false.
18+
* registry.ccompat.legacy-id-mode.enabled - Specifies whether the Confluent Schema Registry compatibility API
19+
uses globalId instead of contentId as an artifact identifier. Defaults to false.
720
'''
821

922
[setting.cmd.example]
1023
one = '''
11-
## List all settings of the current Service Registry instance
24+
## List all settings for the current Service Registry instance
1225
$ rhoas service-registry setting list
1326
1427
## Set the value of setting
1528
$ rhoas service-registry setting set --name registry.ccompat.legacy-id-mode.enabled --value true
1629
'''
1730

1831
[setting.list.cmd.description.short]
19-
one = 'List settings'
32+
one = 'List settings for a Service Registry instance'
2033

2134
[setting.list.cmd.description.long]
22-
one = 'List all settings with their values and types'
35+
one = 'List all settings for a Service Registry instance with their values and types'
2336

2437
[setting.list.cmd.example]
2538
one = '''
26-
## List all settings of the current Service Registry
39+
## List all settings for the current Service Registry instance
2740
$ rhoas service-registry setting list
2841
29-
## List all settings of a specific Service Registry instance
42+
## List all settings for a specific Service Registry instance
3043
$ rhoas service-registry setting list --instance-id=8ecff228-1ffe-4cf5-b38b-55223885ee00
3144
'''
3245

3346
[setting.get.cmd.description.short]
34-
one = 'Get value of the setting'
47+
one = 'Get value of the setting for a Service Registry instance'
3548

3649
[setting.get.cmd.description.long]
37-
one = 'Get formatted setting value and other information'
50+
one = 'Get the formatted value of the setting and other information for a Service Registry instance'
3851

3952
[setting.get.cmd.example]
4053
one = '''
41-
## Get setting by name
54+
## Get the setting for a Service Registry instance by name
4255
$ rhoas service-registry setting get --name registry.ccompat.legacy-id-mode.enabled
4356
44-
## Get setting in yaml format by name
57+
## Get the setting for a Service Registry instance in YAML format by name
4558
$ rhoas service-registry setting get --name registry.ccompat.legacy-id-mode.enabled --output yaml
4659
'''
4760

4861
[setting.get.cmd.flag.settingName.description]
49-
one = 'Name of the setting'
62+
one = 'Name of the setting for a Service Registry instance'
5063

5164
[setting.get.input.settingName.message]
52-
one = 'Name of the setting:'
65+
one = 'Name of the setting for a Service Registry instance:'
5366

5467
[setting.set.cmd.description.short]
55-
one = 'Set value of the setting'
68+
one = 'Set value of the setting for a Service Registry instance'
5669

5770
[setting.set.cmd.description.long]
58-
one = 'Set value of the setting to a specific value or reset to default'
71+
one = 'Set the value of the Service Registry setting to a specific value or reset to default'
5972

6073
[setting.set.cmd.example]
6174
one = '''
@@ -67,26 +80,26 @@ $ rhoas service-registry setting set --name registry.ccompat.legacy-id-mode.enab
6780
'''
6881

6982
[setting.set.cmd.flag.settingName.description]
70-
one = 'Name of the setting'
83+
one = 'Name of the Service Registry setting'
7184

7285
[setting.set.input.settingName.message]
7386
one = 'Name of the setting:'
7487

7588
[setting.set.input.value.message]
76-
one = 'New value:'
89+
one = 'New setting value:'
7790

7891
[setting.set.cmd.flag.value.description]
79-
one = 'New value of the setting'
92+
one = 'New value of the Service Registry setting'
8093

8194
[setting.set.cmd.flag.default.description]
82-
one = 'Restore value of the setting to default'
95+
one = 'Restore value of the Service Registry setting to default'
8396

8497
[setting.set.log.info.settingSet]
85-
one = 'Successfully updated settings for update'
98+
one = 'Successfully updated settings for the Service Registry instance'
8699

87100
[setting.set.log.info.settingReset]
88-
one = 'Setting was successfully reset to default'
101+
one = 'Service Registry setting was successfully reset to default'
89102

90103
[setting.set.warning.valueignored]
91-
one = 'Value is ignore while setting is being restored to default'
104+
one = 'Value is ignored while Service Registry setting is being restored to default'
92105

0 commit comments

Comments
 (0)