feat: aufräumaktion

2026-07-24 15:22:59 +02:00
parent 01d40ddecc
commit e1c817229b
7 changed files with 0 additions and 426 deletions
@@ -1,25 +0,0 @@
 ---
 name: Markdown lint
 on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened]
 permissions: {}
 jobs:
  vale:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
      - uses: errata-ai/vale-action@85f9f7f2c5f449ac0ae5b66662961bae3f77ca6a # v2.1.2
        with:
          fail_on_error: true
          filter_mode: nofilter
          vale_flags: "--glob=*.md --config=ci/.vale.ini"
@@ -1,40 +0,0 @@
 ---
 name: Python
 on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened]
 permissions: {}
 jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - python-version: 3.11
          - python-version: 3.12
          - python-version: 3.13
          - python-version: 3.14
    steps:
    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      with:
        persist-credentials: false
    - name: Set up Python
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install ci tools
      run: pip install .[ci]
    - name: Run ruff lint
      run: ruff check netbox_slm
    - name: Run ruff format
      run: ruff format --check netbox_slm
@@ -1,25 +0,0 @@
 ---
 name: GitHub Actions Security Analysis with zizmor
 on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened]
 permissions: {}
 jobs:
  zizmor:
    runs-on: ubuntu-latest
    permissions:
      security-events: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
      - name: Run zizmor
        uses: zizmorcore/zizmor-action@5f14fd08f7cf1cb1609c1e344975f152c7ee938d # v0.5.6
