freezer-web-ui


Namefreezer-web-ui JSON
Version 14.0.0 PyPI version JSON
download
home_pagehttps://github.com/openstack/freezer-web-ui
SummaryFreezer - Backup as a Service User Interface
upload_time2023-03-22 12:15:53
maintainer
docs_urlNone
authorOpenStack
requires_python>=3.8
licenseApache-2
keywords horizon freezer backup openstack
VCS
bugtrack_url
requirements python-freezerclient oslo.log horizon
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========================
Team and repository tags
========================

.. image:: https://governance.openstack.org/tc/badges/freezer-web-ui.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

===========================
Freezer - Horizon Dashboard
===========================

freezer-web-ui is a horizon plugin based in django aimed at providing an interaction
with freezer

* Issue tracking and feature specifications: https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui

Requirements
============

Freezer Dashboard requires a freezer API client to be installed in the same environment as horizon::

    git clone https://github.com/openstack/python-freezerclient
    cd python-freezerclient
    python setup.py install (is important that freezer API client is installed from source and not with pip and
                             is installed on horizon virtual environment)

Freezer Dashboard requires a freezer API endpoint which you can install following this steps:

    `https://github.com/openstack/freezer-api/blob/master/README.rst
    <https://github.com/openstack/freezer-api/blob/master/README.rst>`_

API registration
================

Register freezer api endpoint:

    `https://github.com/openstack/freezer-api/blob/master/README.rst#api-registration
    <https://github.com/openstack/freezer-api/blob/master/README.rst#api-registration>`_

If keystone service-create and endpoint-create are not available you can set as a fallback the following on::

    # vim /opt/stack/horizon/openstack_dashboard/local/local_settings.py

    # add FREEZER_API_URL = http://<api_url>:<port>


Dev Installation
================

In the installation procedure we'll assume your main Horizon dashboard
directory is /opt/stack/horizon/openstack_dashboard/dashboards/.


To install freezer dashboard for development you need to do the following::

    # git clone https://github.com/openstack/freezer-web-ui

    # cd freezer-web-ui

    # cp freezer-web-ui/disaster_recovery/enabled/_5050_freezer.py  /opt/stack/horizon/openstack_dashboard/enabled/_5050_freezer.py

    # to disable the panel just copy the following file

    # cp freezer-web-ui/disaster_recovery/enabled/_7050_freezer_remove_panel_.py  /opt/stack/horizon/openstack_dashboard/enabled/_7050_freezer_remove_panel_.py

    # cd /opt/stack/horizon/

    # pip install -r requirements.txt

    # make sure freezer is installed from source as detailed in the first step

    # ./run_tests.sh --runserver 0.0.0.0:8000

Production Installation
=======================

To deploy freezer dashboard in production you need to do the following::

    # git clone https://github.com/openstack/freezer-web-ui

    # cd freezer-web-ui

    # cp freezer-web-ui/disaster_recovery/enabled/_5050_freezer.py  /opt/stack/horizon/openstack_dashboard/enabled/_5050_freezer.py

    # to disable the panel just copy the following file

    # cp freezer-web-ui/disaster_recovery/enabled/_7050_freezer_remove_panel_.py  /opt/stack/horizon/openstack_dashboard/enabled/_7050_freezer_remove_panel_.py

    # make sure freezer is installed from source as detailed in the first step

    # restart apache2 service


A new tab called "Disaster Recovery" will appear on your panels.


Tox
===

1. Run tox::

    tox -v


Development under proxy
_______________________

If you are developing or deploying under proxies remember to set no_proxies for::

    freezer-api endpoint
    keystone endpoint

Source Code
===========

