openstack-janitor 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. openstack_janitor-0.1.0/.github/workflows/ci.yml +32 -0
  2. openstack_janitor-0.1.0/.github/workflows/release.yml +36 -0
  3. openstack_janitor-0.1.0/.gitignore +17 -0
  4. openstack_janitor-0.1.0/.pre-commit-config.yaml +20 -0
  5. openstack_janitor-0.1.0/CHANGELOG.md +31 -0
  6. openstack_janitor-0.1.0/LICENSE +201 -0
  7. openstack_janitor-0.1.0/PKG-INFO +109 -0
  8. openstack_janitor-0.1.0/README.md +92 -0
  9. openstack_janitor-0.1.0/pyproject.toml +46 -0
  10. openstack_janitor-0.1.0/src/openstack_janitor/__init__.py +3 -0
  11. openstack_janitor-0.1.0/src/openstack_janitor/age.py +42 -0
  12. openstack_janitor-0.1.0/src/openstack_janitor/cli.py +106 -0
  13. openstack_janitor-0.1.0/src/openstack_janitor/connection.py +32 -0
  14. openstack_janitor-0.1.0/src/openstack_janitor/detectors/__init__.py +31 -0
  15. openstack_janitor-0.1.0/src/openstack_janitor/detectors/base.py +36 -0
  16. openstack_janitor-0.1.0/src/openstack_janitor/detectors/floating_ips.py +42 -0
  17. openstack_janitor-0.1.0/src/openstack_janitor/detectors/instances.py +71 -0
  18. openstack_janitor-0.1.0/src/openstack_janitor/detectors/ports.py +46 -0
  19. openstack_janitor-0.1.0/src/openstack_janitor/detectors/security_groups.py +71 -0
  20. openstack_janitor-0.1.0/src/openstack_janitor/detectors/snapshots.py +58 -0
  21. openstack_janitor-0.1.0/src/openstack_janitor/detectors/volumes.py +39 -0
  22. openstack_janitor-0.1.0/src/openstack_janitor/reporting.py +97 -0
  23. openstack_janitor-0.1.0/tests/conftest.py +141 -0
  24. openstack_janitor-0.1.0/tests/test_age.py +51 -0
  25. openstack_janitor-0.1.0/tests/test_cli.py +158 -0
  26. openstack_janitor-0.1.0/tests/test_connection.py +25 -0
  27. openstack_janitor-0.1.0/tests/test_floating_ips_detector.py +69 -0
  28. openstack_janitor-0.1.0/tests/test_instances_detector.py +85 -0
  29. openstack_janitor-0.1.0/tests/test_ports_detector.py +59 -0
  30. openstack_janitor-0.1.0/tests/test_reporting.py +69 -0
  31. openstack_janitor-0.1.0/tests/test_security_groups_detector.py +105 -0
  32. openstack_janitor-0.1.0/tests/test_snapshots_detector.py +76 -0
  33. openstack_janitor-0.1.0/tests/test_volumes_detector.py +72 -0
@@ -0,0 +1,32 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.11", "3.12"]
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - uses: actions/setup-python@v5
19
+ with:
20
+ python-version: ${{ matrix.python-version }}
21
+
22
+ - name: Install
23
+ run: pip install -e ".[dev]"
24
+
25
+ - name: Lint (ruff check)
26
+ run: ruff check .
27
+
28
+ - name: Lint (ruff format)
29
+ run: ruff format --check .
30
+
31
+ - name: Test
32
+ run: pytest
@@ -0,0 +1,36 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags: ["v*"]
6
+
7
+ jobs:
8
+ build:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+ - uses: actions/setup-python@v5
13
+ with:
14
+ python-version: "3.12"
15
+ - name: Build sdist and wheel
16
+ run: |
17
+ python -m pip install build
18
+ python -m build
19
+ - uses: actions/upload-artifact@v4
20
+ with:
21
+ name: dist
22
+ path: dist/
23
+
24
+ publish:
25
+ needs: build
26
+ runs-on: ubuntu-latest
27
+ environment: pypi
28
+ permissions:
29
+ # Required for PyPI trusted publishing (OIDC) - no API token is stored.
30
+ id-token: write
31
+ steps:
32
+ - uses: actions/download-artifact@v4
33
+ with:
34
+ name: dist
35
+ path: dist/
36
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,17 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.egg-info/
6
+ dist/
7
+ build/
8
+
9
+ # Virtual environments
10
+ .venv/
11
+ venv/
12
+
13
+ # Testing / coverage
14
+ .pytest_cache/
15
+ .ruff_cache/
16
+ .coverage
17
+ htmlcov/
@@ -0,0 +1,20 @@
1
+ repos:
2
+ - repo: https://github.com/gitleaks/gitleaks
3
+ rev: v8.30.1
4
+ hooks:
5
+ - id: gitleaks
6
+
7
+ - repo: https://github.com/astral-sh/ruff-pre-commit
8
+ rev: v0.15.20
9
+ hooks:
10
+ - id: ruff
11
+ args: [--fix]
12
+ - id: ruff-format
13
+
14
+ - repo: https://github.com/pre-commit/pre-commit-hooks
15
+ rev: v6.0.0
16
+ hooks:
17
+ - id: trailing-whitespace
18
+ - id: end-of-file-fixer
19
+ - id: check-yaml
20
+ - id: check-added-large-files
@@ -0,0 +1,31 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented in this file. The format
4
+ follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and versions
5
+ follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [0.1.0] - 2026-07-14
8
+
9
+ First release: the complete read-only audit story.
10
+
11
+ ### Added
12
+
13
+ - `janitor audit` command that scans an OpenStack cloud and reports
14
+ orphaned/wasteful resources, with cron-friendly exit codes
15
+ (`0` clean, `1` findings, `2` unknown detector, `3` connection failure).
16
+ - Six read-only detectors:
17
+ - `unattached-volumes` — volumes in `available` status with no attachments.
18
+ - `unassociated-floating-ips` — floating IPs not associated with any port.
19
+ - `orphaned-ports` — ports with no device owner and no device id.
20
+ - `old-snapshots` — snapshots older than a threshold (default 90 days).
21
+ - `shutoff-instances` — instances SHUTOFF for at least a threshold
22
+ (default 30 days, conservative lower bound).
23
+ - `unused-security-groups` — groups with no port attachment and no
24
+ `remote_group_id` reference; the per-project `default` group is skipped.
25
+ - `--format table|json|html` report output.
26
+ - `--cloud` (named cloud from `clouds.yaml`) and repeatable `--detector`
27
+ selection.
28
+ - Non-admin fallback: detectors that use admin-only `all_projects` listings
29
+ retry scoped to the caller's own project when forbidden.
30
+
31
+ [0.1.0]: https://github.com/mabunemeh/openstack-janitor/releases/tag/v0.1.0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing
141
+ the origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Mohammad AbuNemeh
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,109 @@
1
+ Metadata-Version: 2.4
2
+ Name: openstack-janitor
3
+ Version: 0.1.0
4
+ Summary: Audit an OpenStack cloud for orphaned and wasteful resources
5
+ Author-email: Mohammad AbuNemeh <mabunemeh@gmail.com>
6
+ License-Expression: Apache-2.0
7
+ License-File: LICENSE
8
+ Requires-Python: >=3.11
9
+ Requires-Dist: openstacksdk>=3.0
10
+ Requires-Dist: rich>=13
11
+ Requires-Dist: typer>=0.12
12
+ Provides-Extra: dev
13
+ Requires-Dist: pytest; extra == 'dev'
14
+ Requires-Dist: pytest-cov; extra == 'dev'
15
+ Requires-Dist: ruff; extra == 'dev'
16
+ Description-Content-Type: text/markdown
17
+
18
+ # openstack-janitor
19
+
20
+ [![CI](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml/badge.svg)](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml)
21
+
22
+ A CLI that audits an OpenStack cloud for orphaned and wasteful resources.
23
+
24
+ **Status: early development.** Six detectors are working — see
25
+ [Detectors](#detectors); more detectors and a `clean` command are coming — see
26
+ [Roadmap](#roadmap).
27
+
28
+ ## Install
29
+
30
+ From source:
31
+
32
+ ```sh
33
+ git clone <this repo>
34
+ cd openstack-janitor
35
+ pip install -e .
36
+ ```
37
+
38
+ Publishing to PyPI (`pip install openstack-janitor`) and a `pipx`-friendly
39
+ release are planned once there's more than one detector.
40
+
41
+ ## Usage
42
+
43
+ ```sh
44
+ janitor audit
45
+ janitor audit --cloud my-cloud
46
+ janitor audit --detector unattached-volumes --detector orphaned-ports
47
+ janitor audit --format json > findings.json
48
+ janitor audit --format html > report.html
49
+ ```
50
+
51
+ `--format table` (the default) prints a rich table; `json` and `html` write
52
+ machine-readable / shareable reports to stdout.
53
+
54
+ Example output when orphaned volumes are found:
55
+
56
+ ```
57
+ $ janitor audit --cloud my-cloud
58
+ openstack-janitor findings
59
+ ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
60
+ ┃ Type ┃ ID ┃ Name ┃ Project ┃ Reason ┃
61
+ ┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
62
+ │ volume │ a1b2c3d4… │ old-db │ proj-1 │ volume is unattached │
63
+ │ │ │ │ │ (status=available) │
64
+ └───────────────┴───────────┴─────────┴─────────┴──────────────────────────────┘
65
+ $ echo $?
66
+ 1
67
+ ```
68
+
69
+ `janitor audit` exits `0` when nothing is found, `1` when findings were
70
+ reported (so it's safe to wire into a cron job or CI check), `2` if an
71
+ unknown `--detector` name is given, and `3` if connecting to the cloud
72
+ fails.
73
+
74
+ ## Detectors
75
+
76
+ | Name | Flags |
77
+ | --- | --- |
78
+ | `unattached-volumes` | Volumes in `available` status with no attachments. |
79
+ | `unassociated-floating-ips` | Floating IPs not associated with any port. |
80
+ | `orphaned-ports` | Ports with no device owner and no device id. Infrastructure ports (DHCP, routers, load balancer VIPs) always carry one of these, so they are never flagged; a pre-created port awaiting attachment will be. |
81
+ | `old-snapshots` | Volume snapshots older than a threshold (default 90 days). |
82
+ | `shutoff-instances` | Instances in `SHUTOFF` status whose last update is older than a threshold (default 30 days). There is no "shutoff since" field in the Compute API, so the age is a conservative lower bound — the detector may under-report but never over-reports. |
83
+ | `unused-security-groups` | Security groups not attached to any port and not referenced as a `remote_group_id` by any rule. The per-project `default` group is always skipped. |
84
+
85
+ All detectors are read-only. Resources without a parseable timestamp are never
86
+ flagged by the age-based detectors. Thresholds become configurable once
87
+ `janitor.toml` support lands (see [Roadmap](#roadmap)).
88
+
89
+ ## Authentication
90
+
91
+ `openstack-janitor` uses [openstacksdk](https://docs.openstack.org/openstacksdk/latest/)
92
+ for authentication, so anything openstacksdk understands works here too:
93
+
94
+ - A named cloud from `clouds.yaml` via `--cloud my-cloud` (or the `OS_CLOUD`
95
+ environment variable).
96
+ - The standard `OS_*` environment variables (`OS_AUTH_URL`, `OS_USERNAME`,
97
+ `OS_PASSWORD`, `OS_PROJECT_NAME`, etc.) if no cloud is specified.
98
+
99
+ See the openstacksdk
100
+ [configuration documentation](https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html)
101
+ for the full resolution order and file locations.
102
+
103
+ ## Roadmap
104
+
105
+ - A `clean` command with a `--dry-run` default and explicit `--yes` to act.
106
+ - `janitor.toml` for per-cloud configuration (which detectors run, age
107
+ thresholds, exclusions).
108
+ - Safety rails: tagging/exclusion lists so resources can be marked "do not
109
+ touch" before `clean` ever deletes anything.
@@ -0,0 +1,92 @@
1
+ # openstack-janitor
2
+
3
+ [![CI](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml/badge.svg)](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml)
4
+
5
+ A CLI that audits an OpenStack cloud for orphaned and wasteful resources.
6
+
7
+ **Status: early development.** Six detectors are working — see
8
+ [Detectors](#detectors); more detectors and a `clean` command are coming — see
9
+ [Roadmap](#roadmap).
10
+
11
+ ## Install
12
+
13
+ From source:
14
+
15
+ ```sh
16
+ git clone <this repo>
17
+ cd openstack-janitor
18
+ pip install -e .
19
+ ```
20
+
21
+ Publishing to PyPI (`pip install openstack-janitor`) and a `pipx`-friendly
22
+ release are planned once there's more than one detector.
23
+
24
+ ## Usage
25
+
26
+ ```sh
27
+ janitor audit
28
+ janitor audit --cloud my-cloud
29
+ janitor audit --detector unattached-volumes --detector orphaned-ports
30
+ janitor audit --format json > findings.json
31
+ janitor audit --format html > report.html
32
+ ```
33
+
34
+ `--format table` (the default) prints a rich table; `json` and `html` write
35
+ machine-readable / shareable reports to stdout.
36
+
37
+ Example output when orphaned volumes are found:
38
+
39
+ ```
40
+ $ janitor audit --cloud my-cloud
41
+ openstack-janitor findings
42
+ ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
43
+ ┃ Type ┃ ID ┃ Name ┃ Project ┃ Reason ┃
44
+ ┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
45
+ │ volume │ a1b2c3d4… │ old-db │ proj-1 │ volume is unattached │
46
+ │ │ │ │ │ (status=available) │
47
+ └───────────────┴───────────┴─────────┴─────────┴──────────────────────────────┘
48
+ $ echo $?
49
+ 1
50
+ ```
51
+
52
+ `janitor audit` exits `0` when nothing is found, `1` when findings were
53
+ reported (so it's safe to wire into a cron job or CI check), `2` if an
54
+ unknown `--detector` name is given, and `3` if connecting to the cloud
55
+ fails.
56
+
57
+ ## Detectors
58
+
59
+ | Name | Flags |
60
+ | --- | --- |
61
+ | `unattached-volumes` | Volumes in `available` status with no attachments. |
62
+ | `unassociated-floating-ips` | Floating IPs not associated with any port. |
63
+ | `orphaned-ports` | Ports with no device owner and no device id. Infrastructure ports (DHCP, routers, load balancer VIPs) always carry one of these, so they are never flagged; a pre-created port awaiting attachment will be. |
64
+ | `old-snapshots` | Volume snapshots older than a threshold (default 90 days). |
65
+ | `shutoff-instances` | Instances in `SHUTOFF` status whose last update is older than a threshold (default 30 days). There is no "shutoff since" field in the Compute API, so the age is a conservative lower bound — the detector may under-report but never over-reports. |
66
+ | `unused-security-groups` | Security groups not attached to any port and not referenced as a `remote_group_id` by any rule. The per-project `default` group is always skipped. |
67
+
68
+ All detectors are read-only. Resources without a parseable timestamp are never
69
+ flagged by the age-based detectors. Thresholds become configurable once
70
+ `janitor.toml` support lands (see [Roadmap](#roadmap)).
71
+
72
+ ## Authentication
73
+
74
+ `openstack-janitor` uses [openstacksdk](https://docs.openstack.org/openstacksdk/latest/)
75
+ for authentication, so anything openstacksdk understands works here too:
76
+
77
+ - A named cloud from `clouds.yaml` via `--cloud my-cloud` (or the `OS_CLOUD`
78
+ environment variable).
79
+ - The standard `OS_*` environment variables (`OS_AUTH_URL`, `OS_USERNAME`,
80
+ `OS_PASSWORD`, `OS_PROJECT_NAME`, etc.) if no cloud is specified.
81
+
82
+ See the openstacksdk
83
+ [configuration documentation](https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html)
84
+ for the full resolution order and file locations.
85
+
86
+ ## Roadmap
87
+
88
+ - A `clean` command with a `--dry-run` default and explicit `--yes` to act.
89
+ - `janitor.toml` for per-cloud configuration (which detectors run, age
90
+ thresholds, exclusions).
91
+ - Safety rails: tagging/exclusion lists so resources can be marked "do not
92
+ touch" before `clean` ever deletes anything.
@@ -0,0 +1,46 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "openstack-janitor"
7
+ version = "0.1.0"
8
+ description = "Audit an OpenStack cloud for orphaned and wasteful resources"
9
+ readme = "README.md"
10
+ requires-python = ">=3.11"
11
+ license = "Apache-2.0"
12
+ authors = [
13
+ { name = "Mohammad AbuNemeh", email = "mabunemeh@gmail.com" },
14
+ ]
15
+ dependencies = [
16
+ "openstacksdk>=3.0",
17
+ "typer>=0.12",
18
+ "rich>=13",
19
+ ]
20
+
21
+ [project.optional-dependencies]
22
+ dev = [
23
+ "pytest",
24
+ "pytest-cov",
25
+ "ruff",
26
+ ]
27
+
28
+ [project.scripts]
29
+ janitor = "openstack_janitor.cli:main"
30
+
31
+ [tool.hatch.build.targets.wheel]
32
+ packages = ["src/openstack_janitor"]
33
+
34
+ [tool.ruff]
35
+ line-length = 100
36
+ target-version = "py311"
37
+
38
+ [tool.ruff.lint]
39
+ select = ["E", "F", "I", "UP", "B", "SIM"]
40
+
41
+ [tool.ruff.lint.flake8-bugbear]
42
+ extend-immutable-calls = ["typer.Argument", "typer.Option"]
43
+
44
+ [tool.pytest.ini_options]
45
+ testpaths = ["tests"]
46
+ addopts = "--cov=openstack_janitor --cov-report=term-missing --cov-fail-under=80"
@@ -0,0 +1,3 @@
1
+ """openstack-janitor: audit an OpenStack cloud for orphaned and wasteful resources."""
2
+
3
+ __version__ = "0.1.0"
@@ -0,0 +1,42 @@
1
+ """Shared timestamp-age helper.
2
+
3
+ Used by age-based detectors (old snapshots, shutoff instances, ...) and will
4
+ also back the future min-age safety rail that gates any destructive "clean"
5
+ action behind a minimum resource age.
6
+ """
7
+
8
+ from __future__ import annotations
9
+
10
+ from datetime import UTC, datetime
11
+
12
+
13
+ def age_in_days(timestamp: str | None, *, now: datetime | None = None) -> float | None:
14
+ """Return the age of an ISO 8601 ``timestamp`` in days, or ``None``.
15
+
16
+ ``timestamp`` is expected in the form openstacksdk returns resource
17
+ timestamps in, e.g. ``"2026-06-01T12:00:00Z"``, with or without
18
+ microseconds, or with a ``+00:00``-style offset. Naive timestamps (no
19
+ offset at all) are treated as UTC, since openstacksdk sometimes returns
20
+ naive UTC strings.
21
+
22
+ Returns ``None`` if ``timestamp`` is ``None`` or cannot be parsed. Never
23
+ raises.
24
+
25
+ :param timestamp: ISO 8601 timestamp string, or ``None``.
26
+ :param now: Reference time to compute age against. Defaults to the
27
+ current UTC time; injectable for tests.
28
+ """
29
+ if timestamp is None:
30
+ return None
31
+
32
+ try:
33
+ parsed = datetime.fromisoformat(timestamp.replace("Z", "+00:00"))
34
+ except ValueError:
35
+ return None
36
+
37
+ if parsed.tzinfo is None:
38
+ parsed = parsed.replace(tzinfo=UTC)
39
+
40
+ reference = now if now is not None else datetime.now(UTC)
41
+
42
+ return (reference - parsed).total_seconds() / 86400