openstack-manuals/doc/user-guide/source/cli_manage_shares.rst
Xing Yang de8f0d0ed0 Update admin and user guide for Manila CLI
This patch updates admin and user guide for Manila CLI.

Change-Id: I29961d91f35b1e57b1c84733014cf7a5112d4e5a
2015-10-11 23:09:19 -04:00

25 KiB

Manage shares

A share is provided by file storage. You can give access to a share to instances. To create and manage shares, you use manila client commands.

Create a share network

  1. Create a share network:

    $ manila share-network-create --name mysharenetwork --description "My Manila network" --neutron-net-id 394246ed-d3fd-4a30-a456-7042ce3429b9 --neutron-subnet-id 8f56d97d-8495-4a5b-8544-9ae4ee9390fc
    +-------------------+--------------------------------------+
    | Property          | Value                                |
    +-------------------+--------------------------------------+
    | name              | mysharenetwork                       |
    | segmentation_id   | None                                 |
    | created_at        | 2015-08-17T21:13:29.607489           |
    | neutron_subnet_id | 8f56d97d-8495-4a5b-8544-9ae4ee9390fc |
    | updated_at        | None                                 |
    | network_type      | None                                 |
    | neutron_net_id    | 394246ed-d3fd-4a30-a456-7042ce3429b9 |
    | ip_version        | None                                 |
    | nova_net_id       | None                                 |
    | cidr              | None                                 |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791     |
    | id                | ccd6b453-8b05-4508-bbce-93bfe660451f |
    | description       | My Manila network                    |
    +-------------------+--------------------------------------+
  2. List share networks:

    $ manila share-network-list
    +--------------------------------------+----------------+
    | id                                   | name           |
    +--------------------------------------+----------------+
    | ccd6b453-8b05-4508-bbce-93bfe660451f | mysharenetwork |
    +--------------------------------------+----------------+

Create a share

  1. Create a share:

    $ manila create --name myshare --description "My Manila share" --share-network ccd6b453-8b05-4508-bbce-93bfe660451f NFS 1
    +-------------------+--------------------------------------+
    | Property          | Value                                |
    +-------------------+--------------------------------------+
    | status            | creating                             |
    | description       | My Manila share                      |
    | availability_zone | nova                                 |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f |
    | export_locations  | []                                   |
    | host              | None                                 |
    | snapshot_id       | None                                 |
    | is_public         | False                                |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | size              | 1                                    |
    | name              | myshare                              |
    | share_type        | default                              |
    | created_at        | 2015-08-17T21:17:23.777696           |
    | export_location   | None                                 |
    | share_proto       | NFS                                  |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791     |
    | metadata          | {}                                   |
    +-------------------+--------------------------------------+
  2. Show a share:

    $ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------------+--------------------------------------+
    | Property          | Value                                |
    +-------------------+--------------------------------------+
    | status            | creating                             |
    | description       | My Manila share                      |
    | availability_zone | nova                                 |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f |
    | export_locations  | []                                   |
    | host              | ubuntuManila@generic1#GENERIC1       |
    | snapshot_id       | None                                 |
    | is_public         | False                                |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | size              | 1                                    |
    | name              | myshare                              |
    | share_type        | default                              |
    | created_at        | 2015-08-17T21:17:23.000000           |
    | export_location   | None                                 |
    | share_proto       | NFS                                  |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791     |
    | metadata          | {}                                   |
    +-------------------+--------------------------------------+
  3. List shares:

    $ manila list
    +--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | ID                                   | Name    | Size | Share Proto | Status    | Is Public | Share Type | Export location                                               | Host                           |
    +--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | myshare | 1    | NFS         | available | False     | default    | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 | ubuntuManila@generic1#GENERIC1 |
    +--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+

Allow access

  1. Allow access:

    $ manila access-allow 2fe736d1-08ac-46f9-a482-8f224405f2a7 ip 192.100.00.168
    +--------------+--------------------------------------+
    | Property     | Value                                |
    +--------------+--------------------------------------+
    | share_id     | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | deleted      | False                                |
    | created_at   | 2015-08-17T21:36:52.025125           |
    | updated_at   | None                                 |
    | access_type  | ip                                   |
    | access_to    | 192.100.00.168                       |
    | access_level | rw                                   |
    | state        | new                                  |
    | deleted_at   | None                                 |
    | id           | d73d04ca-a97e-42bb-94b1-e01c72c8e50e |
    +--------------+--------------------------------------+
  2. List access:

    $ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +--------------------------------------+-------------+----------------+--------------+--------+
    | id                                   | access type | access to      | access level | state  |
    +--------------------------------------+-------------+----------------+--------------+--------+
    | d73d04ca-a97e-42bb-94b1-e01c72c8e50e | ip          | 192.100.00.168 | rw           | active |
    +--------------------------------------+-------------+----------------+--------------+--------+

    The access is created.

