Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Commit

Permalink
Describe installation with version agnostic installer (#38)
Browse files Browse the repository at this point in the history
* Describe installation with version agnostic installer
  • Loading branch information
kholdaway authored May 31, 2019
1 parent f4361c1 commit f14ba83
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 41 deletions.
6 changes: 3 additions & 3 deletions source/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Starting the Quipucords Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After you make the decisions on the configuration options for the server, you can start the Quipucords server. The following commands assume that you used the default port and the recommended steps to create a home directory and subdirectories for the SSH keys, the default options for the PostgreSQL database, and the default log output during the Quipucords server configuration.

If your system does not have SELinux enabled, you can start the Quipucords server with the following Docker command::
If your system does not have SELinux enabled, you can start the Quipucords server with the following Docker command, where 1.0.0 is the installed version of Quipucords::

# sudo docker run --name quipucords --link qpc-db:qpc-link -d -e "USE_SUPERVISORD=true" -e "QPC_DBMS_USER=postgres" -e "QPC_DBMS_PASSWORD=password" -e "QPC_DBMS_HOST=qpc-db" -p 9443:443 -v ~/quipucords/sshkeys:/sshkeys -v ~/quipucords/data:/var/data -v ~/quipucords/log:/var/log -i quipucords:1.0.0

If your system does have SELinux enabled, you must append ``:z`` to each volume as follows::
If your system does have SELinux enabled, you must append :z to each volume as follows, where 1.0.0 is the installed version of Quipucords::

# sudo docker run --name quipucords --link qpc-db:qpc-link -d -e "USE_SUPERVISORD=true" -e "QPC_DBMS_USER=postgres" -e "QPC_DBMS_PASSWORD=password" -e "QPC_DBMS_HOST=qpc-db" -p 9443:443 -v ~/quipucords/sshkeys:/sshkeys:z -v ~/quipucords/data:/var/data:z -v ~/quipucords/log:/var/log:z -i quipucords:1.0.0

Expand All @@ -85,7 +85,7 @@ You may also configure the quipucords server by setting the following environmen
- DJANGO_LOGGING_LEVEL
- Infrastructure logging level

To set these values, pass the ``docker run`` command the ``-e "NAME=VALUE`` argument. For example to set ``QPC_SERVER_TIMEOUT`` do::
To set these values, pass the the -e "NAME=VALUE argument for the docker run command. For example, the following command shows how to set QPC_SERVER_TIMEOUT value, where 1.0.0 is the installed version of Quipucords::

# sudo docker run --name quipucords -d -e "QPC_SERVER_TIMEOUT=240" -p 9443:443 -v ~/quipucords/sshkeys:/sshkeys -v ~/quipucords/data:/var/data -v ~/quipucords/log:/var/log -i quipucords:1.0.0

Expand Down
30 changes: 3 additions & 27 deletions source/install_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,15 @@

Installing the Quipucords Command Line Tool
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
qpc, the command line tool that is installed by RPM, is available for `download <https://copr.fedorainfracloud.org/coprs/g/quipucords/qpc/>`_ from the Fedora COPR build and repository system. Use the following steps to install the command line tool.

Download and Configure EPEL
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Enable the EPEL repo for the server. You can find the appropriate architecture and version on the `EPEL wiki <https://fedoraproject.org/wiki/EPEL>`_.

- For Red Hat Enterprise Linux 7 or CentOS 7, enter the following command::

# rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

- For Red Hat Enterprise Linux 6 or CentOS 6, enter the following command::

# rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-6.noarch.rpm

2. Add the COPR repo to your server. You can find the appropriate architecture and version on the `COPR qpc page <https://copr.fedorainfracloud.org/coprs/g/quipucords/qpc/>`_.


- For Red Hat Enterprise Linux 7 or CentOS 7, enter the following command::

# wget -O /etc/yum.repos.d/group_quipucords-qpc-epel-7.repo https://copr.fedorainfracloud.org/coprs/g/quipucords/qpc/repo/epel-7/group_quipucords-qpc-epel-7.repo

- For Red Hat Enterprise Linux 6 or CentOS 6, enter the following command::

# wget -O /etc/yum.repos.d/group_quipucords-qpc-epel-6.repo https://copr.fedorainfracloud.org/coprs/g/quipucords/qpc/repo/epel-6/group_quipucords-qpc-epel-6.repo

qpc, the command line tool that is installed by RPM, is available for download from `GitHub <https://github.com/quipucords/qpc/releases/latest/>`_. Use the following steps to install the command line tool.

Install the QPC Package:
~~~~~~~~~~~~~~~~~~~~~~~~

- For Red Hat Enterprise Linux 7 or CentOS 7, enter the following command::

# yum -y install qpc-1.0.0-ACTUAL_COPR_GIT_COMMIT.el7
# yum -y install https://github.com/quipucords/qpc/releases/latest/download/qpc.el7.noarch.rpm

- For Red Hat Enterprise Linux 6 or CentOS 6, enter the following command::

# yum -y install qpc-1.0.0-ACTUAL_COPR_GIT_COMMIT.el6
# yum -y install https://github.com/quipucords/qpc/releases/latest/download/qpc.el6.noarch.rpm
7 changes: 3 additions & 4 deletions source/install_container_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ After Docker is installed, you can obtain and install the container image that e

1. Download the server container image by entering the following command::

# curl -k -O -sSL https://github.com/quipucords/quipucords/releases/download/1.0.0/quipucords.1.0.0.tar.gz

# curl -k -O -sSL https://github.com/quipucords/quipucords/releases/latest/download/quipucords_server_image.tar.gz

2. Load the container image into the local Docker registry with the following command::

# sudo docker load -i quipucords.1.0.0.tar.gz
# sudo docker load -i quipucords_server_image.tar.gz

The output appears similar to the following example::
If the latest release is 1.0.0. The output appears similar to the following example::

Loaded image: quipucords:1.0.0

Expand Down
10 changes: 5 additions & 5 deletions source/install_scripted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Obtaining the Installer
^^^^^^^^^^^^^^^^^^^^^^^
1. Download the installer by entering the following command::

# curl -k -O -sSL https://github.com/quipucords/quipucords/releases/download/1.0.0/quipucords.1.0.0.install.tar.gz
# curl -k -O -sSL https://github.com/quipucords/quipucords-installer/releases/latest/download/quipucords_install.tar.gz

2. Extract the installer by entering the following command::

# tar -xvzf quipucords.install.tar.gz
# tar -xvzf quipucords_install.tar.gz

Running the Installer
^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -42,7 +42,7 @@ If you choose the offline option to run the installer, you will need to obtain t

**Quipucords Server Package:**

- Server Container Image (`Download <https://github.com/quipucords/quipucords/releases/download/1.0.0/quipucords.1.0.0.tar.gz>`_)
- Server Container Image (`Download <https://github.com/quipucords/quipucords/releases/latest/download/quipucords_server_image.tar.gz>`_)

**Build the Postgres Docker Image:**

Expand All @@ -58,8 +58,8 @@ The Quipucords server requires a Postgres Docker image. You must build the Dock

**Command Line Tool RPM Package:**

- RHEL & CentOS 6 (`Download <https://github.com/quipucords/qpc/releases/download/1.0.0/qpc-1.0.0-ACTUAL_COPR_GIT_COMMIT.el6.noarch.rpm>`_)
- RHEL & CentOS 7 (`Download <https://github.com/quipucords/qpc/releases/download/1.0.0/qpc-1.0.0-ACTUAL_COPR_GIT_COMMIT.el7.noarch.rpm>`_)
- RHEL & CentOS 6 (`Download <https://github.com/quipucords/qpc/releases/latest/download/qpc.el6.noarch.rpm>`_)
- RHEL & CentOS 7 (`Download <https://github.com/quipucords/qpc/releases/latest/download/qpc.el7.noarch.rpm>`_)

**Transfer Packages**

Expand Down
4 changes: 2 additions & 2 deletions source/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Default logging levels for the server can be altered by setting logging environm
- DJANGO_LOGGING_LEVEL
- Infrastructure logging

If your system does not have SELinux enabled, you can start the Quipucords server with the following Docker command with increased logging::
If your system does not have SELinux enabled, you can start the Quipucords server with the following Docker command with increased logging. In the following example, the installed version of Quipucords is 1.0.0::

# sudo docker run --name quipucords -d -p 9443:443 -e QUIPUCORDS_LOGGING_LEVEL=DEBUG -e DJANGO_LOGGING_LEVEL=DEBUG -v ~/quipucords/sshkeys:/sshkeys -v ~/quipucords/data:/var/data -v ~/quipucords/log:/var/log -i quipucords:1.0.0

If your system does have SELinux enabled, you must append ``:z`` to each volume as follows::
If your system does have SELinux enabled, you must append :z to each volume as follows. In the following example, the installed version of Quipucords is 1.0.0::

# sudo docker run --name quipucords -d -p 9443:443 -e QUIPUCORDS_LOGGING_LEVEL=DEBUG -e DJANGO_LOGGING_LEVEL=DEBUG -v ~/quipucords/sshkeys:/sshkeys:z -v ~/quipucords/data:/var/data:z -v ~/quipucords/log:/var/log:z -i quipucords:1.0.0

Expand Down

0 comments on commit f14ba83

Please sign in to comment.