From 432b284f134c22626186cb999711deaa798db665 Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 7 Jun 2024 20:32:27 +0200 Subject: [PATCH] chore: update installation docs and psycopg dependency (#690) Signed-off-by: Alex --- docs/installation.rst | 20 ++++++++++++++++++++ setup.cfg | 1 + 2 files changed, 21 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index 250e7d30..12dbb0b5 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 `_ registry: + +.. code-block:: shell + + podman pull quay.io/ansible/ansible-rulebook:latest + + + Requirements ------------ @@ -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 `_ 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, diff --git a/setup.cfg b/setup.cfg index cc7d687b..bc438dc3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,6 +35,7 @@ install_requires = watchdog xxhash pyyaml + psycopg[binary] [options.packages.find] include =