Project

Profile

Help

Task #2909

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

Added by bmbouter over 2 years ago. Updated 6 months ago.

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

0%

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 32

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


Checklist

History

#1 Updated by dkliban@redhat.com over 2 years ago

  • Groomed changed from No to Yes

#2 Updated by dkliban@redhat.com over 2 years ago

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

#3 Updated by mhrivnak about 2 years ago

  • Priority changed from Normal to Low

#4 Updated by mhrivnak about 2 years ago

  • Sprint/Milestone set to 42

#5 Updated by mhrivnak about 2 years ago

  • Sprint/Milestone changed from 42 to 43

#6 Updated by mhrivnak about 2 years ago

  • Priority changed from Low to Normal

#7 Updated by jortel@redhat.com about 2 years ago

  • Sprint/Milestone changed from 43 to 44

#8 Updated by fdobrovo about 2 years ago

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

#9 Updated by mhrivnak about 2 years ago

  • Sprint/Milestone changed from 44 to 45

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

  • Sprint/Milestone changed from 45 to 46

#11 Updated by mhrivnak almost 2 years ago

  • Sprint/Milestone changed from 46 to 47

#12 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 47 to 48

#13 Updated by ttereshc almost 2 years ago

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

#14 Updated by bmbouter almost 2 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)

#15 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 48 to 52

#16 Updated by rchan almost 2 years ago

  • Sprint/Milestone changed from 52 to 53

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

  • Sprint/Milestone changed from 53 to 54

#18 Updated by mansari over 1 year ago

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

#19 Updated by dkliban@redhat.com over 1 year 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.
+

#20 Updated by mansari over 1 year ago

  • Status changed from ASSIGNED to POST

#21 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 32

#22 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (54)

#23 Updated by dkliban@redhat.com over 1 year ago

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

#24 Updated by dkliban@redhat.com over 1 year ago

  • Status changed from POST to CLOSED - WONTFIX

#25 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#26 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF