| Name | cmk-dev-site JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Easily Install Checkmk |
| upload_time | 2025-08-26 15:38:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | None |
| keywords |
checkmk
cmk
monitoring
site
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cmk-dev-site
_Easy Install Checkmk_
Scripts to install bleeding edge Checkmk in development context.
**If you are a regular Checkmk customer you probably don't want to use this,
as this tools remove sites without warning.**
## Installation
```
sudo apt install pipx
pipx ensurepath
# check output of this command. you might have to open a fresh terminal!
pipx install cmk-dev-site
```
For updating you can use:
```
pipx upgrade cmk-dev-site
```
## Usage
```
cmk-dev-install-site 2.5 # download package, install, create site for 2.5
# Download and install latest available daily build of 2.5.0
cmk-dev-install 2.5 && cmk-dev-site
# (will fall back to the daily builds of yesterday)
# Download daily build of today and
# setup distributed monitoring with one two sites:
cmk-dev-install 2.5.0-daily && cmk-dev-site -d 1
# Download and install raw edition package
cmk-dev-install --edition=cre 2.5.0-daily
```
### `cmk-dev-install-site`
Is a shortcut for the more verbose `cmk-dev-install` and `cmk-dev-site`
commands. This way you lose some of the possibilities, but only have to
remember one command. Also prints out the commands that it will execute, so you
can c&p it.
### `cmk-dev-install`
Will download the requested package of Checkmk and install said package.
You might request a daily build (`cmk-dev-install 2.5.0-daily`),
the latest available daily build (handy if there are no daily builds of today) (`cmk-dev-install 2.5`),
or an officially release Checkmk version (`cmk-dev-install 2.4.0p9`).
Please check the built in help (`cmk-dev-install --help`) for all options!
### `cmk-dev-site`
Will create a site, install the checkmk agent, and add a single host to the site.
`cmk-dev-site` uses [omd
commands](https://docs.checkmk.com/latest/en/omd_basics.html) and the official
[REST-API](https://docs.checkmk.com/latest/en/rest_api.html) to create one or
multiple sites based on the current default omd version (or the version
specified on the command line).
You might use `-d 1` to create a distributed monitoring with one distributed site.
Please check the built in help (`cmk-dev-site --help`) for all options!
### Cleanup
Currently there is no public available tool to completely cleanup sites and
packages create with the presented tools. If you are a Checkmk developer you
might make use of the internal tool `omd-hauweg`, otherwise you have to
manually remove the sites using `omd rm`.
For uninstall packages that are no longer in use you can use `omd cleanup`,
or you might fall back to use `apt purge`.
## Contributing
If you'd like to make contributions to the tool, check out our
[development documentation](https://github.com/Checkmk/cmk-dev-site/blob/main/DEVELOPMENT.md).
Here you'll see steps on how to setup your environment for local development.
Raw data
{
"_id": null,
"home_page": null,
"name": "cmk-dev-site",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "checkmk, cmk, monitoring, site",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/58/ba/8310acca2b6ceaa57ff53923506c901cf18ea6494d2bedbede2a4c3d864e/cmk_dev_site-1.2.0.tar.gz",
"platform": null,
"description": "# cmk-dev-site\n\n_Easy Install Checkmk_\n\nScripts to install bleeding edge Checkmk in development context.\n\n**If you are a regular Checkmk customer you probably don't want to use this,\nas this tools remove sites without warning.**\n\n## Installation\n\n```\nsudo apt install pipx\npipx ensurepath\n# check output of this command. you might have to open a fresh terminal!\npipx install cmk-dev-site\n```\n\nFor updating you can use:\n```\npipx upgrade cmk-dev-site\n```\n\n## Usage\n\n```\ncmk-dev-install-site 2.5 # download package, install, create site for 2.5\n\n# Download and install latest available daily build of 2.5.0\ncmk-dev-install 2.5 && cmk-dev-site\n# (will fall back to the daily builds of yesterday)\n\n# Download daily build of today and\n# setup distributed monitoring with one two sites:\ncmk-dev-install 2.5.0-daily && cmk-dev-site -d 1\n\n# Download and install raw edition package\ncmk-dev-install --edition=cre 2.5.0-daily\n```\n### `cmk-dev-install-site`\n\nIs a shortcut for the more verbose `cmk-dev-install` and `cmk-dev-site`\ncommands. This way you lose some of the possibilities, but only have to\nremember one command. Also prints out the commands that it will execute, so you\ncan c&p it.\n\n### `cmk-dev-install`\n\nWill download the requested package of Checkmk and install said package.\n\nYou might request a daily build (`cmk-dev-install 2.5.0-daily`),\nthe latest available daily build (handy if there are no daily builds of today) (`cmk-dev-install 2.5`),\nor an officially release Checkmk version (`cmk-dev-install 2.4.0p9`).\n\nPlease check the built in help (`cmk-dev-install --help`) for all options!\n\n### `cmk-dev-site`\n\nWill create a site, install the checkmk agent, and add a single host to the site.\n\n`cmk-dev-site` uses [omd\ncommands](https://docs.checkmk.com/latest/en/omd_basics.html) and the official\n[REST-API](https://docs.checkmk.com/latest/en/rest_api.html) to create one or\nmultiple sites based on the current default omd version (or the version\nspecified on the command line).\n\nYou might use `-d 1` to create a distributed monitoring with one distributed site.\n\nPlease check the built in help (`cmk-dev-site --help`) for all options!\n\n### Cleanup\n\nCurrently there is no public available tool to completely cleanup sites and\npackages create with the presented tools. If you are a Checkmk developer you\nmight make use of the internal tool `omd-hauweg`, otherwise you have to\nmanually remove the sites using `omd rm`.\nFor uninstall packages that are no longer in use you can use `omd cleanup`,\nor you might fall back to use `apt purge`.\n\n## Contributing\n\nIf you'd like to make contributions to the tool, check out our\n[development documentation](https://github.com/Checkmk/cmk-dev-site/blob/main/DEVELOPMENT.md).\nHere you'll see steps on how to setup your environment for local development.\n",
"bugtrack_url": null,
"license": null,
"summary": "Easily Install Checkmk",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/Checkmk/cmk-dev-site/blob/release/1.2.0/changelog.md",
"Repository": "https://github.com/Checkmk/cmk-dev-site"
},
"split_keywords": [
"checkmk",
" cmk",
" monitoring",
" site"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3d2d0ca4063f74f5cefefc9b083fdc22608d9ddd0eec0068fc27fb07f9a9b161",
"md5": "8f37fd2b7aa53e0e49930be24bf44167",
"sha256": "671044267ed38f35bffe81233f8327f941619d535a33ed7a6e838990ab91ae23"
},
"downloads": -1,
"filename": "cmk_dev_site-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f37fd2b7aa53e0e49930be24bf44167",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 39520,
"upload_time": "2025-08-26T15:38:07",
"upload_time_iso_8601": "2025-08-26T15:38:07.487800Z",
"url": "https://files.pythonhosted.org/packages/3d/2d/0ca4063f74f5cefefc9b083fdc22608d9ddd0eec0068fc27fb07f9a9b161/cmk_dev_site-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "58ba8310acca2b6ceaa57ff53923506c901cf18ea6494d2bedbede2a4c3d864e",
"md5": "79ba77d714a11dd61cb95f06abf73344",
"sha256": "911e9eca690d74a4e39cdd3d61197cc64f7c8c7e12a9d9a36c8afc7a7053a520"
},
"downloads": -1,
"filename": "cmk_dev_site-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "79ba77d714a11dd61cb95f06abf73344",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 102868,
"upload_time": "2025-08-26T15:38:19",
"upload_time_iso_8601": "2025-08-26T15:38:19.351487Z",
"url": "https://files.pythonhosted.org/packages/58/ba/8310acca2b6ceaa57ff53923506c901cf18ea6494d2bedbede2a4c3d864e/cmk_dev_site-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 15:38:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Checkmk",
"github_project": "cmk-dev-site",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cmk-dev-site"
}
