https://github.com/suse/rookcheck

https://github.com/suse/rookcheck

ceph kubernetes rook test

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/suse/rookcheck
• Owner: SUSE
• License: apache-2.0
• Created: 2019-11-29T11:29:49.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T23:51:11.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T19:42:29.589Z (about 2 months ago)
• Topics: ceph, kubernetes, rook, test
• Language: Python
• Size: 771 KB
• Stars: 4
• Watchers: 7
• Forks: 11
• Open Issues: 15
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
rookcheck

=========

`rookcheck` is a testing platform for `rook.io`_. The intention is to provide

developers with a way to simulate various environments and scenarios that may

occur within them.

For example, rookcheck can perform tests such as adding new nodes to your

kubernetes cluster and ensuring that they are correctly enrolled and handled by

rook.io/ceph.

Additionally rookcheck can handle disaster testing such as kernel panics,

physically removed nodes, and so forth.

Because a test may need to interact with the underlying hardware the unit tests

will set up and configure the nodes, distros, kubernetes, and rook itself.

These are then exposed to the test writer to interact with further or to verify

the environment.

`Read the full documentation `_.

Quickstart

----------

Install requirements:

.. code-block:: bash

    sudo zypper in python-pip

    sudo pip install tox

    sudo zypper in $(tox -qq -e bindep -- -b)

    sudo systemctl start docker

    sudo usermod -aG docker $USER

Configure:

.. code-block:: bash

    cp configuration.env .env

    vim .env # Make any changes needed

Run tests:

.. code-block:: bash

    tox -e py38

.. image:: https://readthedocs.org/projects/rookcheck/badge/?version=latest

   :target: https://rookcheck.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Status

.. _`rook.io`: https://rook.io/