@@ -1,133 +0,0 @@
 # Contributor Covenant Code of Conduct
 ## Our Pledge
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
 nationality, personal appearance, race, caste, color, religion, or sexual
 identity and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 ## Our Standards
 Examples of behavior that contributes to a positive environment for our
 community include:
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
 * Focusing on what is best not just for us as individuals, but for the overall
  community
 Examples of unacceptable behavior include:
 * The use of sexualized language or imagery, and sexual attention or advances of
  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or email address,
  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
  professional setting
 ## Enforcement Responsibilities
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
 response to any behavior that they deem inappropriate, threatening, offensive,
 or harmful.
 Community leaders have the right and responsibility to remove, edit, or reject
 comments, commits, code, wiki edits, issues, and other contributions that are
 not aligned to this Code of Conduct, and will communicate reasons for moderation
 decisions when appropriate.
 ## Scope
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
 Examples of representing our community include using an official e-mail address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 ## Enforcement
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement by
 [opening a new issue in this repository's issue tracker][open issue].
 All complaints will be reviewed and investigated promptly and fairly.
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 ## Enforcement Guidelines
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
 ### 1. Correction
 **Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
 **Consequence**: A private, written warning from community leaders, providing
 clarity around the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 ### 2. Warning
 **Community Impact**: A violation through a single incident or series of
 actions.
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
 like social media. Violating these terms may lead to a temporary or permanent
 ban.
 ### 3. Temporary Ban
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
 **Consequence**: A temporary ban from any sort of interaction or public
 communication with the community for a specified period of time. No public or
 private interaction with the people involved, including unsolicited interaction
 with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 **Consequence**: A permanent ban from any sort of public interaction within the
 community.
 ## Attribution
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.1, available at
 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 Community Impact Guidelines were inspired by
 [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 For answers to common questions about this code of conduct, see the FAQ at
 [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
 [https://www.contributor-covenant.org/translations][translations].
 [homepage]: https://www.contributor-covenant.org
 [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
 [open issue]: https://github.com/ICTU/netbox_slm/issues/new
@@ -1,34 +0,0 @@
 # NetBox SLM contributing guidelines
 ## What do I need to know to help?
 If you are looking to help to with a code contribution our project uses, you can find inspiration in the [issue list](https://github.com/ICTU/netbox_slm/issues/).
 Additionally, review the [README](./README.md) document and [NetBox Plugin Development](https://docs.netbox.dev/en/stable/plugins/development/) docs.
 ## How do I make a contribution?
 Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
 1. Find an issue that you are interested in addressing or a feature that you would like to add.
 2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under **your-GitHub-username/repository-name**.
 3. Clone the repository to your local machine using `git clone https://github.com/github-username/repository-name.git`.
 4. Create a new branch for your fix using `git checkout -b branch-name-here`.
 5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
 6. Use git `add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
 7. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
 8. Push the changes to the remote repository using `git push origin branch-name-here`.
 9. Submit a pull request to the upstream repository.
 10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
 11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
 12. Wait for the pull request to be reviewed by a maintainer.
 13. Make changes to the pull request if the reviewing maintainer recommends them.
 14. Celebrate your success after your pull request is merged!
 ## Where can I go for help?
 If you need help, you can ask questions by [opening a new issue in this repository's issue tracker](https://github.com/ICTU/netbox_slm/issues/new).
 ## What does the Code of Conduct mean for me?
 Our [Code of Conduct](./CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity.
 If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.
@@ -1,153 +0,0 @@
 # Maintenance related tasks
 ## Version upgrade workflow
 1. Update version spec in `netbox_slm/__init__.py` and `sonar-project.properties`
 1. Update NetBox base image versions in `ci/Dockerfile`, `ci/Dockerfile-CI` and `ci/docker-compose.yml`
 1. Ensure that the `PYTHON_VERSION` in the `Dockerfile`s is the same as the NetBox community docker base image
 1. Check for any runtime errors and warnings in the `netbox-*` container logs
 1. Create new version tag on GitHub, following semantic versioning as: `MAJOR.MINOR.PATCH`
 1. Update the `CHANGELOG.md` with new version information and move `[Unreleased]` items to new version section
 1. Build the package: `python -m build`
 1. Upload the distributions to PyPI: `twine upload --skip-existing dist/*`
 ## Developer Guide (local installation)
 *Follow the steps below on your local system to run NetBox and the
 `netbox_slm` plugin in developer mode*
 ### Setup
 The goal below is to run all NetBox components in Docker and run a local
 NetBox Django copy with auto-reload to develop the plugin pointing to
 the PostgreSQL and Redis container instances, basically ignoring the
 NetBox docker runtime server.
 ### Steps
 from your projects directory clone the NetBox repository
 ```shell
 $ git clone https://github.com/netbox-community/netbox
 $ cd netbox
 ```
 install the virtual environment
 ```shell
 $ pipenv shell
 $ pipenv install
 ```
 create and edit `netbox/configuration.py` (based on the template file) add these lines at the end of the file;
 ```python
 DEBUG = True
 SECRET_KEY = 'dummy'
 PLUGINS = [
 'netbox_slm',
 ]
 ```
 The NetBox installation above will be used to run Django management
 commands like `runserver`, `makemigrations` and `migrate`, which will be
 explained in the next steps below;
 from your projects directory clone the `netbox_slm` repository
 ```shell
 $ git clone https://github.com/ICTU/netbox_slm
 $ cd netbox_slm
 $ ./start-netbox.sh
 ```
 This will start NetBox locally (requires Docker) and forward the Redis
 and PostgreSQL ports to the localhost (make sure there’s no processes
 using these ports or change the Dockerfile(s) accordingly)
 Note, you can also start and stop NetBox by hand:
 ```shell
 $ cd netbox-docker
 $ docker compose up -d
 ```
 or stop the stack with
 ```shell
 $ docker compose down
 ```
 #### to start fresh:
 ```shell
 $ docker compose down
 $ docker volume rm netbox-docker_netbox-postgres-data  # et cetera
 $ docker compose up -d --force-recreate
 ```
 this will require you to re-run the migrate commando's for `netbox_slm`, see further down below
 Go back to the NetBox `configuration.py` file and update the PostgreSQL and
 Redis connection strings (username, password) to the ones the NetBox
 Docker backend is using, for example (using default user and passwords
 from the NetBox Docker example):
 ```python
 # PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
 #   https://docs.djangoproject.com/en/stable/ref/settings/#databases
 DATABASE = {
   'NAME': 'netbox',               # Database name
   'USER': 'netbox',               # PostgreSQL username
   'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
   'HOST': 'localhost',            # Database server
   'PORT': '',                     # Database port (leave blank for default)
   'CONN_MAX_AGE': 300,            # Max database connection age
 }
 # Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate
 # configuration exists for each. Full connection details are required in both sections, and it is strongly recommended
 # to use two separate database IDs.
 REDIS = {
   'tasks': {
       'HOST': 'localhost',
       'PORT': 6379,
       # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel
       # 'SENTINELS': [('mysentinel.redis.example.com', 6379)],
       # 'SENTINEL_SERVICE': 'netbox',
       'PASSWORD': 'H733Kdjndks81',
       'DATABASE': 0,
       'SSL': False,
       # Set this to True to skip TLS certificate verification
       # This can expose the connection to attacks, be careful
       # 'INSECURE_SKIP_TLS_VERIFY': False,
   },
   'caching': {
       'HOST': 'localhost',
       'PORT': 6379,
       # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel
       # 'SENTINELS': [('mysentinel.redis.example.com', 6379)],
       # 'SENTINEL_SERVICE': 'netbox',
       'PASSWORD': 'H733Kdjndks81',
       'DATABASE': 1,
       'SSL': False,
       # Set this to True to skip TLS certificate verification
       # This can expose the connection to attacks, be careful
       # 'INSECURE_SKIP_TLS_VERIFY': False,
   }
 }
 ```
 Now you can run commands from the NetBox repository like this;
 ```shell
 $ cd netbox/netbox
 $ export PYTHONPATH=../../netbox_slm/netbox_slm/  # or with the pipenv activated run `python3 setup.py develop` from the netbox_slm directory
 $ python3 manage.py migrate netbox_slm
 $ python3 manage.py runserver 8001
 ```
 Visit http://127.0.0.1:8001 in the browser to see the auto reloading version of the NetBox UI.
 Port 8000 is taken by the Docker ran variant.
@@ -1,16 +0,0 @@
 # NetBox SLM Security Policy
 ## Current status
 NetBox SLM is a plugin for [NetBox](https://github.com/netbox-community/netbox/) with mostly default configuration.
 In order to stay up to date, monitor NetBox security findings and update accordingly.
 ## Supported Versions
 Only the latest version of NetBox SLM is currently being supported with security updates.
 The intention is to keep the plugin compatible with the most recent NetBox version(s), there is no incentive to patch older tags.
 ## Reporting a Vulnerability
 You can privately [report a vulnerability issue in this repository's issue tracker](https://github.com/ICTU/netbox_slm/security/advisories/new).
 The aim is to get back to you within 24 hours, with a confirmation of the issue and a brief action plan or a request for more information.