sync fork master

.git-blame-ignore-revs

@@ -0,0 +1,12 @@
+# Git blame ignore revisions
+# This file contains commit hashes that should be ignored by git blame
+# to avoid showing formatting/style changes in blame output.
+#
+# To use this file, run:
+# git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Ruff formatting commits to ignore
+0ef57c0f49b9c0a6be358a87fff67869c0dc95b4
+95bd3aca64ddec062b884521349914866ddb4672
+16aaa8e7439bb8441c7a9ceff8d398fda276c553
+3e3b385c8c20b94b57255a3f34b39a249ba0a3ae

.pre-commit-config.yaml

@@ -1,24 +1,33 @@
 ---
-default_language_version:
-  # force all unspecified python hooks to run python3
-  python: python3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: mixed-line-ending
         args: ['--fix', 'lf']
         exclude: '.*\.(svg)$'
-      - id: check-byte-order-marker
+      - id: fix-byte-order-marker
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: debug-statements
       - id: check-yaml
         files: .*\.(yaml|yml)$
         exclude: '^(zuul.d|rally-jobs)/.*$'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.0
+    hooks:
+      - id: ruff-check
+        args: ['--fix', '--unsafe-fixes']
+      - id: ruff-format
+  - repo: https://opendev.org/openstack/hacking
+    rev: 7.0.0
+    hooks:
+      - id: hacking
+        additional_dependencies: []
+        exclude: '^(doc|releasenotes|tools)/.*$'
   - repo: https://github.com/PyCQA/doc8
-    rev: v1.1.1
+    rev: v2.0.0
     hooks:
       - id: doc8
         args: ['--ignore', 'D001']
@@ -27,13 +36,3 @@ repos:
     hooks:
       - id: bashate
         args: ['--ignore', 'E006,E042,E043']
-  - repo: local
-    hooks:
-      - id: flake8
-        name: flake8
-        additional_dependencies:
-          - hacking>=6.1.0,<6.2.0
-        language: python
-        entry: flake8
-        files: '^.*\.py$'
-        exclude: '^(doc|releasenotes|tools)/.*$'

README.rst

@@ -52,20 +52,20 @@ Command-line API
 ----------------
 
 Installing this package gets you a shell command, ``manila``, that you
-can use to interact with any Rackspace compatible API (including OpenStack).
+can use to interact with the OpenStack Manila API.
 
 You'll need to provide your OpenStack username and password. You can do this
-with the ``--os-username``, ``--os-password`` and  ``--os-tenant-name``
+with the ``--os-username``, ``--os-password`` and  ``--os-project-name``
 params, but it's easier to just set them as environment variables::
 
     export OS_USERNAME=foouser
     export OS_PASSWORD=barpass
-    export OS_TENANT_NAME=fooproject
+    export OS_PROJECT_NAME=fooproject
 
 You will also need to define the authentication url either with param
 ``--os-auth-url`` or as an environment variable::
 
