Task #3132: Document how to deploy Pulp - Pulp

Send by e-mail

Task #3132

Document how to deploy Pulp

Added by bmbouter almost 3 years ago. Updated 10 months ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

bmbouter

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

% Done:

100%

Estimated time:

Platform Release:

Groomed:

Yes

Sprint Candidate:

Yes

Tags:

Documentation

Sprint:

Sprint 35

Quarter:

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

Hide closed

Checklist

Create a 'Deploying' page in the docs

Related issues

Associated revisions

Revision 29e34cab View on GitHub
Added by bmbouter over 2 years 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 2 years ago

Adds WSGI and Architecture Docs

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

History

#1 Updated by dalley almost 3 years ago

Tracker changed from Issue to Task
% Done set to 0

#2 Updated by bmbouter almost 3 years ago

Description updated (diff)

#3 Updated by bmbouter almost 3 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 almost 3 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.