Task #2909
closed
Document the plugin development Vagrant file in the plugin writer's guide
Description
Task #2908 is to create and publish regularly a plugin development VM. This story is to document that in the plugin writer's guide and maybe also the template plugin's readme.
The important content to share here is that all the user should have to do to start their plugin is:
1. Install Vagrant on a machine (see existing Pulp2 Vagrant docs)
2. Install the libvirtd backend for Vagrant (see existing Pulp2 Vagrant docs)
3. vagrant init pulp/pulpcore
4. vagrant up
5. vagrant ssh
- Groomed changed from No to Yes
- Blocked by Task #2908: Build a plugin writer's Vagrant VM and publish on Vagrant cloud on a Pulp account added
- Priority changed from Normal to Low
- Sprint/Milestone set to 42
- Sprint/Milestone changed from 42 to 43
- Priority changed from Low to Normal
- Sprint/Milestone changed from 43 to 44
- Status changed from NEW to ASSIGNED
- Assignee set to fdobrovo
- Sprint/Milestone changed from 44 to 45
- Sprint/Milestone changed from 45 to 46
- Sprint/Milestone changed from 46 to 47
- Sprint/Milestone changed from 47 to 48
- Status changed from ASSIGNED to NEW
- Assignee deleted (
fdobrovo)
- Tags deleted (
Pulp 3 Plugin Writer Alpha)
- Sprint/Milestone changed from 48 to 52
- Sprint/Milestone changed from 52 to 53
- Sprint/Milestone changed from 53 to 54
- Status changed from NEW to ASSIGNED
- Assignee set to mansari
Here are some docs I have written that are relevant to this issue.
diff --git a/docs/contributing/dev-setup/quickstart.rst b/docs/contributing/dev-setup/quickstart.rst
index f916e5429..c1f62c2bf 100644
--- a/docs/contributing/dev-setup/quickstart.rst
+++ b/docs/contributing/dev-setup/quickstart.rst
@@ -1,3 +1,34 @@
+.. _vagrantcloud:
+
+Vagrant Cloud
+=============
+
+Each release of ``pulpcore`` on PyPI is released as a Vagrant box on `vagrantcloud.com <https://app.vagrantup.com/pulp/boxes/pulpcore>`_.
+
+Start up the ``pulpcore`` Vagrant box::
+
+ $ vagrant init pulp/pulpcore
+ $ vagrant up
+
+Once the box is downloaded and booted an ssh connection can be established with a forward tunnel for port 8000::
+
+ $ vagrant ssh -- -L 8000:localhost:8000
+
+Become user ``pulp``, activate the ``pulpenv`` virtual env, and start the webserver::
+
+ $ sudo su - pulp
+ $ source pulpvenv/bin/activate
+ $ pulp-manager runserver
+
+The browsable API can be accessed at http://localhost:8000/api/v3/ on the host machine machine.
+
- Status changed from ASSIGNED to POST
- Sprint/Milestone deleted (
54)
- Blocked by deleted (Task #2908: Build a plugin writer's Vagrant VM and publish on Vagrant cloud on a Pulp account)
- Status changed from POST to CLOSED - WONTFIX
- Sprint/Milestone set to 3.0.0
Also available in: Atom
PDF
.