Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduced brief explanation about pulp_installer #688

Merged
merged 1 commit into from May 11, 2020
Merged

Introduced brief explanation about pulp_installer #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/6674.doc
View file
Open in desktop
@@ -0,0 +1 @@
Introduced a brief explanation about `pulp_installer`
55 changes: 52 additions & 3 deletions docs/installation/instructions.rst
View file
Open in desktop
Expand Up @@ -23,8 +23,57 @@ Fedora, CentOS, and Mac OSX.
Ansible Installation (Recommended)
----------------------------------

To use ansible roles to install Pulp 3 instead of manual setup refer to
`Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer/>`_.
`Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer>`__ can be used to
install plugins. For example if your host is in your Ansible inventory as ``myhost`` you
can install onto it with:

.. code-block:: bash

git clone https://github.com/pulp/pulp_installer.git

Create your pulp_install.yml playbook to use with the installer (Uncomment the desired plugins below):

.. code-block:: yaml

---
- hosts: all
vars:
pulp_settings:
secret_key: secret
content_origin: "http://{{ ansible_fqdn }}"
pulp_default_admin_password: password
pulp_install_plugins:
# galaxy-ng: {}
# pulp-ansible: {}
# pulp-certguard: {}
# pulp-container: {}
# pulp-cookbook: {}
# pulp-deb: {}
# pulp-file: {}
# pulp-gem: {}
# pulp-maven: {}
# pulp-npm: {}
# pulp-python: {}
# pulp-rpm:
# prereq_role: "pulp.pulp_rpm_prerequisites" # RPM plugin needs a prereq_role: https://galaxy.ansible.com/pulp/pulp_rpm_prerequisites
roles:
- pulp-database
- pulp-workers
- pulp-resource-manager
- pulp-webserver
- pulp-content
environment:
DJANGO_SETTINGS_MODULE: pulpcore.app.settings

Then install it onto ``myhost`` with:

.. code-block:: bash

ansible-playbook pulp_install.yaml -l myhost


For learning more about the ansible roles to install Pulp 3 please refer to
`Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer/#pulp-3-ansible-installer>`__.

PyPI Installation
-----------------
Expand Down Expand Up @@ -154,7 +203,7 @@ Systemd
-------

To run the four Pulp services, systemd files needs to be created in /usr/lib/systemd/system/. The
`Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer/>`_ makes these for you, but you
`Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer/>`__ makes these for you, but you
Copy link
Member

@bmbouter bmbouter May 11, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What was the motivation for adding the second underscore?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pulp 3 Ansible Installer <https://github.com/pulp/pulp_installer>__
appears 3 times in this doc,
Without the double underscore I got:

/home/travis/build/pulp/pulpcore/docs/installation/instructions.rst:2:Duplicate explicit target name: "pulp 3 ansible installer".
Makefile:55: recipe for target 'html' failed
make: *** [html] Error 2

https://travis-ci.com/github/pulp/pulpcore/jobs/328988703#L1248

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got this solution from here:
https://stackoverflow.com/a/14067756

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool I did not know about that. Thanks!

can also configure them by hand from the templates below. Custom configuration can be applied using
the ``Environment`` option with various :ref:`Pulp settings <settings>`.

Expand Down