Deny access

  1. Deny access:

    $ manila access-deny 2fe736d1-08ac-46f9-a482-8f224405f2a7 d73d04ca-a97e-42bb-94b1-e01c72c8e50e
  2. List access:

    $ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +----+-------------+-----------+--------------+-------+
    | id | access type | access to | access level | state |
    +----+-------------+-----------+--------------+-------+
    +----+-------------+-----------+--------------+-------+

    The access is removed.

Create snapshot

  1. Create a snapshot:

    $ manila snapshot-create --name mysnapshot --description "My Manila snapshot" 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------+--------------------------------------+
    | Property    | Value                                |
    +-------------+--------------------------------------+
    | status      | creating                             |
    | share_id    | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | name        | mysnapshot                           |
    | created_at  | 2015-08-17T21:50:53.295017           |
    | share_proto | NFS                                  |
    | id          | 1a411703-baef-495f-8e9c-b60e68f2e657 |
    | size        | 1                                    |
    | share_size  | 1                                    |
    | description | My Manila snapshot                   |
    +-------------+--------------------------------------+
  2. List snapshots:

    $ manila snapshot-list
    +--------------------------------------+--------------------------------------+-----------+------------+------------+
    | ID                                   | Share ID                             | Status    | Name       | Share Size |
    +--------------------------------------+--------------------------------------+-----------+------------+------------+
    | 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1          |
    +--------------------------------------+--------------------------------------+-----------+------------+------------+

Create share from snapshot

  1. Create a share from a snapshot:

    $ manila create --snapshot-id 1a411703-baef-495f-8e9c-b60e68f2e657 --share-network ccd6b453-8b05-4508-bbce-93bfe660451f --name mysharefromsnap NFS 1
    +-------------------+--------------------------------------+
    | Property          | Value                                |
    +-------------------+--------------------------------------+
    | status            | creating                             |
    | description       | None                                 |
    | availability_zone | nova                                 |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f |
    | export_locations  | []                                   |
    | host              | ubuntuManila@generic1#GENERIC1       |
    | snapshot_id       | 1a411703-baef-495f-8e9c-b60e68f2e657 |
    | is_public         | False                                |
    | id                | bcc5b2a7-862b-418a-9607-5d669619d652 |
    | size              | 1                                    |
    | name              | mysharefromsnap                      |
    | share_type        | default                              |
    | created_at        | 2015-08-17T21:54:43.000000           |
    | export_location   | None                                 |
    | share_proto       | NFS                                  |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791     |
    | metadata          | {}                                   |
    +-------------------+--------------------------------------+
  2. List shares:

    $ manila list
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | ID                                   | Name            | Size | Share Proto | Status    | Is Public | Share Type | Export location                                               | Host                           |
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | myshare         | 1    | NFS         | available | False     | default    | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 | ubuntuManila@generic1#GENERIC1 |
    | bcc5b2a7-862b-418a-9607-5d669619d652 | mysharefromsnap | 1    | NFS         | creating  | False     | default    | None                                                          | ubuntuManila@generic1#GENERIC1 |
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
  3. Show the share created from snapshot:

    $ manila show bcc5b2a7-862b-418a-9607-5d669619d652
    +-------------------+---------------------------------------------------------------+
    | Property          | Value                                                         |
    +-------------------+---------------------------------------------------------------+
    | status            | available                                                     |
    | description       | None                                                          |
    | availability_zone | nova                                                          |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f                          |
    | export_locations  | 10.254.0.3:/shares/share-bcc5b2a7-862b-418a-9607-5d669619d652 |
    | host              | ubuntuManila@generic1#GENERIC1                                |
    | snapshot_id       | 1a411703-baef-495f-8e9c-b60e68f2e657                          |
    | is_public         | False                                                         |
    | id                | bcc5b2a7-862b-418a-9607-5d669619d652                          |
    | size              | 1                                                             |
    | name              | mysharefromsnap                                               |
    | share_type        | default                                                       |
    | created_at        | 2015-08-17T21:54:43.000000                                    |
    | share_proto       | NFS                                                           |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791                              |
    | metadata          | {}                                                            |
    +-------------------+---------------------------------------------------------------+

Delete share

  1. Delete a share:

    $ manila delete bcc5b2a7-862b-418a-9607-5d669619d652
  2. List shares:

    $ manila list
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | ID                                   | Name            | Size | Share Proto | Status    | Is Public | Share Type | Export location                                               | Host                           |
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
    | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | myshare         | 1    | NFS         | available | False     | default    | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 | ubuntuManila@generic1#GENERIC1 |
    | bcc5b2a7-862b-418a-9607-5d669619d652 | mysharefromsnap | 1    | NFS         | deleting  | False     | default    | 10.254.0.3:/shares/share-bcc5b2a7-862b-418a-9607-5d669619d652 | ubuntuManila@generic1#GENERIC1 |
    +--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+

    The share is being deleted.

