{
    "info": {
        "author": "Nicolas Bigler",
        "author_email": "nicolas.bigler@vshn.ch",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: BSD License",
            "Operating System :: Unix",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: System :: Systems Administration"
        ],
        "description": "###############\nrepository_sync\n###############\n\n.. contents:: Table of Contents\n\n\n********\nOverview\n********\n\n`appuio_routes_monitoring` is a tool to generate yaml code for hieradata from APPUiO\nroutes to configure http icinga2 monitoring checks for those routes.\nHowever the script should work on any openshift cluster.\n\nappuio_routes_monitoring\n========================\n\n`appuio_routes_monitoring` expects the `oc` to be in the path variable and you need to be\nlogged in to APPUiO before calling this script.\n\nBy default the script will generate yaml code for all routes the logged in user has access to.\n\nSee usage section of this document for details.\n\n\n************\nDependencies\n************\n\n`appuio_routes_monitoring` supports python >=3.4 and has the following 3rd-party dependencies\n - `pyyaml <https://pypi.python.org/pypi/pyyaml>`_ (>= 3.10)\n\n`appuio_routes_monitoring` further relies on the `oc` binary to extract the routes from the\nopenshift cluster.\n\n\n************\nInstallation\n************\n\n`appuio_routes_monitoring` can be easily installed using pip:\n`pip install appuio_routes_monitoring`\n\n*************\nConfiguration\n*************\n\n`appuio_routes_monitoring` does not have any configuration files.\nBut it does rely on the `oc` binary and valid session to APPUiO.\nFurthermore the script reads annotations from the routes to generate the appropriate\nyaml code.\nCurrently the following annotations are supported:\n\nmonitoring/alert_customer\n=========================\n\nSetting this annotation on the route to `true`, will set the `alert_customer` variable to\n`true` as well. This will configure the http check to alert to the defined e-mail address.\n\nmonitoring/alert_vshn: 'true'\n=============================\n\nSetting this annotation on the route to `true`, will set the `production_level` of the check\nto `4`, making the check a 24/7 check. This means VSHN will be alerted anytime the check fails.\n\nmonitoring/path\n===============\nSetting this annotation on the route to a URI, will set the http_uri to the specified path.\nIf the annoation is missing, the http_uri will default to `/`.\n\n\n*****\nUsage\n*****\n\n.. code-block:: text\n\n    usage: generate_monitoring_check [-h] [-p PROJECTS [PROJECTS ...]] [-k HIERAKEY]\n\n    generate hieradata from appuio routes\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      -p PROJECTS [PROJECTS ...], --project PROJECTS [PROJECTS ...]\n      -k HIERAKEY, --key HIERAKEY\n\n\n\nExamples\n========\n\nGenerate yaml code for project `my-test-project`\n\n.. code-block:: text\n\n    generate_monitoring_check -p my-test-project\n    profile_icinga2::hiera_httpchecks:\n        test-project.example.com:\n            display_name: test-project.example.com on APPUiO in my-test-project\n            http_address: test-project.example.com\n            http_ssl: true\n            http_uri: /\n            vars:\n                alert_customer: false\n\n\n***********\nDevelopment\n***********\n\nrun development version\n=======================\n\n.. code-block:: bash\n\n    git clone git@git.vshn.net:vshn/appuio_routes_monitoring.git\n    cd appuio_routes_monitoring\n    python -m venv pyvenv\n    . pyvenv/bin/activate\n    pip install -r requirements.txt\n\n    python -m appuio_routes_monitoring\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://git.vshn.net/vshn/appuio_routes_monitoring",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "appuio-routes-monitoring",
        "package_url": "https://pypi.org/project/appuio-routes-monitoring/",
        "platform": "any",
        "project_url": "https://pypi.org/project/appuio-routes-monitoring/",
        "project_urls": {
            "Homepage": "https://git.vshn.net/vshn/appuio_routes_monitoring"
        },
        "release_url": "https://pypi.org/project/appuio-routes-monitoring/1.1.1/",
        "requires_dist": [
            "pyyaml"
        ],
        "requires_python": ">=3.5",
        "summary": "Pre-Backup script that synchronises git and mercurial repositories",
        "version": "1.1.1"
    },
    "last_serial": 4791258,
    "releases": {
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "828465ac2ab86036c085aca63423454d",
                    "sha256": "d7f79056f583b1a7f0b1b8af488a47af6c16cd17ae002ede3811b5fe1698b59b"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "828465ac2ab86036c085aca63423454d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 5870,
                "upload_time": "2019-01-21T14:46:13",
                "url": "https://files.pythonhosted.org/packages/7c/30/7d95d1219aeb6bc38cf710e4074d0806042e99f98962e1aee37f9f2ad5b0/appuio_routes_monitoring-1.0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "28112ec313e84d8efdd0844537289a4f",
                    "sha256": "b6415be3337d9870e5edad4cd5800ff32ca96e7e1f323cf9f17a06245b6c3fc4"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "28112ec313e84d8efdd0844537289a4f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 4175,
                "upload_time": "2019-01-21T14:46:14",
                "url": "https://files.pythonhosted.org/packages/e1/ff/8ef4f01098b74a540714d106084e3f8eb6684a0787161b8ee7c97ce84eb3/appuio_routes_monitoring-1.0.3.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e38f9b515f212c6671c602a0626e3103",
                    "sha256": "b279e627ac2ec4afce543ea03f23a3980fc62b5acd0304e44796caa8afc4e08c"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e38f9b515f212c6671c602a0626e3103",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 6002,
                "upload_time": "2019-01-25T14:11:24",
                "url": "https://files.pythonhosted.org/packages/d0/ec/25c25f678ee52af7a08f1ba4f2141080cf2eeb00d5c57712db743e996259/appuio_routes_monitoring-1.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1bba16696ef8a59b104d989c8418fdd3",
                    "sha256": "ab217227f7a6780242a3038b0019899a3dd7a4f64fdd26e62ffb8ab1d3ee05b4"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1bba16696ef8a59b104d989c8418fdd3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 4337,
                "upload_time": "2019-01-25T14:11:25",
                "url": "https://files.pythonhosted.org/packages/b9/34/0df1c581d53a80d3d4773e1acc880e3c4e76e46ef42292b54dee57707723/appuio_routes_monitoring-1.1.0.tar.gz"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3663d2a8c6839bd8c8c09ba76dc52d3f",
                    "sha256": "9fa26c85793908279292daaf9803fe21cc5baeed032d3e8ce6270dcc0c1b8760"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3663d2a8c6839bd8c8c09ba76dc52d3f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 5995,
                "upload_time": "2019-02-07T14:32:22",
                "url": "https://files.pythonhosted.org/packages/14/e6/7f6ce2c4da684a3b7f3bfcfe8970eae4d29782013157016c1410613d7407/appuio_routes_monitoring-1.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8166a45a4ee9cc2db152bd80e7a8da2c",
                    "sha256": "8cf9d85c66967262ae9b306f767df2d6c2b067f8cc580371da4e1e937df50939"
                },
                "downloads": -1,
                "filename": "appuio_routes_monitoring-1.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "8166a45a4ee9cc2db152bd80e7a8da2c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 4331,
                "upload_time": "2019-02-07T14:32:23",
                "url": "https://files.pythonhosted.org/packages/f5/6b/32d1bc969f0093d6e52ceaf97e6bf329c004c1b4fa2afb866d6356162eb8/appuio_routes_monitoring-1.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3663d2a8c6839bd8c8c09ba76dc52d3f",
                "sha256": "9fa26c85793908279292daaf9803fe21cc5baeed032d3e8ce6270dcc0c1b8760"
            },
            "downloads": -1,
            "filename": "appuio_routes_monitoring-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3663d2a8c6839bd8c8c09ba76dc52d3f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 5995,
            "upload_time": "2019-02-07T14:32:22",
            "url": "https://files.pythonhosted.org/packages/14/e6/7f6ce2c4da684a3b7f3bfcfe8970eae4d29782013157016c1410613d7407/appuio_routes_monitoring-1.1.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "8166a45a4ee9cc2db152bd80e7a8da2c",
                "sha256": "8cf9d85c66967262ae9b306f767df2d6c2b067f8cc580371da4e1e937df50939"
            },
            "downloads": -1,
            "filename": "appuio_routes_monitoring-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8166a45a4ee9cc2db152bd80e7a8da2c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 4331,
            "upload_time": "2019-02-07T14:32:23",
            "url": "https://files.pythonhosted.org/packages/f5/6b/32d1bc969f0093d6e52ceaf97e6bf329c004c1b4fa2afb866d6356162eb8/appuio_routes_monitoring-1.1.1.tar.gz"
        }
    ]
}