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.

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

Fixed a number of broken links in the installation/ section of docs. #1345

Merged
merged 1 commit into from Jun 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/6837.doc
@@ -0,0 +1 @@
Fixed a number of link-problems in the installation/ section of docs.
10 changes: 5 additions & 5 deletions docs/installation/authentication.rst
Expand Up @@ -118,7 +118,7 @@ backend for them. To have any name accepted but create the username in the datab

Or, as a dynaconf environment variable (pay special attention to the *double* underscore
separating the paramater name from the key)::

PULP_REST_FRAMEWORK__DEFAULT_AUTHENTICATION_CLASSES="[
'rest_framework.authentication.SessionAuthentication',
'pulpcore.app.authentication.PulpRemoteUserAuthentication'
Expand All @@ -128,7 +128,7 @@ This removes ``rest_framework.authentication.BasicAuthentication``, but retains
``rest_framework.authentication.SessionAuthentication`` and adds
``PulpRemoteUserAuthentication``. This accepts the username as WSGI environment variable
``REMOTE_USER`` by default, but can be configured via the
`REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>`_ Pulp setting.
:ref:`REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>` Pulp setting.


.. _webserver-auth-same-webserver:
Expand All @@ -146,9 +146,9 @@ Reading the ``REMOTE_USER`` WSGI environment is the default behavior of the
one is that the WSGI environment variable name can be configured from a Pulp provided WSGI
environment variable name.

See the `REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>`_ for configuring the WSGI provided
See the :ref:`REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>` for configuring the WSGI provided
name, but if you are using the ``REMOTE_USER`` WSGI environment name with "same webserver"
authentication, you likely want to leave `REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>`_
authentication, you likely want to leave :ref:`REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>`
unset and configure the webserver to set the ``REMOTE_USER`` WSGI environment variable.


Expand Down Expand Up @@ -178,7 +178,7 @@ default configuration of Pulp is expecting ``REMOTE_USER`` in the WSGI environme
``pulpcore.app.authentication.PulpRemoteUserAuthentication`` or the Django Rest Framework provided
``rest_framework.authentication.RemoteUserAuthentication`` as is.

Pulp provides a setting named `REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>`_ which allows
Pulp provides a setting named :ref:`REMOTE_USER_ENVIRON_NAME <remote-user-environ-name>` which allows
you to specify another WSGI environment variable to read the authenticated username from.

.. warning::
Expand Down
13 changes: 5 additions & 8 deletions docs/installation/instructions.rst
Expand Up @@ -177,26 +177,23 @@ the ``Environment`` option with various :ref:`Pulp settings <settings>`.
content to clients. We recommend starting with the `pulpcore-content template <https://github.com
/pulp/pulp_installer/blob/master/roles/pulp_content/templates/pulpcore-content.service.j2>`_ and
setting the variables according to the `pulpcore_content config variables documentation <https://
github.com/pulp/ pulp_installer/tree/master/roles/pulp_content#variables>`_
github.com/pulp/ pulp_installer/tree/master/roles/pulp_content#role-variables>`_

2. Make a ``pulpcore-api.service`` file for the pulpcore-api service which serves the Pulp REST API. We
recommend starting with the `pulpcore-api template <https://github.com/pulp/pulp_installer/blob/master/
roles/pulp/templates/pulpcore-api.service.j2>`_ and setting the variables according to the `pulpcore-api
config variables documentation <https://github.com/pulp/ pulp_installer/tree/master/roles/
pulp#variables>`_
recommend starting with the `pulpcore-api template <https://github.com/pulp/pulp_installer/blob/master/roles/pulp_api/templates/pulpcore-api.service.j2>`_
and setting the variables according to the `pulpcore-api config variables documentation <https://github.com/pulp/pulp_installer/tree/master/roles/pulp_api#role-variables>`_

3. Make a ``pulpcore-worker@.service`` file for the pulpcore-worker processes which allows you to manage
one or more workers. We recommend starting with the `pulpcore-worker template <https://github.com/pulp/
pulp_installer/blob/master/roles/pulp_workers/templates/pulpcore-worker%40.service.j2>`_ and setting
the variables according to the `pulp_workers config variables documentation <https://github.com/
pulp/pulp_installer/tree/master/roles/pulp_workers#configurable-variables>`_
pulp/pulp_installer/tree/master/roles/pulp_workers#role-variables>`_

4. Make a ``pulpcore-resource-manager.service`` file which can manage one pulpcore-resource-manager
process. We recommend starting with the `pulpcore-resource-manager template <https://github.com/pulp/
pulp_installer/blob/master/roles/pulp_resource_manager/templates/pulpcore-resource-manager.service.
j2>`_ and setting the variables according to the `pulp_resource_manager config variables
documentation <https://github.com/pulp/pulp_installer/tree/master/roles/pulp_resource_manager#
configurable-variables>`_
documentation <https://github.com/pulp/pulp_installer/tree/master/roles/pulp_resource_manager#role-variables>`_

These services can then be started by running::

Expand Down