| Name | cmk-dev-site JSON |
| Version |
1.6.2
JSON |
| download |
| home_page | None |
| Summary | Easily Install Checkmk |
| upload_time | 2025-10-30 07:48:18 |
| 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/b1/2b/338e0720ffdee332dde5ab5aa1e7d93a84cedd1437157851224a00babd91/cmk_dev_site-1.6.2.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.6.2",
"project_urls": {
"Changelog": "https://github.com/Checkmk/cmk-dev-site/blob/release/1.6.2/changelog.md",
"Repository": "https://github.com/Checkmk/cmk-dev-site"
},
"split_keywords": [
"checkmk",
" cmk",
" monitoring",
" site"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ce1afda0717084b78991412542b31778944a9696cf778d051b8cd2583b14c58a",
"md5": "fe0867c1d6c443d1aed1ea902526bb1d",
"sha256": "904bf38c3dc5bb13238209cd9678c6d1599749fbde912d043435fd04f64330b0"
},
"downloads": -1,
"filename": "cmk_dev_site-1.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe0867c1d6c443d1aed1ea902526bb1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 40310,
"upload_time": "2025-10-30T07:48:17",
"upload_time_iso_8601": "2025-10-30T07:48:17.008068Z",
"url": "https://files.pythonhosted.org/packages/ce/1a/fda0717084b78991412542b31778944a9696cf778d051b8cd2583b14c58a/cmk_dev_site-1.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b12b338e0720ffdee332dde5ab5aa1e7d93a84cedd1437157851224a00babd91",
"md5": "e70883ac12fded04a95b69d4b0979fa7",
"sha256": "6caa51975484840af3490838c64f38e6de006f10b9a2c647e1652a414d2b69e0"
},
"downloads": -1,
"filename": "cmk_dev_site-1.6.2.tar.gz",
"has_sig": false,
"md5_digest": "e70883ac12fded04a95b69d4b0979fa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 105932,
"upload_time": "2025-10-30T07:48:18",
"upload_time_iso_8601": "2025-10-30T07:48:18.467038Z",
"url": "https://files.pythonhosted.org/packages/b1/2b/338e0720ffdee332dde5ab5aa1e7d93a84cedd1437157851224a00babd91/cmk_dev_site-1.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-30 07:48:18",
"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"
}
