Project

Profile

Help

Story #4680

As a user I have lifecycle docs in pulpcore workflows

Added by kersom 6 months ago. Updated 29 days ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

Add documentation about use cases for base_version.

1 - User being able to roll back a certain repo version.
2 - Define the base_version for a new repo version.

See: https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_create


Related issues

Related to Pulp - Issue #4665: Field base_version set as none even when repo has multiple versions CLOSED - WONTFIX Actions
Related to Pulp - Test #4667: Test repository version can not be updated using PATCH/PUT CLOSED - COMPLETE Actions
Duplicated by Pulp - Issue #3392: Document Autodistribution CLOSED - DUPLICATE Actions
Blocked by Pulp - Story #4745: As a plugin writer, I can create distributions for repository versions MODIFIED Actions

History

#1 Updated by kersom 6 months ago

  • Related to Issue #4665: Field base_version set as none even when repo has multiple versions added

#2 Updated by amacdona@redhat.com 6 months ago

  • Sprint/Milestone set to 3.0
  • Triaged changed from No to Yes
  • Sprint set to Sprint 52

#3 Updated by amacdona@redhat.com 6 months ago

  • Tracker changed from Issue to Story
  • Subject changed from Document use cases to use repository base_version to As a user I have lifecycle docs in pulpcore workflows
  • % Done set to 0

This will take the place of the Promotion stub. s/Promotion/Lifecycle/
https://docs.pulpproject.org/en/3.0/nightly/workflows/promotion.html

This story will address 2 areas.

Workflow:

("workflows" might get renamed)

remind user to check plugin docs first
This section should *clearly indicate that the lifecycle workflow is the **common case, and is intended to supplement plugin documentation. Users should consult their plugin docs first to make sure this workflow applies to them.

explain the why
Lifecycling in Pulp uses the Distribution Object (Link to Distribution REST API) to host publications at a namespace controlled by the user. This is a powerful tool and is intended to allow flexible workflows. 2 examples:
  1. "promote" from dev->testing->prod for example.
  2. Rollback to previous publications

REST API autodocs

Improve the clarity of the help_text for each field on a distribution, try to use the language of the lifecycling workflow, and include a link.
Autodistribution should be covered in the help_text for publisher/repository. (was https://pulp.plan.io/issues/3392)

#4 Updated by amacdona@redhat.com 6 months ago

  • Duplicated by Issue #3392: Document Autodistribution added

#5 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

#6 Updated by kersom 6 months ago

  • Related to Test #4667: Test repository version can not be updated using PATCH/PUT added

#7 Updated by amacdona@redhat.com 6 months ago

  • Blocked by Story #4745: As a plugin writer, I can create distributions for repository versions added

#8 Updated by amacdona@redhat.com 6 months ago

We have been discussing some changes in this area.

1) Associating distributions to repository versions https://pulp.plan.io/issues/4745
2) master/detail distributions (no issue yet)

If either of these changes goes forward, it will completely change what these docs need to be, so I propose we remove this one from the current sprint.

#9 Updated by rchan 5 months ago

  • Sprint changed from Sprint 52 to Sprint 53

#10 Updated by amacdona@redhat.com 4 months ago

  • Sprint changed from Sprint 53 to Sprint 54

#11 Updated by ttereshc 4 months ago

  • Sprint changed from Sprint 54 to Sprint 55

#12 Updated by dkliban@redhat.com 3 months ago

  • Sprint changed from Sprint 55 to Sprint 56

#13 Updated by rchan 2 months ago

  • Sprint changed from Sprint 56 to Sprint 57

#14 Updated by rchan about 2 months ago

  • Sprint changed from Sprint 57 to Sprint 58

#15 Updated by daviddavis about 1 month ago

  • Sprint/Milestone deleted (3.0)

#16 Updated by rchan 29 days ago

  • Sprint deleted (Sprint 58)

Please register to edit this issue

Also available in: Atom PDF