-    export OS_AUTH_URL=http://example.com:5000/v2.0/
+    export OS_AUTH_URL=http://example.com:5000/v3/
 
 Since Keystone can return multiple regions in the Service Catalog, you
 can specify the one you want with ``--os-region-name`` (or
@@ -81,9 +81,9 @@ There's also a complete Python API, but it has not yet been documented.
 
 Quick-start using keystone::
 
-    # use v2.0 auth with http://example.com:5000/v2.0/
-    >>> from manilaclient.v1 import client
-    >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
+    # use v3 auth with http://example.com:5000/v3/
+    >>> from manilaclient.v2 import client
+    >>> nt = client.Client("2", USER, PASS, PROJECT, AUTH_URL, service_type="share")
     >>> nt.shares.list()
     [...]
 

doc/source/cli/decoder.rst

@@ -2,10 +2,14 @@
 OpenStackClient Mapping Guide
 =============================
 
+.. note::
+
+   The legacy ``manila`` CLI has been removed. This guide is maintained for
+   historical reference to help users upgrading from older versions.
+
 The following is a mapping between the legacy ``manila`` CLI client and
 OpenStackClient. Command options are only shown when necessary.
 
-
 .. only:: html
 
     .. csv-table::

doc/source/cli/osc/v2/index.rst

@@ -221,3 +221,10 @@ resource locks
 
 .. autoprogram-cliff:: openstack.share.v2
     :command: share lock *
+
+=========
+qos types
+=========
+
+.. autoprogram-cliff:: openstack.share.v2
+    :command: share qos type *

doc/source/cli/osc_plugin_cli.rst

@@ -27,10 +27,17 @@ environment variables::
 
     export OS_USERNAME=foo
     export OS_PASSWORD=bar
-    export OS_TENANT_NAME=foobarproject
+    export OS_PROJECT_NAME=foobarproject
     export OS_AUTH_URL=http://...
     export OS_SHARE_API_VERSION=2.51
 
+It is possible to use different Manila endpoint while using Openstack
+Client. In this case, you can use configuration option
+``--os-endpoint-override`` or set the corresponding environment
+variable::
+
+    export OS_SHARED_FILE_SYSTEM_ENDPOINT_OVERRIDE=http://...
+
 
 Getting help
 ============

doc/source/conf.py

@@ -29,10 +29,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
-              'openstackdocstheme',
-              'sphinxcontrib.programoutput',
-              'cliff.sphinxext']
+extensions = [
+    'sphinx.ext.autodoc',
+    'openstackdocstheme',
+    'sphinxcontrib.programoutput',
+    'cliff.sphinxext',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -87,8 +89,13 @@
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index', 'Manila-client.tex', 'Manila Python Client Documentation',
-     'Manila contributors', 'manual'),
+    (
+        'index',
+        'Manila-client.tex',
+        'Manila Python Client Documentation',
+        'Manila contributors',
+        'manual',
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/source/contributor/functional-tests.rst

@@ -28,7 +28,7 @@ run manila, a good place to start would be the `manila contributor guide`_.
 You can use the following local.conf file to configure DevStack including
 Manila using a few fake back ends:
 
-.. code-block:: console
+.. code-block:: bash
 
     [[local|localrc]]
 
@@ -117,7 +117,7 @@ For DevStack
 On your DevStack machine, you can run the following script. It assumes that
 ``devstack`` is cloned onto your base folder.
 
-.. code-block:: console
+.. code-block:: bash
 
     DEST=${DEST:-/opt/stack}
     MANILACLIENT_DIR=${MANILACLIENT_DIR:-$DEST/python-manilaclient}
@@ -163,7 +163,7 @@ On your DevStack machine, you can run the following script. It assumes that
     # Create share network and use it for functional tests if required
     USE_SHARE_NETWORK=$(trueorfalse True USE_SHARE_NETWORK)
 
-.. code-block:: console
+.. code-block:: bash
 
     if [[ ${USE_SHARE_NETWORK} = True ]]; then
         SHARE_NETWORK_NAME=${SHARE_NETWORK_NAME:-ci}
@@ -177,7 +177,7 @@ On your DevStack machine, you can run the following script. It assumes that
 
     fi
 
-.. code-block:: console
+.. code-block:: bash
 
     # Set share type if required
     if [[ "$SHARE_TYPE" ]]; then

doc/source/index.rst

@@ -2,41 +2,24 @@ Python bindings to the OpenStack Manila API
 ===========================================
 
 This is a client for OpenStack Manila API. There's :doc:`a Python API
-<user/api>` (the :mod:`manilaclient` module), and a :doc:`command-line script
-<user/shell>` (installed as :program:`manila`). Each implements the entire
-OpenStack Manila API. See :ref:`project-structure` for more information.
+<user/api>` (the :mod:`manilaclient` module) for programmatic access, and
+a command-line interface via the OpenStack CLI client. See
+:ref:`project-structure` for more information.
 
 You'll need credentials for an OpenStack cloud that implements the
 Manila API in order to use the manila client.
 
 Command-Line Reference
 ~~~~~~~~~~~~~~~~~~~~~~
-There are two shell implementations in python-manilaclient.
-
-.. important::
-
-    The legacy "manila" shell client is deprecated as of version ``5.0.0``.
-    A future version of python-manilaclient may not ship this legacy shell
-    client. If you rely on it, it is highly recommended that you begin using
-    the openstack CLI client right away. Refer to the `mapping guide
-    <cli/decoder.html>`_ to help with this transition.
-
-The "openstack" CLI client intends to be fully compatible with the manila API:
+Use the "openstack" CLI client to interact with the Manila API from the
+command line:
 
 .. toctree::
    :maxdepth: 1
 
    cli/osc_plugin_cli
    cli/decoder
 
-The legacy "manila" client is deprecated and may not support newer API
-features:
-
-.. toctree::
-   :maxdepth: 2
-
-   user/shell
-
 Using the python module
 ~~~~~~~~~~~~~~~~~~~~~~~
 

doc/source/user/api.rst

@@ -14,7 +14,7 @@ token and identify which endpoint you wish to speak to. Once you have
 done so, you can use the API like so::
 
     >>> from manilaclient import client
-    >>> manila = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL)
+    >>> manila = client.Client('2', $OS_USER_NAME, $OS_PASSWORD, $OS_PROJECT_NAME, $OS_AUTH_URL)
     >>> manila.shares.list()
     []
     >>> share = manila.shares.create(share_proto="nfs", size=1, share_network_id="some_share_network_id")
@@ -26,7 +26,7 @@ done so, you can use the API like so::
 
 In addition to creating and deleting shares, the manilaclient can manage
 share-types, access controls, and more! Using CephFS with Ganesha for NFS
-support as an example (assuumes this continues from the above initialization)::
+support as an example (assumes this continues from the above initialization)::
 
     >>> share_type = client.share_types.create(
     >>>     name="cephfsnfstype", spec_driver_handles_share_servers=False,