The project source code repository is located at:
https://opendev.org/openstack/freezer-web-ui/




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/openstack/freezer-web-ui",
    "name": "freezer-web-ui",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "horizon,freezer,backup,openstack",
    "author": "OpenStack",
    "author_email": "openstack-discuss@lists.openstack.org",
    "download_url": "https://files.pythonhosted.org/packages/f2/ea/4b2d14f254267ec601fef34232dbbbe55a9fa323be6354eaf00b9b9ebc44/freezer-web-ui-14.0.0.tar.gz",
    "platform": null,
    "description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/freezer-web-ui.svg\n    :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\n===========================\nFreezer - Horizon Dashboard\n===========================\n\nfreezer-web-ui is a horizon plugin based in django aimed at providing an interaction\nwith freezer\n\n* Issue tracking and feature specifications: https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui\n\nRequirements\n============\n\nFreezer Dashboard requires a freezer API client to be installed in the same environment as horizon::\n\n    git clone https://github.com/openstack/python-freezerclient\n    cd python-freezerclient\n    python setup.py install (is important that freezer API client is installed from source and not with pip and\n                             is installed on horizon virtual environment)\n\nFreezer Dashboard requires a freezer API endpoint which you can install following this steps:\n\n    `https://github.com/openstack/freezer-api/blob/master/README.rst\n    <https://github.com/openstack/freezer-api/blob/master/README.rst>`_\n\nAPI registration\n================\n\nRegister freezer api endpoint:\n\n    `https://github.com/openstack/freezer-api/blob/master/README.rst#api-registration\n    <https://github.com/openstack/freezer-api/blob/master/README.rst#api-registration>`_\n\nIf keystone service-create and endpoint-create are not available you can set as a fallback the following on::\n\n    # vim /opt/stack/horizon/openstack_dashboard/local/local_settings.py\n\n    # add FREEZER_API_URL = http://<api_url>:<port>\n\n\nDev Installation\n================\n\nIn the installation procedure we'll assume your main Horizon dashboard\ndirectory is /opt/stack/horizon/openstack_dashboard/dashboards/.\n\n\nTo install freezer dashboard for development you need to do the following::\n\n    # git clone https://github.com/openstack/freezer-web-ui\n\n    # cd freezer-web-ui\n\n    # cp freezer-web-ui/disaster_recovery/enabled/_5050_freezer.py  /opt/stack/horizon/openstack_dashboard/enabled/_5050_freezer.py\n\n    # to disable the panel just copy the following file\n\n    # cp freezer-web-ui/disaster_recovery/enabled/_7050_freezer_remove_panel_.py  /opt/stack/horizon/openstack_dashboard/enabled/_7050_freezer_remove_panel_.py\n\n    # cd /opt/stack/horizon/\n\n    # pip install -r requirements.txt\n\n    # make sure freezer is installed from source as detailed in the first step\n\n    # ./run_tests.sh --runserver 0.0.0.0:8000\n\nProduction Installation\n=======================\n\nTo deploy freezer dashboard in production you need to do the following::\n\n    # git clone https://github.com/openstack/freezer-web-ui\n\n    # cd freezer-web-ui\n\n    # cp freezer-web-ui/disaster_recovery/enabled/_5050_freezer.py  /opt/stack/horizon/openstack_dashboard/enabled/_5050_freezer.py\n\n    # to disable the panel just copy the following file\n\n    # cp freezer-web-ui/disaster_recovery/enabled/_7050_freezer_remove_panel_.py  /opt/stack/horizon/openstack_dashboard/enabled/_7050_freezer_remove_panel_.py\n\n    # make sure freezer is installed from source as detailed in the first step\n\n    # restart apache2 service\n\n\nA new tab called \"Disaster Recovery\" will appear on your panels.\n\n\nTox\n===\n\n1. Run tox::\n\n    tox -v\n\n\nDevelopment under proxy\n_______________________\n\nIf you are developing or deploying under proxies remember to set no_proxies for::\n\n    freezer-api endpoint\n    keystone endpoint\n\nSource Code\n===========\n\nThe project source code repository is located at:\nhttps://opendev.org/openstack/freezer-web-ui/\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2",
    "summary": "Freezer - Backup as a Service User Interface",
    "version": "14.0.0",
    "project_urls": {
        "Homepage": "https://github.com/openstack/freezer-web-ui"
    },
    "split_keywords": [
        "horizon",
        "freezer",
        "backup",
        "openstack"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e3c498d0cf1c22fa6dec31b6e1b250912b1f38773b00fcc8b6469e52757e8d9f",
                "md5": "742f906a41418aa10b86ea1d12a02113",
                "sha256": "1cdaf42740150e8deee1e557c9a02f1feb2762d716472da6887c23966215d962"
            },
            "downloads": -1,
            "filename": "freezer_web_ui-14.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "742f906a41418aa10b86ea1d12a02113",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 147414,
            "upload_time": "2023-03-22T12:15:50",
            "upload_time_iso_8601": "2023-03-22T12:15:50.092078Z",
            "url": "https://files.pythonhosted.org/packages/e3/c4/98d0cf1c22fa6dec31b6e1b250912b1f38773b00fcc8b6469e52757e8d9f/freezer_web_ui-14.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2ea4b2d14f254267ec601fef34232dbbbe55a9fa323be6354eaf00b9b9ebc44",
                "md5": "bdfaf85b9c8a466555086f3c2d8a5d38",
                "sha256": "613751be281fe94693b81b296395a43c8320401c7f0e296099323e6e007eb84b"
            },
            "downloads": -1,
            "filename": "freezer-web-ui-14.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bdfaf85b9c8a466555086f3c2d8a5d38",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 126735,
            "upload_time": "2023-03-22T12:15:53",
            "upload_time_iso_8601": "2023-03-22T12:15:53.663462Z",
            "url": "https://files.pythonhosted.org/packages/f2/ea/4b2d14f254267ec601fef34232dbbbe55a9fa323be6354eaf00b9b9ebc44/freezer-web-ui-14.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-22 12:15:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "openstack",
    "github_project": "freezer-web-ui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "python-freezerclient",
            "specs": [
                [
                    ">=",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "oslo.log",
            "specs": [
                [
                    ">=",
                    "3.36.0"
                ]
            ]
        },
        {
            "name": "horizon",
            "specs": [
                [
                    ">=",
                    "17.1.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "freezer-web-ui"
}
        
Elapsed time: 0.15444s