Project

Profile

Help

Issue #2724

closed

`pulp-admin docker repo create --help` states v1 content is synced by default

Added by Ichimonji10 over 7 years ago. Updated over 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version - Docker:
Platform Release:
2.14.0
Target Release - Docker:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Easy Fix, Pulp 2
Sprint:
Quarter:

Description

Check out this help text:

[root@fedora-24-pulp-2-14 ~]# pulp-admin docker repo create --help
Command: create
Description: creates a new repository

Available Arguments:

  --repo-id          - (required) unique identifier; only alphanumeric, ., -,
                       and _ allowed
  --display-name     - user-readable display name (may contain i18n characters)
  --description      - user-readable description (may contain i18n characters)
  --note             - adds/updates/deletes notes to programmatically identify
                       the resource; key-value pairs must be separated by an
                       equal sign (e.g. key=value); multiple notes can be
                       changed by specifying this option multiple times; notes
                       are deleted by specifying "" as the value
  --auto-publish     - if "true", on each successful sync the repository will
                       automatically be published; if "false" content will only
                       be available after manually publishing the repository;
                       defaults to "true"
  --redirect-url     - The URL that will be used when generating the redirect
                       map for connecting the docker API to the location the
                       content is stored. The value defaults to
                       https://<server_name_from_pulp_server.conf>/pulp/docker/<
                       repo_name>.
  --protected        - if "true" requests for this repo will be checked for an
                       entitlement certificate authorizing the server url for
                       this repository; if "false" no authorization checking
                       will be done.
  --repo-registry-id - the name that will be used for this repository in the
                       Docker registry. If not specified, the repo id will be
                       used
  --enable-v1        - Enable sync of v1 API. defaults to "true"
  --enable-v2        - Enable sync of v2 API. defaults to "true"

Synchronization
  --feed          - URL for the upstream docker index, not including repo name
  --validate      - if "true", the size and checksum of each synchronized file
                    will be verified against the repo metadata
  --upstream-name - name of the upstream repository

Feed SSL
  --feed-ca-cert    - full path to the CA certificate that should be used to
                      verify the external repo server's SSL certificate
  --verify-feed-ssl - if "true", the feed's SSL certificate will be verified
                      against the feed_ca_cert
  --feed-cert       - full path to the certificate to use for authorization when
                      accessing the external feed
  --feed-key        - full path to the private key for feed_cert

Feed Proxy
  --proxy-host - proxy server url to use
  --proxy-port - port on the proxy server to make requests
  --proxy-user - username used to authenticate with the proxy server
  --proxy-pass - password used to authenticate with the proxy server

Basic Authentication
  --basicauth-user - username used to authenticate with sync location via HTTP
                     basic auth
  --basicauth-pass - password used to authenticate with sync location via HTTP
                     basic auth

Throttling
  --max-downloads - maximum number of downloads that will run concurrently
  --max-speed     - maximum bandwidth used per download thread, in bytes/sec,
                    when synchronizing the repo

This isn't quite right: --enable-v1 - Enable sync of v1 API. defaults to "true". In reality, v1 content isn't synced by default. The help text should state defaults to "false". This seems to be the offending line of code.

I can reproduce on at least Pulp 2.12, 2.13 and 2.14.

Thanks for @ipanova for her help in troubleshooting this bug.

Also available in: Atom PDF