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.

Sign up for GitHub

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

Jump to bottom

Bump the python-dependencies group with 4 updates #288

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Bump the python-dependencies group with 4 updates #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6cd9c6
Bump the python-dependencies group with 4 updates
dependabot[bot] Feb 1, 2024
787d563
Drops sphinx pydantic
djperrefort Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
'sphinx.ext.githubpages',
'sphinx_copybutton',
'sphinxarg.ext',
'sphinx-pydantic'
]

# Customize default options for the sphinx autodoc utility
Expand Down
74 changes: 70 additions & 4 deletions docs/source/overview/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,76 @@ If this file does not exist, the application will run using the default settings
A full list of available settings and their defaults is provided below.


Core Settings
.............

.. important:: The top level ``file_systems`` field is a nested field and entries
should adhere to the :ref:`#/$defs/filesystemschema` schema outlined below.
should adhere to the :ref:`fs-label` schema outlined below.

+------------------+-----------------------------------------+---------------------------------------------------------+
| Setting | Default Value | Description |
+==================+=========================================+=========================================================+
| ihome_quota_path | ``/ihome/crc/scripts/ihome_quota.json`` | Path to ihome storage information. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| file_systems | ``[]`` | List of file systems to examine. See the |
| | | :ref:`fs-label` section for details |
+------------------+-----------------------------------------+---------------------------------------------------------+
| uid_blacklist | ``[0]`` | Do not notify users with these UID values. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| gid_blacklist | ``[0]`` | Do not notify groups with these GID values. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| disk_timeout | ``30`` | Give up on checking a file system after |
| | | the given number of seconds. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| log_level | ``INFO`` | Application logging level. |
| log_level | ``INFO`` | One of ``DEBUG``, ``INFO``, ``WARNING``, or ``ERROR``. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| log_path | | Optionally log application events to a |
| | | file. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| smtp_host | Matches system default. | Name of the SMTP host server. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| smtp_port | Matches system default. | Port for the SMTP server. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| db_url | ``sqlite:///notifier_data.db`` | URL for the application database. By |
| | | default, a SQLITE database is created in |
| | | the working directory. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| email_from | ``[email protected]`` | From address for automatically generated |
| | | emails. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| email_subject | ``CRC Disk Usage Alert`` | Subject line for automatically generated |
| | | emails. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| email_domain | ``@domain.com`` | String to append to usernames when |
| | | generating user email addresses. The |
| | | leading ``@`` is optional. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| admin_emails | ``[]`` | Admin users to contact when the |
| | | application encounters a critical issue. |
+------------------+-----------------------------------------+---------------------------------------------------------+
| debug | ``False`` | Disable database commits and email |
| | | notifications. Useful for development |
| | | and testing. |
+------------------+-----------------------------------------+---------------------------------------------------------+

.. _fs-label:

File System Settings
....................

The following fields are required when defining which file systems to scan.

.. pydantic:: quota_notifier.settings.SettingsSchema
+------------------------+---------------------------------------------------------------------------------------------+
| Setting | Description |
+========================+=============================================================================================+
| name | Human-readable name for the file system. |
+------------------------+---------------------------------------------------------------------------------------------+
| path | Absolute path to the mounted file system. |
+------------------------+---------------------------------------------------------------------------------------------+
| type | Type of the file system. Options: ``ihome``, ``generic``, ``beegfs``. If modifying options, |
| | update QuotaType in ``quota_notifier.disk_utils.QuotaFactory``. |
+------------------------+---------------------------------------------------------------------------------------------+
| thresholds | Usage percentages to issue notifications for. |
+------------------------+---------------------------------------------------------------------------------------------+

.. _#/$defs/filesystemschema:
.. pydantic:: quota_notifier.settings.FileSystemSchema
8 changes: 3 additions & 5 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ notifier = "quota_notifier.cli:Application.execute"

[tool.poetry.dependencies]
python = ">=3.8"
pydantic-settings = "2.0.3"
sqlalchemy = "2.0.21"
pydantic-settings = "2.1.0"
sqlalchemy = "2.0.25"

[tool.poetry.group.tests]
optional = true
Expand All @@ -45,6 +45,4 @@ optional = true
sphinx = "6.2.1"
sphinx-argparse = "0.4.0"
sphinx-copybutton = "0.5.2"
sphinx-pydantic = "0.1.1"
sphinx-rtd-theme = "1.2.2"
sphinx-jsonschema = "1.15"
sphinx-rtd-theme = "2.0.0"
Loading