Skip to content

Commit

Permalink
chore: update installation docs and psycopg dependency (#690)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex <aizquier@redhat.com>
  • Loading branch information
Alex-Izquierdo committed Jun 7, 2024
1 parent 857ce65 commit 432b284
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ Installation
These instructions will guide you though installing the ansible-rulebook CLI on your local system.
Please ensure you have installed all components listed in the **Requirements** section before starting the installation process.


Container Image
------------

The ansible-rulebook CLI is also available as a container image.
You can pull the latest image from the `quay.io <https://quay.io/repository/ansible/ansible-rulebook>`_ registry:

.. code-block:: shell
podman pull quay.io/ansible/ansible-rulebook:latest
Requirements
------------

Expand All @@ -30,6 +43,13 @@ Installation via pip

pip install ansible-rulebook ansible ansible-runner

.. note::

ansible-rulebook installs by default the package psycopg-binary which is a PostgreSQL database adapter precompiled for the most common platforms.
For production environments, it is recommended to install the psycopg package instead, which requires the PostgreSQL development headers to be installed on the system.
Look at the `psycopg installation instructions <https://www.psycopg.org/psycopg3/docs/basic/install.html#local-installation>`_ for more information.
pip install ansible-rulebook[production]

.. note::

ansible-rulebook relies on the `jpy` Python package to communicate with the Java runtime. This package provide wheels for the most common platforms,
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ install_requires =
watchdog
xxhash
pyyaml
psycopg[binary]

[options.packages.find]
include =
Expand Down

0 comments on commit 432b284

Please sign in to comment.