Project

Profile

Help

Issue #2701

closed

Crane documentation doesn't answer critical installation and usage questions

Added by Ichimonji10 almost 7 years ago. Updated over 3 years ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Start date:
Due date:
Estimated time:
(Total: 0:00 h)
Severity:
2. Medium
Version - Crane:
Platform Release:
Target Release - Crane:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Pulp 2
Sprint:
Quarter:

Description

I've read through the following:

None of these documents state how to install Crane. I'd expect to see the following documented:

  • How can Crane be installed? Is Crane a pure-Python application that can be installed in all the usual ways, such as in a virtualenv with pip, with python setup.py install, with python setup.py install --user, from PyPi, etc? Are there distrubution-specific methods for installing Crane, such as with RPMs? Are there other ways?
  • What is Crane? Is it a daemon? A library? Something else? An experienced Pythonista might intuit that, since Flask is a library for building web applications, Crane is probably a daemon that uses Flask. But others who know less about the Python ecosystem wouldn't be able to figure that out. And a user shouldn't need to care or know about implementation details like which library is used to make Crane.
  • How does Crane interact with the rest of the world? Is it a library that other applications use? Is it a daemon that should be started some-how? If a daemon, how can it be started by hand, or by an init system (SysV, systemd)?
  • If Crane is a daemon, then how should messages be sent to it? Should the firewall be opened up so that other applications in the wild can talk directly to Crane? Should a web server (like Apache, Nginx, LightTPD, etc) be configured with a reverse proxy?

Subtasks 1 (0 open1 closed)

Issue #2717: Config file's "data_dir" default value doesn't work with PulpCLOSED - WONTFIXActions

Also available in: Atom PDF