Document the plugin development Vagrant file in the plugin writer's guide
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
Updated by email@example.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. +