Issue #2209
closed
The RPM rsync distributor documentation doesn't explain how to pass config options to Pulp
Description
The RPM rsync distributor documentation provides this sample configuration:
{
"distributor_id": "my_rpm_rsync_distributor",
"distributor_type_id": "rpm_rsync_distributor",
"distributor_config": {
"remote": {
"auth_type": "publickey",
"ssh_user": "foo",
"ssh_identity_file": "/home/user/.ssh/id_rsa",
"host": "192.168.121.1",
"root": "/home/foo/pulp_root_dir"
},
"predistributor_id": "yum_distributor"
}
}
It then goes on to list other optional configuration options, such as rpm_rsync_distributor. However, most or all of those options are not listed in the sample config above, and it is not explained where they should go in the dict. As a result, users must resort to more obtuse methods like trial and error, using pulp-admin with the --verbose flag, or reading the source code.
Please, explain how to structure requests to the Pulp server.
See: https://github.com/pulp/pulp_rpm/blob/master/docs/tech-reference/rsync-distributor.rst
Updated by mhrivnak over 7 years ago
We have API docs:
http://docs.pulpproject.org/dev-guide/integration/rest-api/repo/cud.html#update-a-repository
http://docs.pulpproject.org/dev-guide/integration/rest-api/repo/cud.html#associate-a-distributor-with-a-repository
Do those suffice? Plugins should specify what options are available, and the API docs should specify how to use the API. Perhaps we can make that distinction more clear.
Updated by Ichimonji10 over 7 years ago
We have API docs:
http://docs.pulpproject.org/dev-guide/integration/rest-api/repo/cud.html#update-a-repository
http://docs.pulpproject.org/dev-guide/integration/rest-api/repo/cud.html#associate-a-distributor-with-a-repositoryDo those suffice?
No, those links do not suffice.
Yes, the plugin documentation explains which options are available and the semantics of those options. However, neither the plugin documentation nor the API documentation explains how to structure those options.
For example, let's say that I want to set the content_units_only option to "true" when creating an RPM rsync distributor. Is this the correct way to specify the option?
{
"distributor_id": "my_rpm_rsync_distributor",
"distributor_type_id": "rpm_rsync_distributor",
"distributor_config": {
"remote": {
"auth_type": "publickey",
"ssh_user": "foo",
"ssh_identity_file": "/home/user/.ssh/id_rsa",
"host": "192.168.121.1",
"root": "/home/foo/pulp_root_dir",
"content_units_only": true
},
"predistributor_id": "yum_distributor"
}
}
Or is this the correct way to specify the option?
{
"distributor_id": "my_rpm_rsync_distributor",
"distributor_type_id": "rpm_rsync_distributor",
"distributor_config": {
"remote": {
"auth_type": "publickey",
"ssh_user": "foo",
"ssh_identity_file": "/home/user/.ssh/id_rsa",
"host": "192.168.121.1",
"root": "/home/foo/pulp_root_dir"
},
"predistributor_id": "yum_distributor",
"content_units_only": true
}
}
Or is this the correct way to specify the option?
{
"distributor_id": "my_rpm_rsync_distributor",
"distributor_type_id": "rpm_rsync_distributor",
"distributor_config": {
"remote": {
"auth_type": "publickey",
"ssh_user": "foo",
"ssh_identity_file": "/home/user/.ssh/id_rsa",
"host": "192.168.121.1",
"root": "/home/foo/pulp_root_dir"
},
"predistributor_id": "yum_distributor"
},
"content_units_only": true
}
Neither the plugin docs nor the API docs explain how I should structure my request to the server.
Updated by amacdona@redhat.com over 7 years ago
- Priority changed from Normal to High
- Severity changed from 2. Medium to 1. Low
- Triaged changed from No to Yes
- Tags Documentation added
Updated by bmbouter about 5 years ago
- Status changed from NEW to CLOSED - WONTFIX
Pulp 2 is approaching maintenance mode, and this Pulp 2 ticket is not being actively worked on. As such, it is being closed as WONTFIX. Pulp 2 is still accepting contributions though, so if you want to contribute a fix for this ticket, please reopen or comment on it. If you don't have permissions to reopen this ticket, or you want to discuss an issue, please reach out via the developer mailing list.
.