Commit Graph

25 Commits

Author SHA1 Message Date
Brian Rosmaita f380a5137a Update README
Even though cinderlib development is stopping, the cinder project is
still around, so add the #openstack-cinder IRC channel as another
source of info for people interested in the status of cinderlib.

Change-Id: Id3cfc4ca100f0968f1898ae9c91776cbf5d20121
2024-01-18 12:41:39 -05:00
Brian Rosmaita f165c6ff5e Stop cinderlib development
Remove files from master, as development will no longer occur there.
The stable branches continue to be supported while they are in
Maintained status.

Updated the README to indicate this change.

Depends-on: Ib186ac5830e5920e264d79be946995e63e960426
Depends-on: I081cd363117671eaab6a3193094d5872f9820354
Depends-on: If2b9a82cddb20543b176ee22765049db257c89b9
Depends-on: I1143e5e5ccf8103e386fe1ce614a554e7f152d9a
Change-Id: I4722b869033ad1bd357e36c4a258b6d3ea61f5d6
2024-01-05 16:03:46 +00:00
Gorka Eguileor 1bdc8fa5c1 Fix cinderlib Python package
Setuptools gives 2 errors with the current cinderlib Python package:

- Project's description-file has an unsupported directive.
- test-requirements has a github reference.

We fix the first issue by removing the git repository from the test
requirements and adding it to the Tox file while adding cinder to the
required-projects to allow cross-repo denedencies.

We also add os-brick since we are currently also very dependent on it on
the nos_brick.py code.

For the second issue we create a new DESCRIPTION.rst file that doesn't
include the "raw" directive unsupported by PyPi.

This patch will allow us to add the publish-to-pypi job to the
project-config repository.

Required-By: I9d8d9f7d802a27c3bfe3dbc0ee84cc24eee24ebc
Change-Id: Id029cedef513753700a10bcae761fdc1807964e1
2019-03-15 13:19:12 +01:00
Gorka Eguileor 77f399fd96 Format as a Cinder-related OpenStack project
Since we are going to be importing the project into OpenStack we need it
to follow the same structure as the other projects under the Cinder
umbrella.
2019-02-19 16:28:03 +01:00
Gorka Eguileor 713fcf7659 Fix #7: Facilitate running example using container
To be able to run the example using the container we need to change our
hosts LVM configuration, which was not explained in the docs.

This patch adds the explanation as well as a simplified way of running
this without touching our own host using Vagrant + libvirt +
Ansible.
2018-08-29 13:56:26 +02:00
Gorka Eguileor 1ae465e50b docs: Update LVM configuration
Our documentation uses iscsi_protocol and iscsi_helper to initialize the
LVM backend in multiple places, but this configuration option was being
deprecated in Pike and was removed in Queens.

This patch replaces these configuration options with their target_*
counterparts so the documentation is valid for all cinderlib supported
releases.
2018-08-29 13:12:09 +02:00
Gorka Eguileor 836182bb01 docs: Update docks referring to Pike release
Now that we support other Cinder releases besides Pike we need to update
the documentation a little bit to reflect this.
2018-08-24 17:03:54 +02:00
Gorka Eguileor b788d547c8 Fix README example
After adding the metadata persistence plugin system the example in the
README doesn't work anymore.

The reason is that the serialization doesn't save the local attach
information, so when we deserialize it we don't know the volume has a
local attachment.

Update the example to show how to do the detach.
2018-07-18 12:20:55 +02:00
karmab fd6b0dc583 Provide a workaround for demo on old centos boxes 2018-07-18 11:36:11 +02:00
Gorka Eguileor b566fe78af docs: Add docker hub shields to README.rst 2018-07-04 12:51:22 +02:00
Gorka Eguileor 8250aaab5d Add Docker images
Add Docker image files for automatically building of images, and update
the documentation accordingly.
2018-07-02 19:09:58 +02:00
Gorka Eguileor 6310829f73 Fix github README file
Github doesn't support the "include" directive, so when we fixed the
readme for the PyPi package we broke the github readme.  Now it's only
presenting the demo.

To fix this we revert to having the whole readme in the README.rst file
and in setup.py we hardcode the removal of the demo section.
2018-06-14 20:47:24 +02:00
Gorka Eguileor ce4a475da1 Fix package readme
The package was using the README.rst file that included a raw directive,
which is not allowed by PyPi, so the reame wasn't being rendered in
PyPi.
2018-06-14 20:28:09 +02:00
Gorka Eguileor 744f956ca5 docs: Validation of VMAX
Add documentation on the validation of Dell EMC's VMAX storage as
reported by Helen Walsh.

Closes: #1
2018-06-14 11:03:21 +02:00
Gorka Eguileor 0c1e656b1b docs: Validation of SolidFire
Add documentation on the validation of NetApp's SolidFire storage as
reported by John Griffith

Closes: #3
2018-06-14 10:18:06 +02:00
Gorka Eguileor 8e97951756 docs: Add validated drivers section
It would be very useful for projects using this library knowing, not
only which backends have been tested, but also how they have been
tested.

Add a section for the validated drivers and include the ones we have
tested so far.
2018-06-13 12:46:13 +02:00
Gorka Eguileor 3aa57a7e25 Update documentation 2018-06-12 18:45:30 +02:00
Gorka Eguileor dc43affa4a Add functional testing documentation
This patch adds documentation explaining how to run the functional tests
before submitting a patch as well as how to test a specific Cinder
driver backend with cinderlib.
2018-06-12 18:45:29 +02:00
Gorka Eguileor 2448d4f721 Improve readme losetup command
Current recommended call to losetup in the README example can have race
conditions with other losetup calls.

This patch updates the recommendation with a non racy alternative.
2018-06-12 18:45:29 +02:00
Gorka Eguileor b49f5d8918 Add documentation
This patchs adds the first revision of the documentation.

There are still parts that are missing in sections like the internals
and the connection sections.
2018-06-12 18:45:29 +02:00
Gorka Eguileor a73ee7d772 Small README change 2018-06-12 18:44:37 +02:00
Gorka Eguileor 433b4c0fa5 Remove unused shields from README 2018-06-12 18:44:37 +02:00
Gorka Eguileor 40e7a1d8f7 Minor readme example fix 2017-11-03 17:06:36 +01:00
Gorka Eguileor a64f287951 Add usage example in readme 2017-11-03 16:45:16 +01:00
Gorka Eguileor 132d08a894 Initial commit 2017-11-03 16:45:13 +01:00