A netbox plugin for managing multiple cluster types by site
<a href="https://github.com/sapcc/netbox-physical-clusters/forks"><img src="https://img.shields.io/github/forks/sapcc/netbox-physical-clusters" alt="Forks Badge"/></a>
<a href="https://github.com/sapcc/netbox-physical-clusters/pulls"><img src="https://img.shields.io/github/issues-pr/sapcc/netbox-physical-clusters" alt="Pull Requests Badge"/></a>
<a href="https://github.com/sapcc/netbox-physical-clusters/issues"><img src="https://img.shields.io/github/issues/sapcc/netbox-physical-clusters" alt="Issues Badge"/></a>
<a href="https://github.com/sapcc/netbox-physical-clusters/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sapcc/netbox-physical-clusters?color=2b9348"></a>
<a href="https://github.com/sapcc/netbox-physical-clusters/blob/master/LICENSE"><img src="https://img.shields.io/github/license/sapcc/netbox-physical-clusters?color=2b9348" alt="License Badge"/></a>
## Installing the Plugin in Netbox
### Prerequisites
- The plugin is compatible with Netbox 3.5.0 and higher.
- Databases supported: PostgreSQL
- Python supported : Python3 >= 3.10
### Install Guide
> NOTE: Plugins can be installed manually or using Python's `pip`. See the [netbox documentation](https://docs.netbox.dev/en/stable/plugins/) for more details. The pip package name for this plugin is [`netbox-physical-clusters`](https://pypi.org/project/netbox-physical-clusters/).
The plugin is available as a Python package via PyPI and can be installed with `pip`:
```shell
pip install netbox-physical-clusters
```
To ensure the device cluster plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Netbox root directory (alongside `requirements.txt`) and list the `netbox_physical_clusters` package:
```shell
echo netbox-physical-clusters >> local_requirements.txt
```
Once installed, the plugin needs to be enabled in your Netbox configuration. The following block of code below shows the additional configuration required to be added to your `$NETBOX_ROOT/netbox/configuration.py` file:
- Append `"netbox_physical_clusters"` to the `PLUGINS` list.
- Append the `"netbox_physical_clusters"` dictionary to the `PLUGINS_CONFIG` dictionary and override any defaults.
```python
PLUGINS = [
"netbox_physical_clusters",
]
```
## Post Install Steps
Once the Netbox configuration is updated, run the post install steps from the _Netbox Home_ to run migrations and clear any cache:
```shell
# Apply any database migrations
python3 netbox/manage.py migrate
# Trace any missing cable paths (not typically needed)
python3 netbox/manage.py trace_paths --no-input
# Collect static files
python3 netbox/manage.py collectstatic --no-input
# Delete any stale content types
python3 netbox/manage.py remove_stale_contenttypes --no-input
# Rebuild the search cache (lazily)
python3 netbox/manage.py reindex --lazy
# Delete any expired user sessions
python3 netbox/manage.py clearsessions
# Clear the cache
python3 netbox/manage.py clearcache
```
Then restart the Netbox services:
```shell
sudo systemctl restart netbox netbox-rq
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sapcc/netbox-physical-clusters",
"name": "netbox-physical-clusters",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "Netbox,netbox,plugin",
"author": "Pat McLean",
"author_email": "patrick.mclean@sap.com",
"download_url": "https://files.pythonhosted.org/packages/1a/c7/41041db3b8c7f143385c2797ec225c8db9d4abab7a6bbc47dda1873762dd/netbox_physical_clusters-0.2.2.tar.gz",
"platform": null,
"description": "\nA netbox plugin for managing multiple cluster types by site\n\n<a href=\"https://github.com/sapcc/netbox-physical-clusters/forks\"><img src=\"https://img.shields.io/github/forks/sapcc/netbox-physical-clusters\" alt=\"Forks Badge\"/></a>\n<a href=\"https://github.com/sapcc/netbox-physical-clusters/pulls\"><img src=\"https://img.shields.io/github/issues-pr/sapcc/netbox-physical-clusters\" alt=\"Pull Requests Badge\"/></a>\n<a href=\"https://github.com/sapcc/netbox-physical-clusters/issues\"><img src=\"https://img.shields.io/github/issues/sapcc/netbox-physical-clusters\" alt=\"Issues Badge\"/></a>\n<a href=\"https://github.com/sapcc/netbox-physical-clusters/graphs/contributors\"><img alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/sapcc/netbox-physical-clusters?color=2b9348\"></a>\n<a href=\"https://github.com/sapcc/netbox-physical-clusters/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/sapcc/netbox-physical-clusters?color=2b9348\" alt=\"License Badge\"/></a>\n\n## Installing the Plugin in Netbox\n\n### Prerequisites\n\n- The plugin is compatible with Netbox 3.5.0 and higher.\n- Databases supported: PostgreSQL\n- Python supported : Python3 >= 3.10\n\n### Install Guide\n\n> NOTE: Plugins can be installed manually or using Python's `pip`. See the [netbox documentation](https://docs.netbox.dev/en/stable/plugins/) for more details. The pip package name for this plugin is [`netbox-physical-clusters`](https://pypi.org/project/netbox-physical-clusters/).\n\nThe plugin is available as a Python package via PyPI and can be installed with `pip`:\n\n```shell\npip install netbox-physical-clusters\n```\n\nTo ensure the device cluster plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Netbox root directory (alongside `requirements.txt`) and list the `netbox_physical_clusters` package:\n\n```shell\necho netbox-physical-clusters >> local_requirements.txt\n```\n\nOnce installed, the plugin needs to be enabled in your Netbox configuration. The following block of code below shows the additional configuration required to be added to your `$NETBOX_ROOT/netbox/configuration.py` file:\n\n- Append `\"netbox_physical_clusters\"` to the `PLUGINS` list.\n- Append the `\"netbox_physical_clusters\"` dictionary to the `PLUGINS_CONFIG` dictionary and override any defaults.\n\n```python\nPLUGINS = [\n \"netbox_physical_clusters\",\n]\n```\n\n## Post Install Steps\n\nOnce the Netbox configuration is updated, run the post install steps from the _Netbox Home_ to run migrations and clear any cache:\n\n```shell\n# Apply any database migrations\npython3 netbox/manage.py migrate\n# Trace any missing cable paths (not typically needed)\npython3 netbox/manage.py trace_paths --no-input\n# Collect static files\npython3 netbox/manage.py collectstatic --no-input\n# Delete any stale content types\npython3 netbox/manage.py remove_stale_contenttypes --no-input\n# Rebuild the search cache (lazily)\npython3 netbox/manage.py reindex --lazy\n# Delete any expired user sessions\npython3 netbox/manage.py clearsessions\n# Clear the cache\npython3 netbox/manage.py clearcache\n```\n\nThen restart the Netbox services:\n\n```shell\nsudo systemctl restart netbox netbox-rq\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A netbox plugin for managing multiple physical cluster types",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://sapcc.github.io/netbox-physical-clusters",
"Homepage": "https://github.com/sapcc/netbox-physical-clusters"
},
"split_keywords": [
"netbox",
"netbox",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee219a5950655118b967f3228a64207daf3b72eda9c64be72e86a23b008eed7a",
"md5": "962bcff2155d6f793814f4c78def1219",
"sha256": "9bae55db0e6e4d12d47a9513ba4e34a308e1cf437788c077519c21c0c4759fb3"
},
"downloads": -1,
"filename": "netbox_physical_clusters-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "962bcff2155d6f793814f4c78def1219",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 34357,
"upload_time": "2023-11-02T10:34:28",
"upload_time_iso_8601": "2023-11-02T10:34:28.086045Z",
"url": "https://files.pythonhosted.org/packages/ee/21/9a5950655118b967f3228a64207daf3b72eda9c64be72e86a23b008eed7a/netbox_physical_clusters-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ac741041db3b8c7f143385c2797ec225c8db9d4abab7a6bbc47dda1873762dd",
"md5": "1247b8e5766c524754058a29f392e446",
"sha256": "dbcd1b0ba876274bf89606a2954132f79302e927c6934e5d0e4330a5d013da48"
},
"downloads": -1,
"filename": "netbox_physical_clusters-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "1247b8e5766c524754058a29f392e446",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 22858,
"upload_time": "2023-11-02T10:34:29",
"upload_time_iso_8601": "2023-11-02T10:34:29.202279Z",
"url": "https://files.pythonhosted.org/packages/1a/c7/41041db3b8c7f143385c2797ec225c8db9d4abab7a6bbc47dda1873762dd/netbox_physical_clusters-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-02 10:34:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sapcc",
"github_project": "netbox-physical-clusters",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-physical-clusters"
}
JSON