Delete snapshot

  1. List snapshots before deleting:

    $ manila snapshot-list
    +--------------------------------------+--------------------------------------+-----------+------------+------------+
    | ID                                   | Share ID                             | Status    | Name       | Share Size |
    +--------------------------------------+--------------------------------------+-----------+------------+------------+
    | 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1          |
    +--------------------------------------+--------------------------------------+-----------+------------+------------+
  2. Delete a snapshot:

    $ manila snapshot-delete 1a411703-baef-495f-8e9c-b60e68f2e657xyang@ubuntuManila:~/devstack$ manila snapshot-list
  3. List snapshots after deleting:

    .. code::
    ID Share ID Status Name Share Size

    +----+----------+--------+------+------------+

    The snapshot is deleted.

Extend share

  1. Extend share:

    $ manila extend 2fe736d1-08ac-46f9-a482-8f224405f2a7 2
  2. Show the share while it is being extended:

    $ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------------+---------------------------------------------------------------+
    | Property          | Value                                                         |
    +-------------------+---------------------------------------------------------------+
    | status            | extending                                                     |
    | description       | My Manila share                                               |
    | availability_zone | nova                                                          |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f                          |
    | export_locations  | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | host              | ubuntuManila@generic1#GENERIC1                                |
    | snapshot_id       | None                                                          |
    | is_public         | False                                                         |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7                          |
    | size              | 1                                                             |
    | name              | myshare                                                       |
    | share_type        | default                                                       |
    | created_at        | 2015-08-17T21:17:23.000000                                    |
    | share_proto       | NFS                                                           |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791                              |
    | metadata          | {}                                                            |
    +-------------------+---------------------------------------------------------------+
  3. Show the share after it is extended:

    $ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------------+---------------------------------------------------------------+
    | Property          | Value                                                         |
    +-------------------+---------------------------------------------------------------+
    | status            | available                                                     |
    | description       | My Manila share                                               |
    | availability_zone | nova                                                          |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f                          |
    | export_locations  | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | host              | ubuntuManila@generic1#GENERIC1                                |
    | snapshot_id       | None                                                          |
    | is_public         | False                                                         |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7                          |
    | size              | 2                                                             |
    | name              | myshare                                                       |
    | share_type        | default                                                       |
    | created_at        | 2015-08-17T21:17:23.000000                                    |
    | share_proto       | NFS                                                           |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791                              |
    | metadata          | {}                                                            |
    +-------------------+---------------------------------------------------------------+

Shrink share

  1. Shrink a share:

    $ manila shrink 2fe736d1-08ac-46f9-a482-8f224405f2a7 1
  2. Show the share while it is being shrunk:

    $ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------------+---------------------------------------------------------------+
    | Property          | Value                                                         |
    +-------------------+---------------------------------------------------------------+
    | status            | shrinking                                                     |
    | description       | My Manila share                                               |
    | availability_zone | nova                                                          |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f                          |
    | export_locations  | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | host              | ubuntuManila@generic1#GENERIC1                                |
    | snapshot_id       | None                                                          |
    | is_public         | False                                                         |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7                          |
    | size              | 2                                                             |
    | name              | myshare                                                       |
    | share_type        | default                                                       |
    | created_at        | 2015-08-17T21:17:23.000000                                    |
    | share_proto       | NFS                                                           |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791                              |
    | metadata          | {}                                                            |
    +-------------------+---------------------------------------------------------------+
  3. Show the share after it is being shrunk:

    $ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
    +-------------------+---------------------------------------------------------------+
    | Property          | Value                                                         |
    +-------------------+---------------------------------------------------------------+
    | status            | available                                                     |
    | description       | My Manila share                                               |
    | availability_zone | nova                                                          |
    | share_network_id  | ccd6b453-8b05-4508-bbce-93bfe660451f                          |
    | export_locations  | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
    | host              | ubuntuManila@generic1#GENERIC1                                |
    | snapshot_id       | None                                                          |
    | is_public         | False                                                         |
    | id                | 2fe736d1-08ac-46f9-a482-8f224405f2a7                          |
    | size              | 1                                                             |
    | name              | myshare                                                       |
    | share_type        | default                                                       |
    | created_at        | 2015-08-17T21:17:23.000000                                    |
    | share_proto       | NFS                                                           |
    | project_id        | d80a6323e99f4f22a26ad2accd3ec791                              |
    | metadata          | {}                                                            |
    +-------------------+---------------------------------------------------------------+