Project

Profile

Help

Task #2909

closed

Document the plugin development Vagrant file in the plugin writer's guide

Added by bmbouter over 5 years ago. Updated over 3 years ago.

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

0%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 32
Quarter:

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

Actions #1

Updated by dkliban@redhat.com over 5 years ago

  • Groomed changed from No to Yes
Actions #2

Updated by dkliban@redhat.com over 5 years ago

  • Blocked by Task #2908: Build a plugin writer's Vagrant VM and publish on Vagrant cloud on a Pulp account added
Actions #3

Updated by mhrivnak over 5 years ago

  • Priority changed from Normal to Low
Actions #4

Updated by mhrivnak over 5 years ago

  • Sprint/Milestone set to 42
Actions #5

Updated by mhrivnak over 5 years ago

  • Sprint/Milestone changed from 42 to 43
Actions #6

Updated by mhrivnak over 5 years ago

  • Priority changed from Low to Normal
Actions #7

Updated by jortel@redhat.com about 5 years ago

  • Sprint/Milestone changed from 43 to 44
Actions #8

Updated by fdobrovo about 5 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to fdobrovo
Actions #9

Updated by mhrivnak about 5 years ago

  • Sprint/Milestone changed from 44 to 45
Actions #10

Updated by jortel@redhat.com about 5 years ago

  • Sprint/Milestone changed from 45 to 46
Actions #11

Updated by mhrivnak about 5 years ago

  • Sprint/Milestone changed from 46 to 47
Actions #12

Updated by rchan almost 5 years ago

  • Sprint/Milestone changed from 47 to 48
Actions #13

Updated by ttereshc almost 5 years ago

  • Status changed from ASSIGNED to NEW
  • Assignee deleted (fdobrovo)
Actions #14

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)
Actions #15

Updated by rchan almost 5 years ago

  • Sprint/Milestone changed from 48 to 52
Actions #16

Updated by rchan almost 5 years ago

  • Sprint/Milestone changed from 52 to 53
Actions #17

Updated by jortel@redhat.com almost 5 years ago

  • Sprint/Milestone changed from 53 to 54
Actions #18

Updated by mansari almost 5 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to mansari
Actions #19

Updated by dkliban@redhat.com almost 5 years ago

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.
+
Actions #20

Updated by mansari almost 5 years ago

  • Status changed from ASSIGNED to POST
Actions #21

Updated by bmbouter over 4 years ago

  • Sprint set to Sprint 32
Actions #22

Updated by bmbouter over 4 years ago

  • Sprint/Milestone deleted (54)
Actions #23

Updated by dkliban@redhat.com over 4 years ago

  • Blocked by deleted (Task #2908: Build a plugin writer's Vagrant VM and publish on Vagrant cloud on a Pulp account)
Actions #24

Updated by dkliban@redhat.com over 4 years ago

  • Status changed from POST to CLOSED - WONTFIX
Actions #25

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #26

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3)

Also available in: Atom PDF