README.rst

==============
Manila Formula
==============

Manila is an OpenStack project to provide “Shared Filesystems as a service”.

Sample pillars
==============

Single manila service

.. code-block:: yaml

    manila:
      common:
        concurrency:
          lock_path: '/var/lock/manila'
        database:
          engine: mysql
          host: 10.20.0.101
          port: 3306
          name: manila
          user: manila
          password: segreto
        identity:
          engine: keystone
          host: 10.20.0.101
          port: 35357
          user: manila
          password: segreto
          region: RegionOne
          tenant: service
          endpoint_type: internalURL
        cache:
          engine: memcached
          members:
          - host: 10.20.0.102
            port: 11211
          - host: 10.20.0.103
            port: 11211
          - host: 10.20.0.104
            port: 11211
      api:
        bind:
          host: 10.20.0.102


Change default service policy configuration:
--------------------------------------------

.. code-block:: yaml

    manila:
      api:
        policy:
          quota_class_set:update: 'rule:default'
          service:update: 'rule:admin_or_owner'
          # Add key without value to remove line from policy.json
          share:create:

Backend configuration
=====================


Nexenta driver

.. code-block:: yaml

    manila:
      share:
        enabled_share_backends:
          nexenta:
            name: nexenta
            type: nexenta
            enabled: true
            dhss: false
            nexenta_host: 1.2.3.4
            nexenta_password: secretpassword
            nexenta_user: nonexistent
            nexenta_volume: volume1

Glusterfs driver

.. code-block:: yaml


    manila:
      share:
        enabled_share_backends:
          glusterfs:
            name: glusterfs
            type: glusterfs
            enabled: true
            share_driver: manila.share.drivers.glusterfs_native.GlusterfsNativeShareDriver
            dhss: false
            glusterfs_ganesha_server_ip: 1.2.3.4
            glusterfs_ganesha_server_password: secretpassword
            glusterfs_ganesha_server_username: nonexistent
            glusterfs_mount_point_base: state_path/mnt
            glusterfs_server_password: secretpassword
            glusterfs_path_to_private_key: /path/to/key
            glusterfs_nfs_server_type: glusterfs
            glusterfs_share_layout: share_layout
            glusterfs_target: remove:target
            glusterfs_servers:
              - server1
              - server2
            glusterfs_volume_pattern: manila-share-volume-d+$

Client usage:
=============

The `manila.client` state provides ability to manage manila resources.

Manage `share_type`

.. code-block:: yaml


    manila:
      client:
        enabled: true
        server:
          admin_identity:
            share_type:
              default:
                extra_specs:
                  driver_handles_share_servers: false

Enhanced logging with logging.conf
----------------------------------

By default logging.conf is disabled.

That is possible to enable per-binary logging.conf with new variables:
  * openstack_log_appender - set it to true to enable log_config_append for all OpenStack services;
  * openstack_fluentd_handler_enabled - set to true to enable FluentHandler for all Openstack services.

Only WatchedFileHandler and FluentHandler are available.

Also it is possible to configure this with pillar:

.. code-block:: yaml

  manila:
    common:
      logging:
        log_appender: true
        log_handlers:
          watchedfile:
            enabled: true
          fluentd:
            enabled: true

Enable x509 and ssl communication between Manila and Galera cluster.
---------------------
By default communication between Manila and Galera is unsecure.

manila:
  common:
    database:
      x509:
        enabled: True

You able to set custom certificates in pillar:

manila:
  common:
    database:
      x509:
        cacert: (certificate content)
        cert: (certificate content)
        key: (certificate content)

You can read more about it here:
    https://docs.openstack.org/security-guide/databases/database-access-control.html

Configmap configuration:
----------------

.. code-block:: yaml

  manila:
    common:
      configmap:
        DEFAULT:
          default_share_type: default_share_type
          share_name_template: share-%s
          rootwrap_config: '/etc/manila/rootwrap.conf'
          api_paste_config: '/etc/manila/api-paste.ini'

Don't manage services scheduling while upgrade
----------------------------------------------
For some special cases, don't manage services scheduling both enable and disable
before and after upgrade procedure.

If 'manage_service_maintenance: true' or not present - default behavior, disable services
before upgrade and enable it after upgrade.
If 'manage_service_maintenance: false' - don't disable and don't enable upgraded services
scheduling before and after upgrade.

.. code-block:: yaml

    manila:
      upgrade:
        manage_service_maintenance: false


More information
================

* https://wiki.openstack.org/wiki/Telemetry
* https://docs.openstack.org/developer/manila/
* https://github.com/openstack/manila
* https://bugs.launchpad.net/manila