Project

Profile

Help

Task #3132

Document how to deploy Pulp

Added by bmbouter about 2 years ago. Updated 7 months ago.

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

100%

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

Description

Users should have docs on how they can configure the webserver to serve Pulp. This should be a "Webserver" section on a new page to be created in the docs called "Deploying".

These docs should explain to the user the top level url(s) hat need to be matched for the "content" part of Pulp and the "REST API". Specifically the "content" part needs to match on /content/ and route that to the Pulp WSGI app. For the REST API part it needs to match on both /api/v3/.

This documentation should not give examples for specific webservers. It should generally fulfill the following requirements:

As a deployer of Pulp, I understand the urls Pulp needs to serve the "Content" part of Pulp and that I need to route them to the Pulp WSGI app
As a deployer of Pulp, I understand the urls Pulp needs to serve the REST API and that I need to route them to the Pulp WSGI app


Checklist


Related issues

Related to Pulp - Task #2922: Create and publish an ansible role to install and configure nginx for pulp CLOSED - COMPLETE Actions
Related to Pulp - Task #2921: Create and publish an ansible role to install apache and configure it for pulp CLOSED - WONTFIX Actions
Duplicated by Pulp - Task #3114: Document the webserver requirements CLOSED - DUPLICATE Actions

Associated revisions

Revision 29e34cab View on GitHub
Added by bmbouter over 1 year ago

Adds WSGI and Architecture Docs

This creates an Architecture and Scaling top level section of the docs.
It also explains for each component how it can be scaled which mostly
involves documenting how the WSGI application is laid out.

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

Revision 29e34cab View on GitHub
Added by bmbouter over 1 year ago

Adds WSGI and Architecture Docs

This creates an Architecture and Scaling top level section of the docs.
It also explains for each component how it can be scaled which mostly
involves documenting how the WSGI application is laid out.

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

Revision 29e34cab View on GitHub
Added by bmbouter over 1 year ago

Adds WSGI and Architecture Docs

This creates an Architecture and Scaling top level section of the docs.
It also explains for each component how it can be scaled which mostly
involves documenting how the WSGI application is laid out.

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

History

#1 Updated by dalley about 2 years ago

  • Tracker changed from Issue to Task
  • % Done set to 0

#2 Updated by bmbouter about 2 years ago

  • Description updated (diff)

#3 Updated by bmbouter about 2 years ago

A question came up asking if this was making two new django apps. I had not planned on splitting the Django apps because practically speaking it would be hard to do so. Without actually making the content app a separate Django app, we aren't creating any value by having the same Django app served in another WSGI file with a different name.

Practically speaking, we don't need to ship multiple Django apps for the Pulp3 MVP, so I recommend this be closed as NOTABUG.

#4 Updated by bmbouter about 2 years ago

  • Subject changed from Create and document WSGI applications to Document how to deploy Pulp
  • Description updated (diff)
  • Tags Documentation added

Rewriting after IRC convo where the goal became to convert this to a docs story and document the Pulp requirements.

#5 Updated by dkliban@redhat.com about 2 years ago

  • Groomed changed from No to Yes

#6 Updated by rchan about 2 years ago

  • Sprint/Milestone set to 48

#7 Updated by bmbouter about 2 years ago

  • Duplicated by Task #3114: Document the webserver requirements added

#8 Updated by bmbouter about 2 years ago

  • Related to Task #2922: Create and publish an ansible role to install and configure nginx for pulp added

#9 Updated by bmbouter about 2 years ago

  • Related to Task #2921: Create and publish an ansible role to install apache and configure it for pulp added

#10 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 48 to 52

#11 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 52 to 53

#12 Updated by jortel@redhat.com almost 2 years ago

  • Sprint/Milestone changed from 53 to 54

#13 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 54 to 56

#14 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 33

#15 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (56)

#16 Updated by jortel@redhat.com over 1 year ago

  • Sprint changed from Sprint 33 to Sprint 34

#17 Updated by bmbouter over 1 year ago

  • Description updated (diff)

Removing /status/ from description because it is actually nested under /api/v3/

#18 Updated by daviddavis over 1 year ago

  • Sprint changed from Sprint 34 to Sprint 35

#19 Updated by bmbouter over 1 year ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#20 Updated by bmbouter over 1 year ago

  • Status changed from ASSIGNED to POST

#21 Updated by bmbouter over 1 year ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#22 Updated by daviddavis 7 months ago

  • Sprint/Milestone set to 3.0

#23 Updated by bmbouter 7 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF