Skip to content

Commit aa62ac5

Browse files
markuslfmarkuslf
committed
chore: initial project skeleton
0 parents  commit aa62ac5

12 files changed

Lines changed: 652 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
### Python template
2+
# Byte-compiled / optimized / DLL files
3+
__pycache__/
4+
*.py[cod]
5+
*$py.class
6+
7+
# C extensions
8+
*.so
9+
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
share/python-wheels/
25+
**/*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# Installer logs
31+
pip-log.txt
32+
pip-delete-this-directory.txt
33+
34+
# Unit test / coverage reports
35+
htmlcov/
36+
.tox/
37+
.nox/
38+
.coverage
39+
.coverage.*
40+
.cache
41+
nosetests.xml
42+
coverage.xml
43+
*.cover
44+
*.py,cover
45+
.hypothesis/
46+
.pytest_cache/
47+
cover/
48+
49+
# Sphinx / mkdocs / pdoc documentation builds
50+
docs/_build/
51+
docs/source-code/
52+
/site
53+
54+
# Environments
55+
.env
56+
.venv
57+
env/
58+
venv/
59+
ENV/
60+
env.bak/
61+
venv.bak/
62+
63+
# IDE / editor caches
64+
.spyderproject
65+
.spyproject
66+
.ropeproject
67+
.idea/
68+
.vscode/
69+
70+
# Type checker caches
71+
.mypy_cache/
72+
.dmypy.json
73+
dmypy.json
74+
.pyre/
75+
.pytype/
76+
77+
# Linter caches
78+
.ruff_cache/
79+
80+
# Cython debug symbols
81+
cython_debug/
82+
83+
# Linuxfabrik / Claude Code per-project notes (kept out of the repo by convention)
84+
CLAUDE.md
85+
.claude/

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
9+
## [Unreleased]
10+
11+
### Added
12+
13+
* Initial project skeleton with `pyproject.toml`, `README.md`, `CHANGELOG.md`, `LICENSE` (Unlicense), `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md` and `SECURITY.md`.

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
https://www.linuxfabrik.ch/en/about-us/contact/.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Contributing
2+
3+
4+
## Linuxfabrik Standards
5+
6+
The following standards apply to all Linuxfabrik repositories.
7+
8+
9+
### Code of Conduct
10+
11+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
12+
13+
14+
### Issue Tracking
15+
16+
Open issues are tracked on GitHub Issues in the respective repository.
17+
18+
19+
### Pre-commit
20+
21+
Some repositories use [pre-commit](https://pre-commit.com/) for automated linting and formatting checks. If the repository contains a `.pre-commit-config.yaml`, install [pre-commit](https://pre-commit.com/#install) and configure the hooks after cloning:
22+
23+
```bash
24+
pre-commit install
25+
```
26+
27+
28+
### Commit Messages
29+
30+
Commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification:
31+
32+
```
33+
<type>(<scope>): <subject>
34+
```
35+
36+
If there is a related issue, append `(fix #N)`:
37+
38+
```
39+
<type>(<scope>): <subject> (fix #N)
40+
```
41+
42+
`<type>` must be one of:
43+
44+
- `chore`: Changes to the build process or auxiliary tools and libraries
45+
- `docs`: Documentation only changes
46+
- `feat`: A new feature
47+
- `fix`: A bug fix
48+
- `perf`: A code change that improves performance
49+
- `refactor`: A code change that neither fixes a bug nor adds a feature
50+
- `style`: Changes that do not affect the meaning of the code (whitespace, formatting, etc.)
51+
- `test`: Adding missing tests
52+
53+
54+
### Changelog
55+
56+
Document all changes in `CHANGELOG.md` following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Sort entries within sections alphabetically.
57+
58+
59+
### Language
60+
61+
Code, comments, commit messages, and documentation must be written in English.
62+
63+
64+
### CI Supply Chain
65+
66+
GitHub Actions in `.github/workflows/` are pinned by commit SHA, not by tag. Dependabot's `github-actions` ecosystem keeps these pins up to date.
67+
68+
Python packages installed via `pip` inside workflows follow a two-tier policy:
69+
70+
- `pre-commit` is installed from a hash-pinned requirements file at `.github/pre-commit/requirements.txt`, generated with `pip-compile --generate-hashes --strip-extras` from `.github/pre-commit/requirements.in`. Dependabot's `pip` ecosystem watches that directory and maintains both files.
71+
- One-shot installs such as `ansible-builder`, `build`, `mkdocs`, `pdoc`, and `ruff` in release, docs, or test workflows are version-pinned only (`package==X.Y.Z`) and kept fresh by Dependabot. Scorecard's `pipCommand not pinned by hash` findings for these are considered acceptable risk and may be dismissed.
72+
73+
74+
### Coding Conventions
75+
76+
- Sort variables, parameters, lists, and similar items alphabetically where possible.
77+
- Always use long parameters when using shell commands.
78+
- Use RFC [5737](https://datatracker.ietf.org/doc/html/rfc5737), [3849](https://datatracker.ietf.org/doc/html/rfc3849), [7042](https://datatracker.ietf.org/doc/html/rfc7042#section-2.1.1), and [2606](https://datatracker.ietf.org/doc/html/rfc2606) in examples and documentation:
79+
- IPv4: `192.0.2.0/24`, `198.51.100.0/24`, `203.0.113.0/24`
80+
- IPv6: `2001:DB8::/32`
81+
- MAC: `00-00-5E-00-53-00` through `00-00-5E-00-53-FF` (unicast), `01-00-5E-90-10-00` through `01-00-5E-90-10-FF` (multicast)
82+
- Domains: `*.example`, `example.com`
83+
84+
85+
---
86+
87+
88+
## mcp-server-icinga Guidelines
89+
90+
91+
### Project Status
92+
93+
This project is in early development. Code layout, configuration surface and tool inventory are expected to change. Until the first release is cut, breaking changes may land on `main` without deprecation notice. Pin to a commit SHA if you depend on it during this phase.
94+
95+
96+
### Commit Scopes
97+
98+
Common scopes for this project:
99+
100+
- `feat(core):` -- Icinga 2 Core REST client / tools
101+
- `feat(web):` -- Icinga Web / Icinga DB Web REST client / tools
102+
- `feat(director):` -- Icinga Director REST client / tools
103+
- `feat(plugins):` -- Linuxfabrik monitoring-plugins catalog (parsing, lookup)
104+
- `feat(tsdb):` -- time series database integration (default: InfluxDB)
105+
- `feat(server):` -- MCP server entrypoint, transport, tool registration
106+
- `feat(config):` -- environment / configuration handling
107+
- `chore:` -- maintenance (dependencies, CI, formatting)
108+
- `docs:` -- documentation changes
109+
- `fix(<scope>):` -- bug fix in the named scope
110+
- `refactor:` -- code restructuring without behaviour change
111+
- `test:` -- test additions or fixture changes
112+
113+
114+
### Developer Guide
115+
116+
Detailed developer documentation will live in [`docs/developer-guide/`](docs/developer-guide/) once the implementation reaches that stage.

‎COPYRIGHT‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
This project is released into the public domain under the Unlicense.
2+
See the LICENSE file or <https://unlicense.org/> for the full text.
3+
4+
Project: mcp-server-icinga
5+
Authors: Linuxfabrik GmbH, Zurich, Switzerland <info@linuxfabrik.ch>
6+
https://www.linuxfabrik.ch/
7+
8+
SPDX-License-Identifier: Unlicense

‎LICENSE‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <https://unlicense.org>

0 commit comments

Comments
 (0)