AWS security group update script
================================

Use this script to automatically update an AWS security group to allow ingress
from Faculty on a set of ports.

.. warning::

    This script will remove all other ingress rules from any security group it
    is applied to. We strongly recommend making a dedicated security group for
    access from Faculty, separate from other rules you may have configured.

Script source
-------------

.. literalinclude:: update_faculty_aws_securitygroup.py

Usage
-----

Run the script with ``--help`` to get documentation about the command line
interface. Pass as arguments the :ref:`URL of the IP address API
<cluster-ips-endpoint>` on the relevant Faculty deployment, the security group
you want to update, and the ports you want to have open to ingress from
Faculty:

.. code-block:: bash

    $ python update_faculty_aws_securitygroup.py \
        https://example.my.faculty.ai/api/cluster/ip-addresses \
        sg-00000000 5432 3306

By default, no changes are applied, but a summary of changes is instead printed
to the terminal. To apply the changes to the security group, run again adding
the ``--yes`` flag.