Project

Profile

Help

Issue #3250

closed

docker tag creation: inconsistent field names

Added by mihai.ibanescu@gmail.com over 6 years ago. Updated about 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
-
Start date:
Due date:
Estimated time:
Severity:
3. High
Version - Docker:
Platform Release:
2.15.1
Target Release - Docker:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Pulp 2
Sprint:
Quarter:

Description

As a user of the REST API uploading a unit, I expect to look at the model's field names to find out what I'm supposed to upload.

The Tag model has a 'manifest_digest' field.

However, the upload code expects a 'digest' field:

https://github.com/pulp/pulp_docker/blob/master/plugins/pulp_docker/plugins/importers/upload.py#L331

Consistency would be nice, if it's not too much to ask.

Actions #1

Updated by mihai.ibanescu@gmail.com over 6 years ago

  • Status changed from NEW to POST
Actions #2

Updated by ipanova@redhat.com over 6 years ago

Even though it is and easy code change, it looks like a backwards incompatible change because of the change of the field name from 'digest' to 'manifest_digest' which leads to violation of semantic versioning. CLI should also be considered for consistency in this case.

$ pulp-admin -vv docker repo tag

Command: tag
Description: create or update a tag to point to a manifest

Available Arguments:

  --bg       - if specified, the client process will end immediately (the task
               will continue to run on the server)
  --repo-id  - (required) unique identifier; only alphanumeric, ., -, and _
               allowed
  -v         - display extra information about the upload process
  --tag-name - (required) name of the tag to create  or update
  --digest   - (required) digest of the image manifest or manifest list (e.g.
               sha256:3e006...)
The following options are required but were not specified:
  --repo-id
  --tag-name
  --digest
Actions #3

Updated by mihai.ibanescu@gmail.com over 6 years ago

The PR implements the ability to accept a manifest_digest as well as digest. The CLI doesn't have to change.

Actions #4

Updated by dalley over 6 years ago

  • Triaged changed from No to Yes

Added by Mihai Ibanescu over 6 years ago

Revision f824973f | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

Added by Mihai Ibanescu over 6 years ago

Revision f824973f | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

Added by Mihai Ibanescu over 6 years ago

Revision f824973f | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

Added by Mihai Ibanescu over 6 years ago

Revision f824973f | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

Actions #5

Updated by Anonymous over 6 years ago

  • Status changed from POST to MODIFIED
Actions #6

Updated by pcreech over 6 years ago

  • Platform Release set to 2.15.1

Added by Mihai Ibanescu over 6 years ago

Revision 0993057e | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

(cherry picked from commit f824973f2fc65319bc609145f327b1154cb378ec)

Added by Mihai Ibanescu over 6 years ago

Revision 0993057e | View on GitHub

Prefer manifest_digest over digest, the actual field name on the model.

Raise a validation exception if name or manifest_digest are missing. Added tests.

closes #3250 https://pulp.plan.io/issues/3250

(cherry picked from commit f824973f2fc65319bc609145f327b1154cb378ec)

Actions #7

Updated by Anonymous over 6 years ago

Actions #8

Updated by pcreech over 6 years ago

  • Status changed from MODIFIED to 5
Actions #9

Updated by pcreech about 6 years ago

  • Status changed from 5 to CLOSED - CURRENTRELEASE
Actions #10

Updated by bmbouter about 5 years ago

  • Tags Pulp 2 added

Also available in: Atom PDF