From ffa752895372b9f689ccb211fc2d679a4a84e0e9 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Tue, 17 Nov 2015 12:12:49 +0100 Subject: [PATCH] [config-ref] Initial import of RST tables Neutron tables are not included, the tools are not happy with this project. Implements: blueprint config-ref-rst Change-Id: I4c5a4933f4fb1c47a67bbba9f9a26abd8fe25e73 --- .../source/tables/aodh-amqp.rst | 28 +++ doc/config-ref-rst/source/tables/aodh-api.rst | 34 ++++ .../source/tables/aodh-auth.rst | 42 ++++ .../source/tables/aodh-auth_token.rst | 94 +++++++++ .../source/tables/aodh-common.rst | 56 ++++++ .../source/tables/aodh-coordination.rst | 24 +++ .../source/tables/aodh-cors.rst | 44 ++++ .../source/tables/aodh-database.rst | 62 ++++++ .../source/tables/aodh-logging.rst | 62 ++++++ .../source/tables/aodh-policy.rst | 24 +++ .../source/tables/aodh-qpid.rst | 46 +++++ .../source/tables/aodh-rabbitmq.rst | 66 ++++++ .../source/tables/aodh-redis.rst | 24 +++ doc/config-ref-rst/source/tables/aodh-rpc.rst | 62 ++++++ .../source/tables/aodh-zeromq.rst | 42 ++++ .../source/tables/ceilometer-alarm.rst | 38 ++++ .../source/tables/ceilometer-alarms.rst | 20 ++ .../source/tables/ceilometer-amqp.rst | 28 +++ .../source/tables/ceilometer-api.rst | 60 ++++++ .../source/tables/ceilometer-auth.rst | 36 ++++ .../source/tables/ceilometer-auth_token.rst | 92 +++++++++ .../source/tables/ceilometer-collector.rst | 38 ++++ .../source/tables/ceilometer-common.rst | 62 ++++++ .../source/tables/ceilometer-cors.rst | 44 ++++ .../source/tables/ceilometer-database.rst | 76 +++++++ .../source/tables/ceilometer-debug.rst | 20 ++ .../tables/ceilometer-dispatcher_gnocchi.rst | 28 +++ .../tables/ceilometer-dispatcher_http.rst | 26 +++ .../source/tables/ceilometer-dispatchers.rst | 22 ++ .../source/tables/ceilometer-events.rst | 34 ++++ .../source/tables/ceilometer-exchange.rst | 48 +++++ .../source/tables/ceilometer-glance.rst | 20 ++ .../source/tables/ceilometer-inspector.rst | 24 +++ .../source/tables/ceilometer-ipmi.rst | 22 ++ .../source/tables/ceilometer-logging.rst | 62 ++++++ .../source/tables/ceilometer-magnetodb.rst | 20 ++ .../source/tables/ceilometer-notification.rst | 22 ++ .../source/tables/ceilometer-policy.rst | 24 +++ .../source/tables/ceilometer-qpid.rst | 46 +++++ .../source/tables/ceilometer-rabbitmq.rst | 66 ++++++ .../source/tables/ceilometer-redis.rst | 30 +++ .../source/tables/ceilometer-rgw.rst | 22 ++ .../source/tables/ceilometer-rpc.rst | 88 ++++++++ .../tables/ceilometer-service_types.rst | 30 +++ .../source/tables/ceilometer-swift.rst | 20 ++ .../source/tables/ceilometer-tripleo.rst | 26 +++ .../source/tables/ceilometer-vmware.rst | 36 ++++ .../source/tables/ceilometer-xenapi.rst | 26 +++ .../source/tables/ceilometer-zaqar.rst | 20 ++ .../source/tables/ceilometer-zeromq.rst | 42 ++++ .../source/tables/cinder-amqp.rst | 28 +++ .../source/tables/cinder-api.rst | 96 +++++++++ .../source/tables/cinder-auth.rst | 20 ++ .../source/tables/cinder-auth_token.rst | 92 +++++++++ .../source/tables/cinder-backups.rst | 44 ++++ .../source/tables/cinder-backups_ceph.rst | 32 +++ .../source/tables/cinder-backups_nfs.rst | 32 +++ .../source/tables/cinder-backups_swift.rst | 48 +++++ .../source/tables/cinder-backups_tsm.rst | 24 +++ .../source/tables/cinder-block-device.rst | 20 ++ .../source/tables/cinder-blockbridge.rst | 34 ++++ .../source/tables/cinder-ca.rst | 24 +++ .../source/tables/cinder-cloudbyte.rst | 42 ++++ .../source/tables/cinder-common.rst | 136 +++++++++++++ .../source/tables/cinder-compute.rst | 32 +++ .../source/tables/cinder-cors.rst | 44 ++++ .../source/tables/cinder-database.rst | 64 ++++++ .../source/tables/cinder-datera.rst | 30 +++ .../source/tables/cinder-debug.rst | 20 ++ .../source/tables/cinder-dellsc.rst | 28 +++ .../source/tables/cinder-dothill.rst | 30 +++ .../source/tables/cinder-drbd.rst | 26 +++ .../source/tables/cinder-emc.rst | 50 +++++ .../source/tables/cinder-emc_sio.rst | 40 ++++ .../source/tables/cinder-eqlx.rst | 32 +++ .../source/tables/cinder-flashsystem.rst | 26 +++ .../source/tables/cinder-hds-hnas.rst | 22 ++ .../source/tables/cinder-hgst.rst | 30 +++ .../source/tables/cinder-hitachi-hbsd.rst | 62 ++++++ .../source/tables/cinder-hpe3par.rst | 38 ++++ .../source/tables/cinder-hplefthand.rst | 30 +++ .../source/tables/cinder-hpmsa.rst | 30 +++ .../source/tables/cinder-hpxp.rst | 54 +++++ .../source/tables/cinder-huawei.rst | 22 ++ .../source/tables/cinder-ibmnas.rst | 38 ++++ .../source/tables/cinder-images.rst | 54 +++++ .../source/tables/cinder-infortrend.rst | 34 ++++ .../source/tables/cinder-keymgr.rst | 26 +++ .../source/tables/cinder-lenovo.rst | 30 +++ .../source/tables/cinder-logging.rst | 62 ++++++ .../source/tables/cinder-lvm.rst | 26 +++ .../tables/cinder-netapp_7mode_iscsi.rst | 40 ++++ .../source/tables/cinder-netapp_7mode_nfs.rst | 44 ++++ .../tables/cinder-netapp_cdot_iscsi.rst | 44 ++++ .../source/tables/cinder-netapp_cdot_nfs.rst | 52 +++++ .../tables/cinder-netapp_eseries_iscsi.rst | 44 ++++ .../source/tables/cinder-nimble.rst | 22 ++ .../source/tables/cinder-profiler.rst | 22 ++ .../source/tables/cinder-prophetstor_dpl.rst | 32 +++ .../source/tables/cinder-pure.rst | 20 ++ .../source/tables/cinder-qpid.rst | 46 +++++ .../source/tables/cinder-quobyte.rst | 28 +++ .../source/tables/cinder-quota.rst | 38 ++++ .../source/tables/cinder-rabbitmq.rst | 66 ++++++ .../source/tables/cinder-redis.rst | 24 +++ .../source/tables/cinder-rpc.rst | 70 +++++++ .../source/tables/cinder-san.rst | 42 ++++ .../source/tables/cinder-scality.rst | 24 +++ .../source/tables/cinder-scheduler.rst | 38 ++++ .../source/tables/cinder-scst.rst | 22 ++ .../source/tables/cinder-sheepdog.rst | 22 ++ .../source/tables/cinder-smbfs.rst | 34 ++++ .../source/tables/cinder-solidfire.rst | 36 ++++ .../source/tables/cinder-srb.rst | 20 ++ .../source/tables/cinder-storage.rst | 78 ++++++++ .../source/tables/cinder-storage_ceph.rst | 42 ++++ .../tables/cinder-storage_glusterfs.rst | 28 +++ .../source/tables/cinder-storage_gpfs.rst | 30 +++ .../source/tables/cinder-storage_nfs.rst | 32 +++ .../source/tables/cinder-storwize.rst | 50 +++++ .../source/tables/cinder-swift.rst | 22 ++ .../source/tables/cinder-tintri.rst | 26 +++ .../source/tables/cinder-violin.rst | 26 +++ .../source/tables/cinder-vmware.rst | 46 +++++ .../source/tables/cinder-vzstorage.rst | 28 +++ .../source/tables/cinder-windows.rst | 20 ++ .../source/tables/cinder-xio.rst | 30 +++ .../source/tables/cinder-xiv.rst | 32 +++ .../source/tables/cinder-zeromq.rst | 42 ++++ .../source/tables/cinder-zfssa-iscsi.rst | 54 +++++ .../source/tables/cinder-zfssa-nfs.rst | 42 ++++ .../source/tables/cinder-zones.rst | 20 ++ .../source/tables/cinder-zoning.rst | 30 +++ .../source/tables/cinder-zoning_fabric.rst | 34 ++++ .../tables/cinder-zoning_fabric_cisco.rst | 34 ++++ .../source/tables/cinder-zoning_manager.rst | 20 ++ .../tables/cinder-zoning_manager_cisco.rst | 20 ++ .../source/tables/glance-amqp.rst | 32 +++ .../source/tables/glance-api.rst | 84 ++++++++ .../source/tables/glance-auth_token.rst | 92 +++++++++ .../source/tables/glance-ca.rst | 24 +++ .../source/tables/glance-cinder.rst | 28 +++ .../source/tables/glance-common.rst | 82 ++++++++ .../source/tables/glance-cors.rst | 44 ++++ .../source/tables/glance-database.rst | 58 ++++++ .../source/tables/glance-filesystem.rst | 26 +++ .../source/tables/glance-gridfs.rst | 22 ++ .../source/tables/glance-imagecache.rst | 34 ++++ .../source/tables/glance-logging.rst | 62 ++++++ .../source/tables/glance-policy.rst | 24 +++ .../source/tables/glance-profiler.rst | 22 ++ .../source/tables/glance-qpid.rst | 46 +++++ .../source/tables/glance-rabbitmq.rst | 66 ++++++ .../source/tables/glance-rbd.rst | 28 +++ .../source/tables/glance-redis.rst | 32 +++ .../source/tables/glance-registry.rst | 46 +++++ .../source/tables/glance-replicator.rst | 34 ++++ .../source/tables/glance-rpc.rst | 70 +++++++ .../source/tables/glance-s3.rst | 48 +++++ .../source/tables/glance-scrubber.rst | 20 ++ .../source/tables/glance-sheepdog.rst | 24 +++ .../source/tables/glance-swift.rst | 72 +++++++ .../source/tables/glance-taskflow.rst | 24 +++ .../source/tables/glance-testing.rst | 22 ++ .../source/tables/glance-vmware.rst | 38 ++++ .../source/tables/glance-zeromq.rst | 42 ++++ .../source/tables/heat-amqp.rst | 32 +++ doc/config-ref-rst/source/tables/heat-api.rst | 124 ++++++++++++ .../source/tables/heat-auth_token.rst | 94 +++++++++ .../source/tables/heat-cfn_api.rst | 40 ++++ .../source/tables/heat-clients.rst | 32 +++ .../source/tables/heat-clients_backends.rst | 20 ++ .../source/tables/heat-clients_ceilometer.rst | 28 +++ .../source/tables/heat-clients_cinder.rst | 30 +++ .../source/tables/heat-clients_glance.rst | 28 +++ .../source/tables/heat-clients_heat.rst | 30 +++ .../source/tables/heat-clients_keystone.rst | 30 +++ .../source/tables/heat-clients_neutron.rst | 28 +++ .../source/tables/heat-clients_nova.rst | 30 +++ .../source/tables/heat-clients_sahara.rst | 28 +++ .../source/tables/heat-clients_swift.rst | 28 +++ .../source/tables/heat-clients_trove.rst | 28 +++ .../source/tables/heat-cloudwatch_api.rst | 40 ++++ .../source/tables/heat-common.rst | 94 +++++++++ .../source/tables/heat-cors.rst | 44 ++++ .../source/tables/heat-crypt.rst | 20 ++ .../source/tables/heat-database.rst | 58 ++++++ .../source/tables/heat-loadbalancer.rst | 20 ++ .../source/tables/heat-logging.rst | 60 ++++++ .../source/tables/heat-metadata_api.rst | 20 ++ .../source/tables/heat-notification.rst | 20 ++ .../source/tables/heat-qpid.rst | 46 +++++ .../source/tables/heat-quota.rst | 28 +++ .../source/tables/heat-rabbitmq.rst | 66 ++++++ .../source/tables/heat-redis.rst | 24 +++ doc/config-ref-rst/source/tables/heat-rpc.rst | 70 +++++++ .../source/tables/heat-testing.rst | 22 ++ .../source/tables/heat-trustee.rst | 22 ++ .../source/tables/heat-waitcondition_api.rst | 20 ++ .../source/tables/heat-zeromq.rst | 42 ++++ .../source/tables/ironic-agent.rst | 34 ++++ .../source/tables/ironic-amqp.rst | 28 +++ .../source/tables/ironic-amt.rst | 24 +++ .../source/tables/ironic-api.rst | 64 ++++++ .../source/tables/ironic-auth.rst | 20 ++ .../source/tables/ironic-auth_token.rst | 94 +++++++++ .../source/tables/ironic-cisco_ucs.rst | 28 +++ .../source/tables/ironic-common.rst | 58 ++++++ .../source/tables/ironic-conductor.rst | 60 ++++++ .../source/tables/ironic-console.rst | 28 +++ .../source/tables/ironic-database.rst | 60 ++++++ .../source/tables/ironic-debug.rst | 20 ++ .../source/tables/ironic-deploy.rst | 32 +++ .../source/tables/ironic-dhcp.rst | 20 ++ .../source/tables/ironic-disk_partitioner.rst | 22 ++ .../source/tables/ironic-drac.rst | 22 ++ .../source/tables/ironic-glance.rst | 50 +++++ .../source/tables/ironic-iboot.rst | 24 +++ .../source/tables/ironic-ilo.rst | 44 ++++ .../source/tables/ironic-inspector.rst | 24 +++ .../source/tables/ironic-ipmi.rst | 22 ++ .../source/tables/ironic-irmc.rst | 40 ++++ .../source/tables/ironic-keystone.rst | 20 ++ .../source/tables/ironic-logging.rst | 62 ++++++ .../source/tables/ironic-neutron.rst | 28 +++ .../source/tables/ironic-oneview.rst | 30 +++ .../source/tables/ironic-policy.rst | 24 +++ .../source/tables/ironic-pxe.rst | 52 +++++ .../source/tables/ironic-qpid.rst | 46 +++++ .../source/tables/ironic-rabbitmq.rst | 66 ++++++ .../source/tables/ironic-redis.rst | 30 +++ .../source/tables/ironic-rpc.rst | 68 +++++++ .../source/tables/ironic-seamicro.rst | 22 ++ .../source/tables/ironic-snmp.rst | 22 ++ .../source/tables/ironic-ssh.rst | 24 +++ .../source/tables/ironic-swift.rst | 20 ++ .../source/tables/ironic-virtualbox.rst | 20 ++ .../source/tables/ironic-zeromq.rst | 42 ++++ .../source/tables/keystone-amqp.rst | 32 +++ .../source/tables/keystone-api.rst | 96 +++++++++ .../source/tables/keystone-assignment.rst | 20 ++ .../source/tables/keystone-auth.rst | 28 +++ .../source/tables/keystone-auth_token.rst | 92 +++++++++ .../source/tables/keystone-ca.rst | 54 +++++ .../source/tables/keystone-cache.rst | 54 +++++ .../source/tables/keystone-catalog.rst | 28 +++ .../source/tables/keystone-common.rst | 32 +++ .../source/tables/keystone-cors.rst | 44 ++++ .../source/tables/keystone-credential.rst | 20 ++ .../source/tables/keystone-database.rst | 58 ++++++ .../source/tables/keystone-debug.rst | 28 +++ .../source/tables/keystone-domain.rst | 24 +++ .../source/tables/keystone-federation.rst | 30 +++ .../source/tables/keystone-fernet_tokens.rst | 22 ++ .../source/tables/keystone-identity.rst | 36 ++++ .../source/tables/keystone-kvs.rst | 26 +++ .../source/tables/keystone-ldap.rst | 188 ++++++++++++++++++ .../source/tables/keystone-logging.rst | 62 ++++++ .../source/tables/keystone-mapping.rst | 24 +++ .../source/tables/keystone-memcache.rst | 22 ++ .../source/tables/keystone-oauth.rst | 24 +++ .../source/tables/keystone-os_inherit.rst | 20 ++ .../source/tables/keystone-policy.rst | 30 +++ .../source/tables/keystone-qpid.rst | 46 +++++ .../source/tables/keystone-rabbitmq.rst | 66 ++++++ .../source/tables/keystone-redis.rst | 32 +++ .../source/tables/keystone-revoke.rst | 26 +++ .../source/tables/keystone-role.rst | 26 +++ .../source/tables/keystone-rpc.rst | 62 ++++++ .../source/tables/keystone-saml.rst | 54 +++++ .../source/tables/keystone-security.rst | 20 ++ .../source/tables/keystone-token.rst | 38 ++++ .../source/tables/keystone-tokenless.rst | 24 +++ .../source/tables/keystone-trust.rst | 26 +++ .../source/tables/keystone-zeromq.rst | 42 ++++ .../source/tables/manila-amqp.rst | 28 +++ .../source/tables/manila-api.rst | 64 ++++++ .../source/tables/manila-auth.rst | 20 ++ .../source/tables/manila-auth_token.rst | 94 +++++++++ .../source/tables/manila-ca.rst | 24 +++ .../source/tables/manila-common.rst | 82 ++++++++ .../source/tables/manila-compute.rst | 38 ++++ .../source/tables/manila-cors.rst | 44 ++++ .../source/tables/manila-database.rst | 64 ++++++ .../source/tables/manila-emc.rst | 36 ++++ .../source/tables/manila-ganesha.rst | 32 +++ .../source/tables/manila-glusterfs.rst | 40 ++++ .../source/tables/manila-gpfs.rst | 38 ++++ .../source/tables/manila-hdfs.rst | 30 +++ .../source/tables/manila-hds_hnas.rst | 36 ++++ .../source/tables/manila-hp3par.rst | 40 ++++ .../source/tables/manila-huawei.rst | 20 ++ .../source/tables/manila-logging.rst | 64 ++++++ .../source/tables/manila-netapp.rst | 46 +++++ .../source/tables/manila-qpid.rst | 46 +++++ .../source/tables/manila-quobyte.rst | 34 ++++ .../source/tables/manila-quota.rst | 34 ++++ .../source/tables/manila-rabbitmq.rst | 66 ++++++ .../source/tables/manila-redis.rst | 30 +++ .../source/tables/manila-rpc.rst | 70 +++++++ .../source/tables/manila-san.rst | 24 +++ .../source/tables/manila-scheduler.rst | 38 ++++ .../source/tables/manila-share.rst | 140 +++++++++++++ .../source/tables/manila-storage.rst | 40 ++++ .../source/tables/manila-winrm.rst | 32 +++ .../source/tables/manila-zeromq.rst | 42 ++++ .../source/tables/manila-zfssa.rst | 46 +++++ .../source/tables/nova-amqp.rst | 30 +++ doc/config-ref-rst/source/tables/nova-api.rst | 80 ++++++++ .../source/tables/nova-apiv21.rst | 24 +++ .../source/tables/nova-auth_token.rst | 92 +++++++++ .../source/tables/nova-authentication.rst | 22 ++ .../source/tables/nova-availabilityzones.rst | 24 +++ .../source/tables/nova-barbican.rst | 34 ++++ doc/config-ref-rst/source/tables/nova-ca.rst | 58 ++++++ .../source/tables/nova-cells.rst | 54 +++++ .../source/tables/nova-common.rst | 66 ++++++ .../source/tables/nova-compute.rst | 90 +++++++++ .../source/tables/nova-conductor.rst | 30 +++ .../source/tables/nova-configdrive.rst | 32 +++ .../source/tables/nova-console.rst | 32 +++ .../source/tables/nova-cors.rst | 44 ++++ .../source/tables/nova-database.rst | 90 +++++++++ .../source/tables/nova-debug.rst | 20 ++ doc/config-ref-rst/source/tables/nova-ec2.rst | 52 +++++ .../nova-ephemeral_storage_encryption.rst | 24 +++ .../source/tables/nova-fping.rst | 20 ++ .../source/tables/nova-glance.rst | 40 ++++ .../source/tables/nova-hyperv.rst | 42 ++++ .../source/tables/nova-hypervisor.rst | 32 +++ .../source/tables/nova-ipv6.rst | 26 +++ .../source/tables/nova-ironic.rst | 38 ++++ .../source/tables/nova-keymgr.rst | 22 ++ .../source/tables/nova-ldap.rst | 38 ++++ .../source/tables/nova-libvirt.rst | 106 ++++++++++ .../source/tables/nova-livemigration.rst | 40 ++++ .../source/tables/nova-logging.rst | 64 ++++++ .../source/tables/nova-metadata.rst | 36 ++++ .../source/tables/nova-network.rst | 146 ++++++++++++++ .../source/tables/nova-neutron.rst | 62 ++++++ doc/config-ref-rst/source/tables/nova-pci.rst | 22 ++ .../source/tables/nova-periodic.rst | 22 ++ .../source/tables/nova-policy.rst | 44 ++++ .../source/tables/nova-qpid.rst | 46 +++++ .../source/tables/nova-quobyte.rst | 22 ++ .../source/tables/nova-quota.rst | 58 ++++++ .../source/tables/nova-rabbitmq.rst | 66 ++++++ doc/config-ref-rst/source/tables/nova-rdp.rst | 22 ++ .../source/tables/nova-redis.rst | 30 +++ doc/config-ref-rst/source/tables/nova-rpc.rst | 76 +++++++ doc/config-ref-rst/source/tables/nova-s3.rst | 38 ++++ .../source/tables/nova-scheduler.rst | 98 +++++++++ .../source/tables/nova-serial_console.rst | 32 +++ .../source/tables/nova-spice.rst | 34 ++++ .../source/tables/nova-testing.rst | 26 +++ .../source/tables/nova-trustedcomputing.rst | 32 +++ .../source/tables/nova-upgrade_levels.rst | 40 ++++ .../source/tables/nova-vmware.rst | 60 ++++++ doc/config-ref-rst/source/tables/nova-vnc.rst | 54 +++++ .../source/tables/nova-volumes.rst | 90 +++++++++ doc/config-ref-rst/source/tables/nova-vpn.rst | 36 ++++ doc/config-ref-rst/source/tables/nova-xen.rst | 128 ++++++++++++ .../source/tables/nova-xvpvncproxy.rst | 22 ++ .../source/tables/nova-zeromq.rst | 42 ++++ .../source/tables/nova-zookeeper.rst | 26 +++ .../source/tables/sahara-amqp.rst | 32 +++ .../source/tables/sahara-api.rst | 28 +++ .../source/tables/sahara-auth_token.rst | 92 +++++++++ .../source/tables/sahara-clients.rst | 74 +++++++ .../source/tables/sahara-common.rst | 100 ++++++++++ .../source/tables/sahara-cors.rst | 44 ++++ .../source/tables/sahara-database.rst | 62 ++++++ .../source/tables/sahara-domain.rst | 24 +++ .../source/tables/sahara-logging.rst | 62 ++++++ .../tables/sahara-object_store_access.rst | 22 ++ .../source/tables/sahara-policy.rst | 24 +++ .../source/tables/sahara-qpid.rst | 46 +++++ .../source/tables/sahara-rabbitmq.rst | 66 ++++++ .../source/tables/sahara-redis.rst | 32 +++ .../source/tables/sahara-rpc.rst | 68 +++++++ .../source/tables/sahara-ssh.rst | 24 +++ .../source/tables/sahara-timeouts.rst | 32 +++ .../source/tables/sahara-zeromq.rst | 42 ++++ .../source/tables/trove-amqp.rst | 34 ++++ .../source/tables/trove-api.rst | 74 +++++++ .../source/tables/trove-auth_token.rst | 92 +++++++++ .../source/tables/trove-backup.rst | 38 ++++ .../source/tables/trove-clients.rst | 32 +++ .../source/tables/trove-cluster.rst | 24 +++ .../source/tables/trove-common.rst | 52 +++++ .../source/tables/trove-compute.rst | 32 +++ .../source/tables/trove-cors.rst | 44 ++++ .../source/tables/trove-database.rst | 28 +++ .../source/tables/trove-db_cassandra.rst | 40 ++++ .../source/tables/trove-db_couchbase.rst | 68 +++++++ .../source/tables/trove-db_db2.rst | 44 ++++ .../source/tables/trove-db_mariadb.rst | 50 +++++ .../source/tables/trove-db_mongodb.rst | 62 ++++++ .../source/tables/trove-db_mysql.rst | 50 +++++ .../source/tables/trove-db_percona.rst | 54 +++++ .../source/tables/trove-db_postgresql.rst | 44 ++++ .../source/tables/trove-db_pxc.rst | 62 ++++++ .../source/tables/trove-db_redis.rst | 50 +++++ .../source/tables/trove-db_vertica.rst | 52 +++++ .../source/tables/trove-debug.rst | 32 +++ .../source/tables/trove-dns.rst | 50 +++++ .../source/tables/trove-guestagent.rst | 42 ++++ .../source/tables/trove-heat.rst | 26 +++ .../source/tables/trove-logging.rst | 66 ++++++ .../source/tables/trove-network.rst | 26 +++ .../source/tables/trove-nova.rst | 26 +++ .../source/tables/trove-qpid.rst | 46 +++++ .../source/tables/trove-quota.rst | 28 +++ .../source/tables/trove-rabbitmq.rst | 66 ++++++ .../source/tables/trove-redis.rst | 30 +++ .../source/tables/trove-rpc.rst | 72 +++++++ .../source/tables/trove-swift.rst | 24 +++ .../source/tables/trove-taskmanager.rst | 54 +++++ .../source/tables/trove-upgrades.rst | 24 +++ .../source/tables/trove-volume.rst | 38 ++++ .../source/tables/trove-zeromq.rst | 42 ++++ .../aodh.flagmappings | 22 +- .../ceilometer.flagmappings | 10 +- .../cinder.flagmappings | 39 ++-- .../cinder.headers | 2 +- .../glance.flagmappings | 26 +++ .../heat.flagmappings | 8 +- .../ironic.flagmappings | 18 ++ .../ironic.headers | 1 + .../keystone.flagmappings | 7 + .../manila.flagmappings | 5 + .../nova.flagmappings | 8 + .../sahara.flagmappings | 9 +- .../sahara.headers | 1 + .../trove.flagmappings | 36 +++- 435 files changed, 17851 insertions(+), 29 deletions(-) create mode 100644 doc/config-ref-rst/source/tables/aodh-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-api.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-auth.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-common.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-coordination.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-cors.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-database.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-logging.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-policy.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-redis.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/aodh-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-alarm.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-alarms.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-api.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-auth.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-collector.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-common.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-cors.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-database.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-debug.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-dispatcher_gnocchi.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-dispatcher_http.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-dispatchers.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-events.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-exchange.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-glance.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-inspector.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-ipmi.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-logging.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-magnetodb.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-notification.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-policy.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-redis.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-rgw.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-service_types.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-swift.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-tripleo.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-vmware.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-xenapi.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-zaqar.rst create mode 100644 doc/config-ref-rst/source/tables/ceilometer-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-api.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-auth.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-backups.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-backups_ceph.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-backups_nfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-backups_swift.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-backups_tsm.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-block-device.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-blockbridge.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-ca.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-cloudbyte.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-common.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-compute.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-cors.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-database.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-datera.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-debug.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-dellsc.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-dothill.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-drbd.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-emc.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-emc_sio.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-eqlx.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-flashsystem.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hds-hnas.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hgst.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hitachi-hbsd.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hpe3par.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hplefthand.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hpmsa.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-hpxp.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-huawei.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-ibmnas.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-images.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-infortrend.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-keymgr.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-lenovo.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-logging.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-lvm.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-nimble.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-profiler.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-prophetstor_dpl.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-pure.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-quobyte.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-quota.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-redis.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-san.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-scality.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-scheduler.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-scst.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-sheepdog.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-smbfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-solidfire.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-srb.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storage.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storage_ceph.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storage_glusterfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storage_nfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-storwize.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-swift.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-tintri.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-violin.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-vmware.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-vzstorage.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-windows.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-xio.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-xiv.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zfssa-iscsi.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zfssa-nfs.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zones.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zoning.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zoning_fabric.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zoning_fabric_cisco.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zoning_manager.rst create mode 100644 doc/config-ref-rst/source/tables/cinder-zoning_manager_cisco.rst create mode 100644 doc/config-ref-rst/source/tables/glance-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/glance-api.rst create mode 100644 doc/config-ref-rst/source/tables/glance-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/glance-ca.rst create mode 100644 doc/config-ref-rst/source/tables/glance-cinder.rst create mode 100644 doc/config-ref-rst/source/tables/glance-common.rst create mode 100644 doc/config-ref-rst/source/tables/glance-cors.rst create mode 100644 doc/config-ref-rst/source/tables/glance-database.rst create mode 100644 doc/config-ref-rst/source/tables/glance-filesystem.rst create mode 100644 doc/config-ref-rst/source/tables/glance-gridfs.rst create mode 100644 doc/config-ref-rst/source/tables/glance-imagecache.rst create mode 100644 doc/config-ref-rst/source/tables/glance-logging.rst create mode 100644 doc/config-ref-rst/source/tables/glance-policy.rst create mode 100644 doc/config-ref-rst/source/tables/glance-profiler.rst create mode 100644 doc/config-ref-rst/source/tables/glance-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/glance-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/glance-rbd.rst create mode 100644 doc/config-ref-rst/source/tables/glance-redis.rst create mode 100644 doc/config-ref-rst/source/tables/glance-registry.rst create mode 100644 doc/config-ref-rst/source/tables/glance-replicator.rst create mode 100644 doc/config-ref-rst/source/tables/glance-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/glance-s3.rst create mode 100644 doc/config-ref-rst/source/tables/glance-scrubber.rst create mode 100644 doc/config-ref-rst/source/tables/glance-sheepdog.rst create mode 100644 doc/config-ref-rst/source/tables/glance-swift.rst create mode 100644 doc/config-ref-rst/source/tables/glance-taskflow.rst create mode 100644 doc/config-ref-rst/source/tables/glance-testing.rst create mode 100644 doc/config-ref-rst/source/tables/glance-vmware.rst create mode 100644 doc/config-ref-rst/source/tables/glance-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/heat-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/heat-api.rst create mode 100644 doc/config-ref-rst/source/tables/heat-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/heat-cfn_api.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_backends.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_ceilometer.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_cinder.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_glance.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_heat.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_keystone.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_neutron.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_nova.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_sahara.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_swift.rst create mode 100644 doc/config-ref-rst/source/tables/heat-clients_trove.rst create mode 100644 doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst create mode 100644 doc/config-ref-rst/source/tables/heat-common.rst create mode 100644 doc/config-ref-rst/source/tables/heat-cors.rst create mode 100644 doc/config-ref-rst/source/tables/heat-crypt.rst create mode 100644 doc/config-ref-rst/source/tables/heat-database.rst create mode 100644 doc/config-ref-rst/source/tables/heat-loadbalancer.rst create mode 100644 doc/config-ref-rst/source/tables/heat-logging.rst create mode 100644 doc/config-ref-rst/source/tables/heat-metadata_api.rst create mode 100644 doc/config-ref-rst/source/tables/heat-notification.rst create mode 100644 doc/config-ref-rst/source/tables/heat-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/heat-quota.rst create mode 100644 doc/config-ref-rst/source/tables/heat-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/heat-redis.rst create mode 100644 doc/config-ref-rst/source/tables/heat-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/heat-testing.rst create mode 100644 doc/config-ref-rst/source/tables/heat-trustee.rst create mode 100644 doc/config-ref-rst/source/tables/heat-waitcondition_api.rst create mode 100644 doc/config-ref-rst/source/tables/heat-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-agent.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-amt.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-api.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-auth.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-cisco_ucs.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-common.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-conductor.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-console.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-database.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-debug.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-deploy.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-dhcp.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-disk_partitioner.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-drac.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-glance.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-iboot.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-ilo.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-inspector.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-ipmi.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-irmc.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-keystone.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-logging.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-neutron.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-oneview.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-policy.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-pxe.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-redis.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-seamicro.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-snmp.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-ssh.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-swift.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-virtualbox.rst create mode 100644 doc/config-ref-rst/source/tables/ironic-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-api.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-assignment.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-auth.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-ca.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-cache.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-catalog.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-common.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-cors.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-credential.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-database.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-debug.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-domain.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-federation.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-fernet_tokens.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-identity.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-kvs.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-ldap.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-logging.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-mapping.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-memcache.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-oauth.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-os_inherit.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-policy.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-redis.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-revoke.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-role.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-saml.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-security.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-token.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-tokenless.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-trust.rst create mode 100644 doc/config-ref-rst/source/tables/keystone-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/manila-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/manila-api.rst create mode 100644 doc/config-ref-rst/source/tables/manila-auth.rst create mode 100644 doc/config-ref-rst/source/tables/manila-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/manila-ca.rst create mode 100644 doc/config-ref-rst/source/tables/manila-common.rst create mode 100644 doc/config-ref-rst/source/tables/manila-compute.rst create mode 100644 doc/config-ref-rst/source/tables/manila-cors.rst create mode 100644 doc/config-ref-rst/source/tables/manila-database.rst create mode 100644 doc/config-ref-rst/source/tables/manila-emc.rst create mode 100644 doc/config-ref-rst/source/tables/manila-ganesha.rst create mode 100644 doc/config-ref-rst/source/tables/manila-glusterfs.rst create mode 100644 doc/config-ref-rst/source/tables/manila-gpfs.rst create mode 100644 doc/config-ref-rst/source/tables/manila-hdfs.rst create mode 100644 doc/config-ref-rst/source/tables/manila-hds_hnas.rst create mode 100644 doc/config-ref-rst/source/tables/manila-hp3par.rst create mode 100644 doc/config-ref-rst/source/tables/manila-huawei.rst create mode 100644 doc/config-ref-rst/source/tables/manila-logging.rst create mode 100644 doc/config-ref-rst/source/tables/manila-netapp.rst create mode 100644 doc/config-ref-rst/source/tables/manila-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/manila-quobyte.rst create mode 100644 doc/config-ref-rst/source/tables/manila-quota.rst create mode 100644 doc/config-ref-rst/source/tables/manila-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/manila-redis.rst create mode 100644 doc/config-ref-rst/source/tables/manila-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/manila-san.rst create mode 100644 doc/config-ref-rst/source/tables/manila-scheduler.rst create mode 100644 doc/config-ref-rst/source/tables/manila-share.rst create mode 100644 doc/config-ref-rst/source/tables/manila-storage.rst create mode 100644 doc/config-ref-rst/source/tables/manila-winrm.rst create mode 100644 doc/config-ref-rst/source/tables/manila-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/manila-zfssa.rst create mode 100644 doc/config-ref-rst/source/tables/nova-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/nova-api.rst create mode 100644 doc/config-ref-rst/source/tables/nova-apiv21.rst create mode 100644 doc/config-ref-rst/source/tables/nova-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/nova-authentication.rst create mode 100644 doc/config-ref-rst/source/tables/nova-availabilityzones.rst create mode 100644 doc/config-ref-rst/source/tables/nova-barbican.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ca.rst create mode 100644 doc/config-ref-rst/source/tables/nova-cells.rst create mode 100644 doc/config-ref-rst/source/tables/nova-common.rst create mode 100644 doc/config-ref-rst/source/tables/nova-compute.rst create mode 100644 doc/config-ref-rst/source/tables/nova-conductor.rst create mode 100644 doc/config-ref-rst/source/tables/nova-configdrive.rst create mode 100644 doc/config-ref-rst/source/tables/nova-console.rst create mode 100644 doc/config-ref-rst/source/tables/nova-cors.rst create mode 100644 doc/config-ref-rst/source/tables/nova-database.rst create mode 100644 doc/config-ref-rst/source/tables/nova-debug.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ec2.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ephemeral_storage_encryption.rst create mode 100644 doc/config-ref-rst/source/tables/nova-fping.rst create mode 100644 doc/config-ref-rst/source/tables/nova-glance.rst create mode 100644 doc/config-ref-rst/source/tables/nova-hyperv.rst create mode 100644 doc/config-ref-rst/source/tables/nova-hypervisor.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ipv6.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ironic.rst create mode 100644 doc/config-ref-rst/source/tables/nova-keymgr.rst create mode 100644 doc/config-ref-rst/source/tables/nova-ldap.rst create mode 100644 doc/config-ref-rst/source/tables/nova-libvirt.rst create mode 100644 doc/config-ref-rst/source/tables/nova-livemigration.rst create mode 100644 doc/config-ref-rst/source/tables/nova-logging.rst create mode 100644 doc/config-ref-rst/source/tables/nova-metadata.rst create mode 100644 doc/config-ref-rst/source/tables/nova-network.rst create mode 100644 doc/config-ref-rst/source/tables/nova-neutron.rst create mode 100644 doc/config-ref-rst/source/tables/nova-pci.rst create mode 100644 doc/config-ref-rst/source/tables/nova-periodic.rst create mode 100644 doc/config-ref-rst/source/tables/nova-policy.rst create mode 100644 doc/config-ref-rst/source/tables/nova-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/nova-quobyte.rst create mode 100644 doc/config-ref-rst/source/tables/nova-quota.rst create mode 100644 doc/config-ref-rst/source/tables/nova-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/nova-rdp.rst create mode 100644 doc/config-ref-rst/source/tables/nova-redis.rst create mode 100644 doc/config-ref-rst/source/tables/nova-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/nova-s3.rst create mode 100644 doc/config-ref-rst/source/tables/nova-scheduler.rst create mode 100644 doc/config-ref-rst/source/tables/nova-serial_console.rst create mode 100644 doc/config-ref-rst/source/tables/nova-spice.rst create mode 100644 doc/config-ref-rst/source/tables/nova-testing.rst create mode 100644 doc/config-ref-rst/source/tables/nova-trustedcomputing.rst create mode 100644 doc/config-ref-rst/source/tables/nova-upgrade_levels.rst create mode 100644 doc/config-ref-rst/source/tables/nova-vmware.rst create mode 100644 doc/config-ref-rst/source/tables/nova-vnc.rst create mode 100644 doc/config-ref-rst/source/tables/nova-volumes.rst create mode 100644 doc/config-ref-rst/source/tables/nova-vpn.rst create mode 100644 doc/config-ref-rst/source/tables/nova-xen.rst create mode 100644 doc/config-ref-rst/source/tables/nova-xvpvncproxy.rst create mode 100644 doc/config-ref-rst/source/tables/nova-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/nova-zookeeper.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-api.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-clients.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-common.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-cors.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-database.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-domain.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-logging.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-object_store_access.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-policy.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-redis.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-ssh.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-timeouts.rst create mode 100644 doc/config-ref-rst/source/tables/sahara-zeromq.rst create mode 100644 doc/config-ref-rst/source/tables/trove-amqp.rst create mode 100644 doc/config-ref-rst/source/tables/trove-api.rst create mode 100644 doc/config-ref-rst/source/tables/trove-auth_token.rst create mode 100644 doc/config-ref-rst/source/tables/trove-backup.rst create mode 100644 doc/config-ref-rst/source/tables/trove-clients.rst create mode 100644 doc/config-ref-rst/source/tables/trove-cluster.rst create mode 100644 doc/config-ref-rst/source/tables/trove-common.rst create mode 100644 doc/config-ref-rst/source/tables/trove-compute.rst create mode 100644 doc/config-ref-rst/source/tables/trove-cors.rst create mode 100644 doc/config-ref-rst/source/tables/trove-database.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_cassandra.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_couchbase.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_db2.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_mariadb.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_mongodb.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_mysql.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_percona.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_postgresql.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_pxc.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_redis.rst create mode 100644 doc/config-ref-rst/source/tables/trove-db_vertica.rst create mode 100644 doc/config-ref-rst/source/tables/trove-debug.rst create mode 100644 doc/config-ref-rst/source/tables/trove-dns.rst create mode 100644 doc/config-ref-rst/source/tables/trove-guestagent.rst create mode 100644 doc/config-ref-rst/source/tables/trove-heat.rst create mode 100644 doc/config-ref-rst/source/tables/trove-logging.rst create mode 100644 doc/config-ref-rst/source/tables/trove-network.rst create mode 100644 doc/config-ref-rst/source/tables/trove-nova.rst create mode 100644 doc/config-ref-rst/source/tables/trove-qpid.rst create mode 100644 doc/config-ref-rst/source/tables/trove-quota.rst create mode 100644 doc/config-ref-rst/source/tables/trove-rabbitmq.rst create mode 100644 doc/config-ref-rst/source/tables/trove-redis.rst create mode 100644 doc/config-ref-rst/source/tables/trove-rpc.rst create mode 100644 doc/config-ref-rst/source/tables/trove-swift.rst create mode 100644 doc/config-ref-rst/source/tables/trove-taskmanager.rst create mode 100644 doc/config-ref-rst/source/tables/trove-upgrades.rst create mode 100644 doc/config-ref-rst/source/tables/trove-volume.rst create mode 100644 doc/config-ref-rst/source/tables/trove-zeromq.rst diff --git a/doc/config-ref-rst/source/tables/aodh-amqp.rst b/doc/config-ref-rst/source/tables/aodh-amqp.rst new file mode 100644 index 0000000000..84ac08e209 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-amqp.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/aodh-api.rst b/doc/config-ref-rst/source/tables/aodh-api.rst new file mode 100644 index 0000000000..b20dbfa09c --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-api.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[api]** + - + * - ``host`` = ``0.0.0.0`` + - (StrOpt) The listen IP for the aodh API server. + * - ``paste_config`` = ``api_paste.ini`` + - (StrOpt) Configuration file for WSGI definition of API. + * - ``pecan_debug`` = ``False`` + - (BoolOpt) Toggle Pecan Debug Middleware. + * - ``port`` = ``8042`` + - (PortOpt) The port for the aodh API server. + * - ``workers`` = ``1`` + - (IntOpt) Number of workers for aodh API server. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. diff --git a/doc/config-ref-rst/source/tables/aodh-auth.rst b/doc/config-ref-rst/source/tables/aodh-auth.rst new file mode 100644 index 0000000000..c85db192b6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-auth.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[service_credentials]** + - + * - ``insecure`` = ``False`` + - (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. + * - ``os_auth_url`` = ``http://localhost:5000/v2.0`` + - (StrOpt) Auth URL to use for OpenStack service access. + * - ``os_cacert`` = ``None`` + - (StrOpt) Certificate chain for SSL validation. + * - ``os_endpoint_type`` = ``publicURL`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. + * - ``os_password`` = ``admin`` + - (StrOpt) Password to use for OpenStack service access. + * - ``os_project_domain_id`` = ``default`` + - (StrOpt) The domain id of the user project + * - ``os_project_name`` = ``admin`` + - (StrOpt) The user project name + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name to use for OpenStack service endpoints. + * - ``os_tenant_id`` = ```` + - (StrOpt) Tenant ID to use for OpenStack service access. + * - ``os_tenant_name`` = ``admin`` + - (StrOpt) Tenant name to use for OpenStack service access. + * - ``os_user_domain_id`` = ``default`` + - (StrOpt) The domain id of the user + * - ``os_username`` = ``aodh`` + - (StrOpt) User name to use for OpenStack service access. diff --git a/doc/config-ref-rst/source/tables/aodh-auth_token.rst b/doc/config-ref-rst/source/tables/aodh-auth_token.rst new file mode 100644 index 0000000000..6865b79516 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-auth_token.rst @@ -0,0 +1,94 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/aodh-common.rst b/doc/config-ref-rst/source/tables/aodh-common.rst new file mode 100644 index 0000000000..87133a20f6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-common.rst @@ -0,0 +1,56 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``alarm_max_actions`` = ``-1`` + - (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit. + * - ``evaluation_interval`` = ``60`` + - (IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters. + * - ``event_alarm_cache_ttl`` = ``60`` + - (IntOpt) TTL of event alarm caches, in seconds. Set to 0 to disable caching. + * - ``event_alarm_topic`` = ``alarm.all`` + - (StrOpt) The topic that aodh uses for event alarm evaluation. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``gnocchi_url`` = ``http://localhost:8041`` + - (StrOpt) URL to Gnocchi. + * - ``host`` = ``localhost`` + - (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. + * - ``http_timeout`` = ``600`` + - (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``notifier_rpc_topic`` = ``alarm_notifier`` + - (StrOpt) The topic that aodh uses for alarm notifier messages. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - ``project_alarm_quota`` = ``None`` + - (IntOpt) Maximum number of alarms defined for a project. + * - ``record_history`` = ``True`` + - (BoolOpt) Record alarm change events. + * - ``rest_notifier_certificate_file`` = ```` + - (StrOpt) SSL Client certificate for REST notifier. + * - ``rest_notifier_certificate_key`` = ```` + - (StrOpt) SSL Client private key for REST notifier. + * - ``rest_notifier_max_retries`` = ``0`` + - (IntOpt) Number of retries for REST notifier + * - ``rest_notifier_ssl_verify`` = ``True`` + - (BoolOpt) Whether to verify the SSL Server certificate when calling alarm action. + * - ``user_alarm_quota`` = ``None`` + - (IntOpt) Maximum number of alarms defined for a user. diff --git a/doc/config-ref-rst/source/tables/aodh-coordination.rst b/doc/config-ref-rst/source/tables/aodh-coordination.rst new file mode 100644 index 0000000000..b3ee062310 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-coordination.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Coordination configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[coordination]** + - + * - ``backend_url`` = ``None`` + - (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running. + * - ``check_watchers`` = ``10.0`` + - (FloatOpt) Number of seconds between checks to see if group membership has changed + * - ``heartbeat`` = ``1.0`` + - (FloatOpt) Number of seconds between heartbeats for distributed coordination. diff --git a/doc/config-ref-rst/source/tables/aodh-cors.rst b/doc/config-ref-rst/source/tables/aodh-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/aodh-database.rst b/doc/config-ref-rst/source/tables/aodh-database.rst new file mode 100644 index 0000000000..8637331b80 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-database.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``alarm_connection`` = ``None`` + - (StrOpt) The connection string used to connect to the alarm database - rather use ${database.connection} + * - ``alarm_history_time_to_live`` = ``-1`` + - (IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever). + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/aodh-logging.rst b/doc/config-ref-rst/source/tables/aodh-logging.rst new file mode 100644 index 0000000000..bbe00ece82 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/aodh-policy.rst b/doc/config-ref-rst/source/tables/aodh-policy.rst new file mode 100644 index 0000000000..3839d589e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-policy.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/aodh-qpid.rst b/doc/config-ref-rst/source/tables/aodh-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/aodh-rabbitmq.rst b/doc/config-ref-rst/source/tables/aodh-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/aodh-redis.rst b/doc/config-ref-rst/source/tables/aodh-redis.rst new file mode 100644 index 0000000000..dca6654f9c --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-redis.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/aodh-rpc.rst b/doc/config-ref-rst/source/tables/aodh-rpc.rst new file mode 100644 index 0000000000..11879f71ea --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-rpc.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/aodh-zeromq.rst b/doc/config-ref-rst/source/tables/aodh-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/aodh-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/ceilometer-alarm.rst b/doc/config-ref-rst/source/tables/ceilometer-alarm.rst new file mode 100644 index 0000000000..fc87bdbca4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-alarm.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of alarm configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[alarm]** + - + * - ``alarm_max_actions`` = ``-1`` + - (IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit. + * - ``evaluation_interval`` = ``60`` + - (IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters. + * - ``notifier_rpc_topic`` = ``alarm_notifier`` + - (StrOpt) The topic that ceilometer uses for alarm notifier messages. + * - ``project_alarm_quota`` = ``None`` + - (IntOpt) Maximum number of alarms defined for a project. + * - ``record_history`` = ``True`` + - (BoolOpt) Record alarm change events. + * - ``rest_notifier_certificate_file`` = ```` + - (StrOpt) SSL Client certificate for REST notifier. + * - ``rest_notifier_certificate_key`` = ```` + - (StrOpt) SSL Client private key for REST notifier. + * - ``rest_notifier_max_retries`` = ``0`` + - (IntOpt) Number of retries for REST notifier + * - ``rest_notifier_ssl_verify`` = ``True`` + - (BoolOpt) Whether to verify the SSL Server certificate when calling alarm action. + * - ``user_alarm_quota`` = ``None`` + - (IntOpt) Maximum number of alarms defined for a user. diff --git a/doc/config-ref-rst/source/tables/ceilometer-alarms.rst b/doc/config-ref-rst/source/tables/ceilometer-alarms.rst new file mode 100644 index 0000000000..ac93c003ad --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-alarms.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of alarms configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[alarms]** + - + * - ``gnocchi_url`` = ``http://localhost:8041`` + - (StrOpt) URL to Gnocchi. diff --git a/doc/config-ref-rst/source/tables/ceilometer-amqp.rst b/doc/config-ref-rst/source/tables/ceilometer-amqp.rst new file mode 100644 index 0000000000..84ac08e209 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-amqp.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/ceilometer-api.rst b/doc/config-ref-rst/source/tables/ceilometer-api.rst new file mode 100644 index 0000000000..47c91ab8e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-api.rst @@ -0,0 +1,60 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``api_paste_config`` = ``api_paste.ini`` + - (StrOpt) Configuration file for WSGI definition of API. + * - ``event_pipeline_cfg_file`` = ``event_pipeline.yaml`` + - (StrOpt) Configuration file for event pipeline definition. + * - ``pipeline_cfg_file`` = ``pipeline.yaml`` + - (StrOpt) Configuration file for pipeline definition. + * - ``pipeline_polling_interval`` = ``20`` + - (IntOpt) Polling interval for pipeline file configuration in seconds. + * - ``refresh_event_pipeline_cfg`` = ``False`` + - (BoolOpt) Refresh Event Pipeline configuration on-the-fly. + * - ``refresh_pipeline_cfg`` = ``False`` + - (BoolOpt) Refresh Pipeline configuration on-the-fly. + * - ``reserved_metadata_keys`` = ```` + - (ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace. + * - ``reserved_metadata_length`` = ``256`` + - (IntOpt) Limit on length of reserved metadata values. + * - ``reserved_metadata_namespace`` = ``metering.`` + - (ListOpt) List of metadata prefixes reserved for metering use. + * - **[api]** + - + * - ``aodh_is_enabled`` = ``None`` + - (BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone. + * - ``aodh_url`` = ``None`` + - (StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone. + * - ``default_api_return_limit`` = ``100`` + - (IntOpt) Default maximum number of items returned by API request. + * - ``gnocchi_is_enabled`` = ``None`` + - (BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone. + * - ``host`` = ``0.0.0.0`` + - (StrOpt) The listen IP for the ceilometer API server. + * - ``pecan_debug`` = ``False`` + - (BoolOpt) Toggle Pecan Debug Middleware. + * - ``port`` = ``8777`` + - (PortOpt) The port for the ceilometer API server. + * - ``workers`` = ``1`` + - (IntOpt) Number of workers for api, default value is 1. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. diff --git a/doc/config-ref-rst/source/tables/ceilometer-auth.rst b/doc/config-ref-rst/source/tables/ceilometer-auth.rst new file mode 100644 index 0000000000..9ed4140a04 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-auth.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[service_credentials]** + - + * - ``insecure`` = ``False`` + - (BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established. + * - ``os_auth_url`` = ``http://localhost:5000/v2.0`` + - (StrOpt) Auth URL to use for OpenStack service access. + * - ``os_cacert`` = ``None`` + - (StrOpt) Certificate chain for SSL validation. + * - ``os_endpoint_type`` = ``publicURL`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services. + * - ``os_password`` = ``admin`` + - (StrOpt) Password to use for OpenStack service access. + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name to use for OpenStack service endpoints. + * - ``os_tenant_id`` = ```` + - (StrOpt) Tenant ID to use for OpenStack service access. + * - ``os_tenant_name`` = ``admin`` + - (StrOpt) Tenant name to use for OpenStack service access. + * - ``os_username`` = ``ceilometer`` + - (StrOpt) User name to use for OpenStack service access. diff --git a/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst b/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/ceilometer-collector.rst b/doc/config-ref-rst/source/tables/ceilometer-collector.rst new file mode 100644 index 0000000000..136f8102c1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-collector.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of collector configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[collector]** + - + * - ``enable_rpc`` = ``False`` + - (BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues. + * - ``requeue_event_on_dispatcher_error`` = ``False`` + - (BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it. + * - ``requeue_sample_on_dispatcher_error`` = ``False`` + - (BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher. + * - ``udp_address`` = ``0.0.0.0`` + - (StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable. + * - ``udp_port`` = ``4952`` + - (PortOpt) Port to which the UDP socket is bound. + * - ``workers`` = ``1`` + - (IntOpt) Number of workers for collector service. default value is 1. + * - **[dispatcher_file]** + - + * - ``backup_count`` = ``0`` + - (IntOpt) The max number of the files to keep. + * - ``file_path`` = ``None`` + - (StrOpt) Name and the location of the file to record meters. + * - ``max_bytes`` = ``0`` + - (IntOpt) The max size of the file. diff --git a/doc/config-ref-rst/source/tables/ceilometer-common.rst b/doc/config-ref-rst/source/tables/ceilometer-common.rst new file mode 100644 index 0000000000..1af7b6da74 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-common.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``batch_polled_samples`` = ``True`` + - (BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``host`` = ``localhost`` + - (StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address. + * - ``http_timeout`` = ``600`` + - (IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``polling_namespaces`` = ``['compute', 'central']`` + - (MultiChoicesOpt) Polling namespace(s) to be used while resource polling + * - ``pollster_list`` = ``[]`` + - (MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling + * - ``rootwrap_config`` = ``/etc/ceilometer/rootwrap.conf`` + - (StrOpt) Path to the rootwrap configuration file touse for running commands as root + * - ``shuffle_time_before_polling_task`` = ``0`` + - (IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task. + * - ``sql_expire_samples_only`` = ``False`` + - (BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain. + * - **[compute]** + - + * - ``workload_partitioning`` = ``False`` + - (BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously. + * - **[coordination]** + - + * - ``backend_url`` = ``None`` + - (StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running. + * - ``check_watchers`` = ``10.0`` + - (FloatOpt) Number of seconds between checks to see if group membership has changed + * - ``heartbeat`` = ``1.0`` + - (FloatOpt) Number of seconds between heartbeats for distributed coordination. + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - **[meter]** + - + * - ``meter_definitions_cfg_file`` = ``meters.yaml`` + - (StrOpt) Configuration file for defining meter notifications. + * - **[polling]** + - + * - ``partitioning_group_prefix`` = ``None`` + - (StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded. diff --git a/doc/config-ref-rst/source/tables/ceilometer-cors.rst b/doc/config-ref-rst/source/tables/ceilometer-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/ceilometer-database.rst b/doc/config-ref-rst/source/tables/ceilometer-database.rst new file mode 100644 index 0000000000..c598476b02 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-database.rst @@ -0,0 +1,76 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``database_connection`` = ``None`` + - (StrOpt) DEPRECATED - Database connection string. + * - **[database]** + - + * - ``alarm_connection`` = ``None`` + - (StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used) + * - ``alarm_history_time_to_live`` = ``-1`` + - (IntOpt) Number of seconds that alarm histories are kept in the database for (<= 0 means forever). + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db2nosql_resource_id_maxlen`` = ``512`` + - (IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is _. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``event_connection`` = ``None`` + - (StrOpt) The connection string used to connect to the event database. (if unset, connection is used) + * - ``event_time_to_live`` = ``-1`` + - (IntOpt) Number of seconds that events are kept in the database for (<= 0 means forever). + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``metering_connection`` = ``None`` + - (StrOpt) The connection string used to connect to the metering database. (if unset, connection is used) + * - ``metering_time_to_live`` = ``-1`` + - (IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever). + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/ceilometer-debug.rst b/doc/config-ref-rst/source/tables/ceilometer-debug.rst new file mode 100644 index 0000000000..cb70b0539d --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-debug.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nova_http_log_debug`` = ``False`` + - (BoolOpt) Allow novaclient's debug log output. diff --git a/doc/config-ref-rst/source/tables/ceilometer-dispatcher_gnocchi.rst b/doc/config-ref-rst/source/tables/ceilometer-dispatcher_gnocchi.rst new file mode 100644 index 0000000000..9f0b762600 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-dispatcher_gnocchi.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Gnocchi dispatcher configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[dispatcher_gnocchi]** + - + * - ``archive_policy`` = ``None`` + - (StrOpt) The archive policy to use when the dispatcher create a new metric. + * - ``filter_project`` = ``gnocchi`` + - (StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity + * - ``filter_service_activity`` = ``True`` + - (BoolOpt) Filter out samples generated by Gnocchi service activity + * - ``resources_definition_file`` = ``gnocchi_resources.yaml`` + - (StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics + * - ``url`` = ``http://localhost:8041`` + - (StrOpt) URL to Gnocchi. diff --git a/doc/config-ref-rst/source/tables/ceilometer-dispatcher_http.rst b/doc/config-ref-rst/source/tables/ceilometer-dispatcher_http.rst new file mode 100644 index 0000000000..f89f181c42 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-dispatcher_http.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HTTP dispatcher configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[dispatcher_http]** + - + * - ``cadf_only`` = ``False`` + - (BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. This is deprecated in favor of keystonemiddleware's audit middleware functionality + * - ``event_target`` = ``None`` + - (StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target. + * - ``target`` = ```` + - (StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path + * - ``timeout`` = ``5`` + - (IntOpt) The max time in seconds to wait for a request to timeout. diff --git a/doc/config-ref-rst/source/tables/ceilometer-dispatchers.rst b/doc/config-ref-rst/source/tables/ceilometer-dispatchers.rst new file mode 100644 index 0000000000..49d63feef0 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-dispatchers.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of dispatchers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``event_dispatchers`` = ``['database']`` + - (MultiStrOpt) Dispatchers to process event data. + * - ``meter_dispatchers`` = ``['database']`` + - (MultiStrOpt) Dispatchers to process metering data. diff --git a/doc/config-ref-rst/source/tables/ceilometer-events.rst b/doc/config-ref-rst/source/tables/ceilometer-events.rst new file mode 100644 index 0000000000..b27c57152a --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-events.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of events configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[event]** + - + * - ``definitions_cfg_file`` = ``event_definitions.yaml`` + - (StrOpt) Configuration file for event definitions. + * - ``drop_unmatched_notifications`` = ``False`` + - (BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) + * - ``store_raw`` = ``[]`` + - (MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured. + * - **[notification]** + - + * - ``ack_on_event_error`` = ``True`` + - (BoolOpt) Acknowledge message when event persistence fails. + * - ``store_events`` = ``False`` + - (BoolOpt) Save event details. + * - ``workers`` = ``1`` + - (IntOpt) Number of workers for notification service, default value is 1. + * - ``workload_partitioning`` = ``False`` + - (BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously. diff --git a/doc/config-ref-rst/source/tables/ceilometer-exchange.rst b/doc/config-ref-rst/source/tables/ceilometer-exchange.rst new file mode 100644 index 0000000000..42e5732428 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-exchange.rst @@ -0,0 +1,48 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of exchange configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ceilometer_control_exchange`` = ``ceilometer`` + - (StrOpt) Exchange name for ceilometer notifications. + * - ``cinder_control_exchange`` = ``cinder`` + - (StrOpt) Exchange name for Cinder notifications. + * - ``dns_control_exchange`` = ``central`` + - (StrOpt) Exchange name for DNS notifications. + * - ``glance_control_exchange`` = ``glance`` + - (StrOpt) Exchange name for Glance notifications. + * - ``heat_control_exchange`` = ``heat`` + - (StrOpt) Exchange name for Heat notifications + * - ``http_control_exchanges`` = ``['nova', 'glance', 'neutron', 'cinder']`` + - (MultiStrOpt) Exchanges name to listen for notifications. + * - ``ironic_exchange`` = ``ironic`` + - (StrOpt) Exchange name for Ironic notifications. + * - ``keystone_control_exchange`` = ``keystone`` + - (StrOpt) Exchange name for Keystone notifications. + * - ``magnum_control_exchange`` = ``magnum`` + - (StrOpt) Exchange name for Magnum notifications. + * - ``neutron_control_exchange`` = ``neutron`` + - (StrOpt) Exchange name for Neutron notifications. + * - ``nova_control_exchange`` = ``nova`` + - (StrOpt) Exchange name for Nova notifications. + * - ``sahara_control_exchange`` = ``sahara`` + - (StrOpt) Exchange name for Data Processing notifications. + * - ``sample_source`` = ``openstack`` + - (StrOpt) Source for samples emitted on this instance. + * - ``swift_control_exchange`` = ``swift`` + - (StrOpt) Exchange name for Swift notifications. + * - ``trove_control_exchange`` = ``trove`` + - (StrOpt) Exchange name for DBaaS notifications. diff --git a/doc/config-ref-rst/source/tables/ceilometer-glance.rst b/doc/config-ref-rst/source/tables/ceilometer-glance.rst new file mode 100644 index 0000000000..ff9e392924 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-glance.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of glance configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``glance_page_size`` = ``0`` + - (IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used). diff --git a/doc/config-ref-rst/source/tables/ceilometer-inspector.rst b/doc/config-ref-rst/source/tables/ceilometer-inspector.rst new file mode 100644 index 0000000000..ef4c053aca --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-inspector.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of inspector configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hypervisor_inspector`` = ``libvirt`` + - (StrOpt) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm. + * - ``libvirt_type`` = ``kvm`` + - (StrOpt) Libvirt domain type. + * - ``libvirt_uri`` = ```` + - (StrOpt) Override the default libvirt URI (which is dependent on libvirt_type). diff --git a/doc/config-ref-rst/source/tables/ceilometer-ipmi.rst b/doc/config-ref-rst/source/tables/ceilometer-ipmi.rst new file mode 100644 index 0000000000..e83b2f20aa --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-ipmi.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IPMI configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ipmi]** + - + * - ``node_manager_init_retry`` = ``3`` + - (IntOpt) Number of retries upon Intel Node Manager initialization failure + * - ``polling_retry`` = ``3`` + - (IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever. diff --git a/doc/config-ref-rst/source/tables/ceilometer-logging.rst b/doc/config-ref-rst/source/tables/ceilometer-logging.rst new file mode 100644 index 0000000000..bbe00ece82 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/ceilometer-magnetodb.rst b/doc/config-ref-rst/source/tables/ceilometer-magnetodb.rst new file mode 100644 index 0000000000..ba99411232 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-magnetodb.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of MagnetoDB configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``magnetodb_control_exchange`` = ``magnetodb`` + - (StrOpt) Exchange name for Magnetodb notifications. diff --git a/doc/config-ref-rst/source/tables/ceilometer-notification.rst b/doc/config-ref-rst/source/tables/ceilometer-notification.rst new file mode 100644 index 0000000000..c87649745d --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-notification.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of notification configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[notification]** + - + * - ``disable_non_metric_meters`` = ``True`` + - (BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation. + * - ``pipeline_processing_queues`` = ``10`` + - (IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results. diff --git a/doc/config-ref-rst/source/tables/ceilometer-policy.rst b/doc/config-ref-rst/source/tables/ceilometer-policy.rst new file mode 100644 index 0000000000..3839d589e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-policy.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/ceilometer-qpid.rst b/doc/config-ref-rst/source/tables/ceilometer-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/ceilometer-rabbitmq.rst b/doc/config-ref-rst/source/tables/ceilometer-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/ceilometer-redis.rst b/doc/config-ref-rst/source/tables/ceilometer-redis.rst new file mode 100644 index 0000000000..75a290f1d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-redis.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/ceilometer-rgw.rst b/doc/config-ref-rst/source/tables/ceilometer-rgw.rst new file mode 100644 index 0000000000..8448900d7e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-rgw.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Rados gateway configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[rgw_admin_credentials]** + - + * - ``access_key`` = ``None`` + - (StrOpt) Access key for Radosgw Admin. + * - ``secret_key`` = ``None`` + - (StrOpt) Secret key for Radosgw Admin. diff --git a/doc/config-ref-rst/source/tables/ceilometer-rpc.rst b/doc/config-ref-rst/source/tables/ceilometer-rpc.rst new file mode 100644 index 0000000000..c9f7ab4856 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-rpc.rst @@ -0,0 +1,88 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[notification]** + - + * - ``messaging_urls`` = ``[]`` + - (MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty) + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication + * - **[publisher]** + - + * - ``telemetry_secret`` = ``change this for valid signing`` + - (StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead. + * - **[publisher_notifier]** + - + * - ``event_topic`` = ``event`` + - (StrOpt) The topic that ceilometer uses for event notifications. + * - ``metering_topic`` = ``metering`` + - (StrOpt) The topic that ceilometer uses for metering notifications. + * - ``telemetry_driver`` = ``messagingv2`` + - (StrOpt) The driver that ceilometer uses for metering notifications. + * - **[publisher_rpc]** + - + * - ``metering_topic`` = ``metering`` + - (StrOpt) The topic that ceilometer uses for metering messages. diff --git a/doc/config-ref-rst/source/tables/ceilometer-service_types.rst b/doc/config-ref-rst/source/tables/ceilometer-service_types.rst new file mode 100644 index 0000000000..2893090d3b --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-service_types.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of service types configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[service_types]** + - + * - ``glance`` = ``image`` + - (StrOpt) Glance service type. + * - ``kwapi`` = ``energy`` + - (StrOpt) Kwapi service type. + * - ``neutron`` = ``network`` + - (StrOpt) Neutron service type. + * - ``nova`` = ``compute`` + - (StrOpt) Nova service type. + * - ``radosgw`` = ``object-store`` + - (StrOpt) Radosgw service type. + * - ``swift`` = ``object-store`` + - (StrOpt) Swift service type. diff --git a/doc/config-ref-rst/source/tables/ceilometer-swift.rst b/doc/config-ref-rst/source/tables/ceilometer-swift.rst new file mode 100644 index 0000000000..07ad8606de --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-swift.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``reseller_prefix`` = ``AUTH_`` + - (StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf. diff --git a/doc/config-ref-rst/source/tables/ceilometer-tripleo.rst b/doc/config-ref-rst/source/tables/ceilometer-tripleo.rst new file mode 100644 index 0000000000..beea8153ad --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-tripleo.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of TripleO configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[hardware]** + - + * - ``meter_definitions_file`` = ``snmp.yaml`` + - (StrOpt) Configuration file for defining hardware snmp meters. + * - ``readonly_user_name`` = ``ro_snmp_user`` + - (StrOpt) SNMPd user name of all nodes running in the cloud. + * - ``readonly_user_password`` = ``password`` + - (StrOpt) SNMPd password of all the nodes running in the cloud. + * - ``url_scheme`` = ``snmp://`` + - (StrOpt) URL scheme to use for hardware nodes. diff --git a/doc/config-ref-rst/source/tables/ceilometer-vmware.rst b/doc/config-ref-rst/source/tables/ceilometer-vmware.rst new file mode 100644 index 0000000000..1dff226e68 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-vmware.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VMware configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vmware]** + - + * - ``api_retry_count`` = ``10`` + - (IntOpt) Number of times a VMware vSphere API may be retried. + * - ``ca_file`` = ``None`` + - (StrOpt) CA bundle file to use in verifying the vCenter server certificate. + * - ``host_ip`` = ```` + - (StrOpt) IP address of the VMware vSphere host. + * - ``host_password`` = ```` + - (StrOpt) Password of VMware vSphere. + * - ``host_port`` = ``443`` + - (PortOpt) Port of the VMware vSphere host. + * - ``host_username`` = ```` + - (StrOpt) Username of VMware vSphere. + * - ``insecure`` = ``False`` + - (BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set. + * - ``task_poll_interval`` = ``0.5`` + - (FloatOpt) Sleep time in seconds for polling an ongoing async task. + * - ``wsdl_location`` = ``None`` + - (StrOpt) Optional vim service WSDL location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. diff --git a/doc/config-ref-rst/source/tables/ceilometer-xenapi.rst b/doc/config-ref-rst/source/tables/ceilometer-xenapi.rst new file mode 100644 index 0000000000..2fb1ecda21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-xenapi.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of XenAPI configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[xenapi]** + - + * - ``connection_password`` = ``None`` + - (StrOpt) Password for connection to XenServer/Xen Cloud Platform. + * - ``connection_url`` = ``None`` + - (StrOpt) URL for connection to XenServer/Xen Cloud Platform. + * - ``connection_username`` = ``root`` + - (StrOpt) Username for connection to XenServer/Xen Cloud Platform. + * - ``login_timeout`` = ``10`` + - (IntOpt) Timeout in seconds for XenAPI login. diff --git a/doc/config-ref-rst/source/tables/ceilometer-zaqar.rst b/doc/config-ref-rst/source/tables/ceilometer-zaqar.rst new file mode 100644 index 0000000000..06835a290e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-zaqar.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Zaqar configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zaqar_control_exchange`` = ``zaqar`` + - (StrOpt) Exchange name for Messaging service notifications. diff --git a/doc/config-ref-rst/source/tables/ceilometer-zeromq.rst b/doc/config-ref-rst/source/tables/ceilometer-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ceilometer-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/cinder-amqp.rst b/doc/config-ref-rst/source/tables/cinder-amqp.rst new file mode 100644 index 0000000000..84ac08e209 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-amqp.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/cinder-api.rst b/doc/config-ref-rst/source/tables/cinder-api.rst new file mode 100644 index 0000000000..d78a67bfbf --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-api.rst @@ -0,0 +1,96 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``api_paste_config`` = ``api-paste.ini`` + - (StrOpt) File name for the paste.deploy config for cinder-api + * - ``api_rate_limit`` = ``True`` + - (BoolOpt) Enables or disables rate limit of the API. + * - ``az_cache_duration`` = ``3600`` + - (IntOpt) Cache volume availability zones in memory for the provided duration in seconds + * - ``backend_host`` = ``None`` + - (StrOpt) Backend override of host value. + * - ``default_timeout`` = ``525600`` + - (IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long. + * - ``enable_v1_api`` = ``True`` + - (BoolOpt) DEPRECATED: Deploy v1 of the Cinder API. + * - ``enable_v2_api`` = ``True`` + - (BoolOpt) Deploy v2 of the Cinder API. + * - ``extra_capabilities`` = ``{}`` + - (StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties. + * - ``ignore_pool_full_threshold`` = ``False`` + - (BoolOpt) Force LUN creation even if the full threshold of pool is reached. + * - ``management_ips`` = ```` + - (StrOpt) List of Management IP addresses (separated by commas) + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``osapi_max_limit`` = ``1000`` + - (IntOpt) The maximum number of items that a collection resource returns in a single response + * - ``osapi_max_request_body_size`` = ``114688`` + - (IntOpt) Max size for body of a request + * - ``osapi_volume_base_URL`` = ``None`` + - (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API + * - ``osapi_volume_ext_list`` = ```` + - (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions + * - ``osapi_volume_extension`` = ``['cinder.api.contrib.standard_extensions']`` + - (MultiStrOpt) osapi volume extension to load + * - ``osapi_volume_listen`` = ``0.0.0.0`` + - (StrOpt) IP address on which OpenStack Volume API listens + * - ``osapi_volume_listen_port`` = ``8776`` + - (PortOpt) Port on which OpenStack Volume API listens + * - ``osapi_volume_workers`` = ``None`` + - (IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``per_volume_size_limit`` = ``-1`` + - (IntOpt) Max size allowed per volume, in gigabytes + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - ``public_endpoint`` = ``None`` + - (StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL. + * - ``query_volume_filters`` = ``name, status, metadata, availability_zone`` + - (ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone'] + * - ``transfer_api_class`` = ``cinder.transfer.api.API`` + - (StrOpt) The full class name of the volume transfer API class + * - ``volume_api_class`` = ``cinder.volume.api.API`` + - (StrOpt) The full class name of the volume API class to use + * - ``volume_name_template`` = ``volume-%s`` + - (StrOpt) Template string to be used to generate volume names + * - ``volume_number_multiplier`` = ``-1.0`` + - (FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. + * - ``volume_transfer_key_length`` = ``16`` + - (IntOpt) The number of characters in the autogenerated auth key. + * - ``volume_transfer_salt_length`` = ``8`` + - (IntOpt) The number of characters in the salt. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. + * - **[oslo_versionedobjects]** + - + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal diff --git a/doc/config-ref-rst/source/tables/cinder-auth.rst b/doc/config-ref-rst/source/tables/cinder-auth.rst new file mode 100644 index 0000000000..469946e5d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-auth.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) The strategy to use for auth. Supports noauth or keystone. diff --git a/doc/config-ref-rst/source/tables/cinder-auth_token.rst b/doc/config-ref-rst/source/tables/cinder-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/cinder-backups.rst b/doc/config-ref-rst/source/tables/cinder-backups.rst new file mode 100644 index 0000000000..aaf486bfdc --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-backups.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of backups configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_api_class`` = ``cinder.backup.api.API`` + - (StrOpt) The full class name of the volume backup API class + * - ``backup_compression_algorithm`` = ``zlib`` + - (StrOpt) Compression algorithm (None to disable) + * - ``backup_driver`` = ``cinder.backup.drivers.swift`` + - (StrOpt) Driver to use for backups. + * - ``backup_manager`` = ``cinder.backup.manager.BackupManager`` + - (StrOpt) Full class name for the Manager for volume backup + * - ``backup_metadata_version`` = ``2`` + - (IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version. + * - ``backup_name_template`` = ``backup-%s`` + - (StrOpt) Template string to be used to generate backup names + * - ``backup_object_number_per_notification`` = ``10`` + - (IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent + * - ``backup_posix_path`` = ``$state_path/backup`` + - (StrOpt) Path specifying where to store backups. + * - ``backup_service_inithost_offload`` = ``False`` + - (BoolOpt) Offload pending backup delete during backup service startup. + * - ``backup_timer_interval`` = ``120`` + - (IntOpt) Interval, in seconds, between two progress notifications reporting the backup status + * - ``backup_topic`` = ``cinder-backup`` + - (StrOpt) The topic that volume backup nodes listen on + * - ``snapshot_name_template`` = ``snapshot-%s`` + - (StrOpt) Template string to be used to generate snapshot names + * - ``snapshot_same_host`` = ``True`` + - (BoolOpt) Create volume from snapshot at the host where snapshot resides diff --git a/doc/config-ref-rst/source/tables/cinder-backups_ceph.rst b/doc/config-ref-rst/source/tables/cinder-backups_ceph.rst new file mode 100644 index 0000000000..a30848bfe5 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-backups_ceph.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Ceph backup driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_ceph_chunk_size`` = ``134217728`` + - (IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. + * - ``backup_ceph_conf`` = ``/etc/ceph/ceph.conf`` + - (StrOpt) Ceph configuration file to use. + * - ``backup_ceph_pool`` = ``backups`` + - (StrOpt) The Ceph pool where volume backups are stored. + * - ``backup_ceph_stripe_count`` = ``0`` + - (IntOpt) RBD stripe count to use when creating a backup image. + * - ``backup_ceph_stripe_unit`` = ``0`` + - (IntOpt) RBD stripe unit to use when creating a backup image. + * - ``backup_ceph_user`` = ``cinder`` + - (StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None. + * - ``restore_discard_excess_bytes`` = ``True`` + - (BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. diff --git a/doc/config-ref-rst/source/tables/cinder-backups_nfs.rst b/doc/config-ref-rst/source/tables/cinder-backups_nfs.rst new file mode 100644 index 0000000000..05f091137f --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-backups_nfs.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NFS backup driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_container`` = ``None`` + - (StrOpt) Custom directory to use for backups. + * - ``backup_enable_progress_timer`` = ``True`` + - (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. + * - ``backup_file_size`` = ``1999994880`` + - (IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes. + * - ``backup_mount_options`` = ``None`` + - (StrOpt) Mount options passed to the NFS client. See NFS man page for details. + * - ``backup_mount_point_base`` = ``$state_path/backup_mount`` + - (StrOpt) Base dir containing mount point for NFS share. + * - ``backup_sha_block_size_bytes`` = ``32768`` + - (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. + * - ``backup_share`` = ``None`` + - (StrOpt) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format. diff --git a/doc/config-ref-rst/source/tables/cinder-backups_swift.rst b/doc/config-ref-rst/source/tables/cinder-backups_swift.rst new file mode 100644 index 0000000000..da1ddfe0a7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-backups_swift.rst @@ -0,0 +1,48 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Swift backup driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_swift_auth`` = ``per_user`` + - (StrOpt) Swift authentication mechanism + * - ``backup_swift_auth_version`` = ``1`` + - (StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 + * - ``backup_swift_block_size`` = ``32768`` + - (IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. + * - ``backup_swift_ca_cert_file`` = ``None`` + - (StrOpt) Location of the CA certificate file to use for swift client requests. + * - ``backup_swift_container`` = ``volumebackups`` + - (StrOpt) The default Swift container to use + * - ``backup_swift_enable_progress_timer`` = ``True`` + - (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. + * - ``backup_swift_key`` = ``None`` + - (StrOpt) Swift key for authentication + * - ``backup_swift_object_size`` = ``52428800`` + - (IntOpt) The size in bytes of Swift backup objects + * - ``backup_swift_retry_attempts`` = ``3`` + - (IntOpt) The number of retries to make for Swift operations + * - ``backup_swift_retry_backoff`` = ``2`` + - (IntOpt) The backoff time in seconds between Swift retries + * - ``backup_swift_tenant`` = ``None`` + - (StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system + * - ``backup_swift_url`` = ``None`` + - (StrOpt) The URL of the Swift endpoint + * - ``backup_swift_user`` = ``None`` + - (StrOpt) Swift user name + * - ``keystone_catalog_info`` = ``identity:Identity Service:publicURL`` + - (StrOpt) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: :: - Only used if backup_swift_auth_url is unset + * - ``swift_catalog_info`` = ``object-store:swift:publicURL`` + - (StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: :: - Only used if backup_swift_url is unset diff --git a/doc/config-ref-rst/source/tables/cinder-backups_tsm.rst b/doc/config-ref-rst/source/tables/cinder-backups_tsm.rst new file mode 100644 index 0000000000..9257b93132 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-backups_tsm.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM Tivoli Storage Manager backup driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_tsm_compression`` = ``True`` + - (BoolOpt) Enable or Disable compression for backups + * - ``backup_tsm_password`` = ``password`` + - (StrOpt) TSM password for the running username + * - ``backup_tsm_volume_prefix`` = ``backup`` + - (StrOpt) Volume prefix for the backup id when backing up to TSM diff --git a/doc/config-ref-rst/source/tables/cinder-block-device.rst b/doc/config-ref-rst/source/tables/cinder-block-device.rst new file mode 100644 index 0000000000..3263384d3d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-block-device.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of block device configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``available_devices`` = ```` + - (ListOpt) List of all available devices diff --git a/doc/config-ref-rst/source/tables/cinder-blockbridge.rst b/doc/config-ref-rst/source/tables/cinder-blockbridge.rst new file mode 100644 index 0000000000..2d60d6bcb7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-blockbridge.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of BlockBridge EPS volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``blockbridge_api_host`` = ``None`` + - (StrOpt) IP address/hostname of Blockbridge API. + * - ``blockbridge_api_port`` = ``None`` + - (IntOpt) Override HTTPS port to connect to Blockbridge API server. + * - ``blockbridge_auth_password`` = ``None`` + - (StrOpt) Blockbridge API password (for auth scheme 'password') + * - ``blockbridge_auth_scheme`` = ``token`` + - (StrOpt) Blockbridge API authentication scheme (token or password) + * - ``blockbridge_auth_token`` = ``None`` + - (StrOpt) Blockbridge API token (for auth scheme 'token') + * - ``blockbridge_auth_user`` = ``None`` + - (StrOpt) Blockbridge API user (for auth scheme 'password') + * - ``blockbridge_default_pool`` = ``None`` + - (StrOpt) Default pool name if unspecified. + * - ``blockbridge_pools`` = ``{'OpenStack': '+openstack'}`` + - (DictOpt) Defines the set of exposed pools and their associated backend query strings diff --git a/doc/config-ref-rst/source/tables/cinder-ca.rst b/doc/config-ref-rst/source/tables/cinder-ca.rst new file mode 100644 index 0000000000..9e39c31081 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-ca.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CA and SSL configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ssl_ca_file`` = ``None`` + - (StrOpt) CA certificate file to use to verify connecting clients + * - ``ssl_cert_file`` = ``None`` + - (StrOpt) Certificate file to use when starting the server securely + * - ``ssl_key_file`` = ``None`` + - (StrOpt) Private key file to use when starting the server securely diff --git a/doc/config-ref-rst/source/tables/cinder-cloudbyte.rst b/doc/config-ref-rst/source/tables/cinder-cloudbyte.rst new file mode 100644 index 0000000000..f71f07f2ee --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-cloudbyte.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CloudByte volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cb_account_name`` = ``None`` + - (StrOpt) CloudByte storage specific account name. This maps to a project name in OpenStack. + * - ``cb_add_qosgroup`` = ``{'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}`` + - (DictOpt) These values will be used for CloudByte storage's addQos API call. + * - ``cb_apikey`` = ``None`` + - (StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface. + * - ``cb_auth_group`` = ``None`` + - (StrOpt) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None. + * - ``cb_confirm_volume_create_retries`` = ``3`` + - (IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts. + * - ``cb_confirm_volume_create_retry_interval`` = ``5`` + - (IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage. + * - ``cb_confirm_volume_delete_retries`` = ``3`` + - (IntOpt) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts. + * - ``cb_confirm_volume_delete_retry_interval`` = ``5`` + - (IntOpt) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage. + * - ``cb_create_volume`` = ``{'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}`` + - (DictOpt) These values will be used for CloudByte storage's createVolume API call. + * - ``cb_tsm_name`` = ``None`` + - (StrOpt) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM. + * - ``cb_update_file_system`` = ``compression, sync, noofcopies, readonly`` + - (ListOpt) These values will be used for CloudByte storage's updateFileSystem API call. + * - ``cb_update_qos_group`` = ``iops, latency, graceallowed`` + - (ListOpt) These values will be used for CloudByte storage's updateQosGroup API call. diff --git a/doc/config-ref-rst/source/tables/cinder-common.rst b/doc/config-ref-rst/source/tables/cinder-common.rst new file mode 100644 index 0000000000..239a18c40a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-common.rst @@ -0,0 +1,136 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allow_availability_zone_fallback`` = ``False`` + - (BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. + * - ``chap_password`` = ```` + - (StrOpt) Password for specified CHAP account name. + * - ``chap_username`` = ```` + - (StrOpt) CHAP user name. + * - ``chiscsi_conf`` = ``/etc/chelsio-iscsi/chiscsi.conf`` + - (StrOpt) Chiscsi (CXT) global defaults configuration file + * - ``cinder_internal_tenant_project_id`` = ``None`` + - (StrOpt) ID of the project which will be used as the Cinder internal tenant. + * - ``cinder_internal_tenant_user_id`` = ``None`` + - (StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant. + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + * - ``compute_api_class`` = ``cinder.compute.nova.API`` + - (StrOpt) The full class name of the compute API class to use + * - ``consistencygroup_api_class`` = ``cinder.consistencygroup.api.API`` + - (StrOpt) The full class name of the consistencygroup API class + * - ``default_availability_zone`` = ``None`` + - (StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. + * - ``default_volume_type`` = ``None`` + - (StrOpt) Default volume type to use + * - ``driver_data_namespace`` = ``None`` + - (StrOpt) Namespace for driver private data values to be saved in. + * - ``driver_ssl_cert_verify`` = ``False`` + - (BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint. + * - ``enable_force_upload`` = ``False`` + - (BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. + * - ``enable_new_services`` = ``True`` + - (BoolOpt) Services to be added to the available pool on create + * - ``end_time`` = ``None`` + - (StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period. + * - ``enforce_multipath_for_image_xfer`` = ``False`` + - (BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``host`` = ``localhost`` + - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. + * - ``iet_conf`` = ``/etc/iet/ietd.conf`` + - (StrOpt) IET configuration file + * - ``iscsi_secondary_ip_addresses`` = ```` + - (ListOpt) The list of secondary IP addresses of the iSCSI daemon + * - ``max_over_subscription_ratio`` = ``20.0`` + - (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``monkey_patch`` = ``False`` + - (BoolOpt) Enable monkey patching + * - ``monkey_patch_modules`` = ```` + - (ListOpt) List of modules/decorators to monkey patch + * - ``my_ip`` = ``10.0.0.1`` + - (StrOpt) IP address of this host + * - ``no_snapshot_gb_quota`` = ``False`` + - (BoolOpt) Whether snapshots count against gigabyte quota + * - ``num_shell_tries`` = ``3`` + - (IntOpt) Number of times to attempt to run flakey shell commands + * - ``os_privileged_user_auth_url`` = ``None`` + - (StrOpt) Auth URL associated with the OpenStack privileged account. + * - ``os_privileged_user_name`` = ``None`` + - (StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights. + * - ``os_privileged_user_password`` = ``None`` + - (StrOpt) Password associated with the OpenStack privileged account. + * - ``os_privileged_user_tenant`` = ``None`` + - (StrOpt) Tenant name associated with the OpenStack privileged account. + * - ``periodic_fuzzy_delay`` = ``60`` + - (IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + * - ``periodic_interval`` = ``60`` + - (IntOpt) Interval, in seconds, between running periodic tasks + * - ``replication_api_class`` = ``cinder.replication.api.API`` + - (StrOpt) The full class name of the volume replication API class + * - ``replication_device`` = ``None`` + - (MultiOpt) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = device_target_id:,managed_backend_name:,key1:value1,key2:value2... + * - ``report_interval`` = ``10`` + - (IntOpt) Interval, in seconds, between nodes reporting state to datastore + * - ``request_timeout`` = ``300`` + - (IntOpt) Global backend request timeout, in seconds + * - ``reserved_percentage`` = ``0`` + - (IntOpt) The percentage of backend capacity is reserved + * - ``rootwrap_config`` = ``/etc/cinder/rootwrap.conf`` + - (StrOpt) Path to the rootwrap configuration file to use for running commands as root + * - ``send_actions`` = ``False`` + - (BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period. + * - ``service_down_time`` = ``60`` + - (IntOpt) Maximum time since last check-in for a service to be considered up + * - ``sqlite_clean_db`` = ``clean.sqlite`` + - (StrOpt) File name of clean sqlite db + * - ``ssh_hosts_key_file`` = ``$state_path/ssh_known_hosts`` + - (StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts + * - ``start_time`` = ``None`` + - (StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period. + * - ``state_path`` = ``/var/lib/cinder`` + - (StrOpt) Top-level directory for maintaining cinder's state + * - ``storage_availability_zone`` = ``nova`` + - (StrOpt) Availability zone of this node + * - ``strict_ssh_host_key_policy`` = ``False`` + - (BoolOpt) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False + * - ``tcp_keepalive`` = ``True`` + - (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. + * - ``tcp_keepalive_count`` = ``None`` + - (IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. + * - ``tcp_keepalive_interval`` = ``None`` + - (IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + * - ``until_refresh`` = ``0`` + - (IntOpt) Count of reservations until usage is refreshed + * - ``use_chap_auth`` = ``False`` + - (BoolOpt) Option to enable/disable CHAP authentication for targets. + * - ``use_forwarded_for`` = ``False`` + - (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. + * - ``wsgi_keep_alive`` = ``True`` + - (BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. diff --git a/doc/config-ref-rst/source/tables/cinder-compute.rst b/doc/config-ref-rst/source/tables/cinder-compute.rst new file mode 100644 index 0000000000..1f53bfe76b --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-compute.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Compute configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nova_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to nova + * - ``nova_ca_certificates_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for nova client requests. + * - ``nova_catalog_admin_info`` = ``compute:Compute Service:adminURL`` + - (StrOpt) Same as nova_catalog_info, but for admin endpoint. + * - ``nova_catalog_info`` = ``compute:Compute Service:publicURL`` + - (StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: :: + * - ``nova_endpoint_admin_template`` = ``None`` + - (StrOpt) Same as nova_endpoint_template, but for admin endpoint. + * - ``nova_endpoint_template`` = ``None`` + - (StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name of this node diff --git a/doc/config-ref-rst/source/tables/cinder-cors.rst b/doc/config-ref-rst/source/tables/cinder-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/cinder-database.rst b/doc/config-ref-rst/source/tables/cinder-database.rst new file mode 100644 index 0000000000..70f75f350f --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-database.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``db_driver`` = ``cinder.db`` + - (StrOpt) Driver to use for database access + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. + * - ``use_tpool`` = ``False`` + - (BoolOpt) Enable the experimental use of thread pooling for all DB API calls diff --git a/doc/config-ref-rst/source/tables/cinder-datera.rst b/doc/config-ref-rst/source/tables/cinder-datera.rst new file mode 100644 index 0000000000..8ecc4784c9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-datera.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Datera volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``datera_api_port`` = ``7717`` + - (StrOpt) Datera API port. + * - ``datera_api_token`` = ``None`` + - (StrOpt) DEPRECATED: This will be removed in the Liberty release. Use san_login and san_password instead. This directly sets the Datera API token. + * - ``datera_api_version`` = ``1`` + - (StrOpt) Datera API version. + * - ``datera_num_replicas`` = ``3`` + - (StrOpt) Number of replicas to create of an inode. + * - ``driver_client_cert`` = ``None`` + - (StrOpt) The path to the client certificate for verification, if the driver supports it. + * - ``driver_client_cert_key`` = ``None`` + - (StrOpt) The path to the client certificate key for verification, if the driver supports it. diff --git a/doc/config-ref-rst/source/tables/cinder-debug.rst b/doc/config-ref-rst/source/tables/cinder-debug.rst new file mode 100644 index 0000000000..c4b7a9cc7c --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-debug.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``trace_flags`` = ``None`` + - (ListOpt) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. diff --git a/doc/config-ref-rst/source/tables/cinder-dellsc.rst b/doc/config-ref-rst/source/tables/cinder-dellsc.rst new file mode 100644 index 0000000000..fefb68a477 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-dellsc.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Dell Storage Center volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``dell_sc_api_port`` = ``3033`` + - (PortOpt) Dell API port + * - ``dell_sc_server_folder`` = ``openstack`` + - (StrOpt) Name of the server folder to use on the Storage Center + * - ``dell_sc_ssn`` = ``64702`` + - (IntOpt) Storage Center System Serial Number + * - ``dell_sc_verify_cert`` = ``False`` + - (BoolOpt) Enable HTTPS SC certificate verification. + * - ``dell_sc_volume_folder`` = ``openstack`` + - (StrOpt) Name of the volume folder to use on the Storage Center diff --git a/doc/config-ref-rst/source/tables/cinder-dothill.rst b/doc/config-ref-rst/source/tables/cinder-dothill.rst new file mode 100644 index 0000000000..5f97b35de6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-dothill.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Dot Hill volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``dothill_api_protocol`` = ``https`` + - (StrOpt) DotHill API interface protocol. + * - ``dothill_backend_name`` = ``A`` + - (StrOpt) Pool or Vdisk name to use for volume creation. + * - ``dothill_backend_type`` = ``virtual`` + - (StrOpt) linear (for Vdisk) or virtual (for Pool). + * - ``dothill_iscsi_ips`` = ```` + - (ListOpt) List of comma-separated target iSCSI IP addresses. + * - ``dothill_verify_certificate`` = ``False`` + - (BoolOpt) Whether to verify DotHill array SSL certificate. + * - ``dothill_verify_certificate_path`` = ``None`` + - (StrOpt) DotHill array SSL certificate path. diff --git a/doc/config-ref-rst/source/tables/cinder-drbd.rst b/doc/config-ref-rst/source/tables/cinder-drbd.rst new file mode 100644 index 0000000000..4b2fd9c5cd --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-drbd.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of DRBD configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``drbdmanage_devs_on_controller`` = ``True`` + - (BoolOpt) If set, the c-vol node will receive a useable + /dev/drbdX device, even if the actual data is stored on + other nodes only. + This is useful for debugging, maintenance, and to be + able to do the iSCSI export from the c-vol node. + * - ``drbdmanage_redundancy`` = ``1`` + - (StrOpt) Number of nodes that should replicate the data. diff --git a/doc/config-ref-rst/source/tables/cinder-emc.rst b/doc/config-ref-rst/source/tables/cinder-emc.rst new file mode 100644 index 0000000000..5b3d63b02d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-emc.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of EMC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``check_max_pool_luns_threshold`` = ``False`` + - (BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. + * - ``cinder_emc_config_file`` = ``/etc/cinder/cinder_emc_config.xml`` + - (StrOpt) use this file for cinder emc plugin config data + * - ``destroy_empty_storage_group`` = ``False`` + - (BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False. + * - ``force_delete_lun_in_storagegroup`` = ``False`` + - (BoolOpt) Delete a LUN even if it is in Storage Groups. + * - ``initiator_auto_deregistration`` = ``False`` + - (BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. + * - ``initiator_auto_registration`` = ``False`` + - (BoolOpt) Automatically register initiators. By default, the value is False. + * - ``io_port_list`` = ``*`` + - (StrOpt) Comma separated iSCSI or FC ports to be used in Nova or Cinder. + * - ``iscsi_initiators`` = ```` + - (StrOpt) Mapping between hostname and its iSCSI initiator IP addresses. + * - ``max_luns_per_storage_group`` = ``255`` + - (IntOpt) Default max number of LUNs in a storage group. By default, the value is 255. + * - ``naviseccli_path`` = ```` + - (StrOpt) Naviseccli Path. + * - ``storage_vnx_authentication_type`` = ``global`` + - (StrOpt) VNX authentication scope type. + * - ``storage_vnx_pool_names`` = ``None`` + - (StrOpt) Comma-separated list of storage pool names to be used. + * - ``storage_vnx_security_file_dir`` = ``None`` + - (StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first. + * - ``xtremio_array_busy_retry_count`` = ``5`` + - (IntOpt) Number of retries in case array is busy + * - ``xtremio_array_busy_retry_interval`` = ``5`` + - (IntOpt) Interval between retries in case array is busy + * - ``xtremio_cluster_name`` = ```` + - (StrOpt) XMS cluster id in multi-cluster environment diff --git a/doc/config-ref-rst/source/tables/cinder-emc_sio.rst b/doc/config-ref-rst/source/tables/cinder-emc_sio.rst new file mode 100644 index 0000000000..861902716f --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-emc_sio.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of EMC SIO volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``sio_force_delete`` = ``False`` + - (BoolOpt) Whether to allow force delete. + * - ``sio_protection_domain_id`` = ``None`` + - (StrOpt) Protection domain id. + * - ``sio_protection_domain_name`` = ``None`` + - (StrOpt) Protection domain name. + * - ``sio_rest_server_port`` = ``443`` + - (StrOpt) REST server port. + * - ``sio_round_volume_capacity`` = ``True`` + - (BoolOpt) Whether to round volume capacity. + * - ``sio_server_certificate_path`` = ``None`` + - (StrOpt) Server certificate path. + * - ``sio_storage_pool_id`` = ``None`` + - (StrOpt) Storage pool id. + * - ``sio_storage_pool_name`` = ``None`` + - (StrOpt) Storage pool name. + * - ``sio_storage_pools`` = ``None`` + - (StrOpt) Storage pools. + * - ``sio_unmap_volume_before_deletion`` = ``False`` + - (BoolOpt) Whether to unmap volume before deletion. + * - ``sio_verify_server_certificate`` = ``False`` + - (BoolOpt) Whether to verify server certificate. diff --git a/doc/config-ref-rst/source/tables/cinder-eqlx.rst b/doc/config-ref-rst/source/tables/cinder-eqlx.rst new file mode 100644 index 0000000000..3819736bf7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-eqlx.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Dell EqualLogic volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``eqlx_chap_login`` = ``admin`` + - (StrOpt) Existing CHAP account name. Note that this option is deprecated in favour of "chap_username" as specified in cinder/volume/driver.py and will be removed in next release. + * - ``eqlx_chap_password`` = ``password`` + - (StrOpt) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release + * - ``eqlx_cli_max_retries`` = ``5`` + - (IntOpt) Maximum retry count for reconnection. Default is 5. + * - ``eqlx_cli_timeout`` = ``30`` + - (IntOpt) Timeout for the Group Manager cli command execution. Default is 30. Note that this option is deprecated in favour of "ssh_conn_timeout" as specified in cinder/volume/drivers/san/san.py and will be removed in M release. + * - ``eqlx_group_name`` = ``group-0`` + - (StrOpt) Group name to use for creating volumes. Defaults to "group-0". + * - ``eqlx_pool`` = ``default`` + - (StrOpt) Pool in which volumes will be created. Defaults to "default". + * - ``eqlx_use_chap`` = ``False`` + - (BoolOpt) Use CHAP authentication for targets. Note that this option is deprecated in favour of "use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release. diff --git a/doc/config-ref-rst/source/tables/cinder-flashsystem.rst b/doc/config-ref-rst/source/tables/cinder-flashsystem.rst new file mode 100644 index 0000000000..d8e93375d1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-flashsystem.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM FlashSystem volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``flashsystem_connection_protocol`` = ``FC`` + - (StrOpt) Connection protocol should be FC. (Default is FC.) + * - ``flashsystem_iscsi_portid`` = ``0`` + - (IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.) + * - ``flashsystem_multihostmap_enabled`` = ``True`` + - (BoolOpt) Allows vdisk to multi host mapping. (Default is True) + * - ``flashsystem_multipath_enabled`` = ``False`` + - (BoolOpt) Connect with multipath (FC only).(Default is false.) diff --git a/doc/config-ref-rst/source/tables/cinder-hds-hnas.rst b/doc/config-ref-rst/source/tables/cinder-hds-hnas.rst new file mode 100644 index 0000000000..6cf9886d7d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hds-hnas.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HDS HNAS iSCSI and NFS driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hds_hnas_iscsi_config_file`` = ``/opt/hds/hnas/cinder_iscsi_conf.xml`` + - (StrOpt) Configuration file for HDS iSCSI cinder plugin + * - ``hds_hnas_nfs_config_file`` = ``/opt/hds/hnas/cinder_nfs_conf.xml`` + - (StrOpt) Configuration file for HDS NFS cinder plugin diff --git a/doc/config-ref-rst/source/tables/cinder-hgst.rst b/doc/config-ref-rst/source/tables/cinder-hgst.rst new file mode 100644 index 0000000000..5f03b25e51 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hgst.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HGST volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hgst_net`` = ``Net 1 (IPv4)`` + - (StrOpt) Space network name to use for data transfer + * - ``hgst_redundancy`` = ``0`` + - (StrOpt) Should spaces be redundantly stored (1/0) + * - ``hgst_space_group`` = ``disk`` + - (StrOpt) Group to own created spaces + * - ``hgst_space_mode`` = ``0600`` + - (StrOpt) UNIX mode for created spaces + * - ``hgst_space_user`` = ``root`` + - (StrOpt) User to own created spaces + * - ``hgst_storage_servers`` = ``os:gbd0`` + - (StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0 diff --git a/doc/config-ref-rst/source/tables/cinder-hitachi-hbsd.rst b/doc/config-ref-rst/source/tables/cinder-hitachi-hbsd.rst new file mode 100644 index 0000000000..d6e12a090a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hitachi-hbsd.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Hitachi storage volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hitachi_add_chap_user`` = ``False`` + - (BoolOpt) Add CHAP user + * - ``hitachi_async_copy_check_interval`` = ``10`` + - (IntOpt) Interval to check copy asynchronously + * - ``hitachi_auth_method`` = ``None`` + - (StrOpt) iSCSI authentication method + * - ``hitachi_auth_password`` = ``HBSD-CHAP-password`` + - (StrOpt) iSCSI authentication password + * - ``hitachi_auth_user`` = ``HBSD-CHAP-user`` + - (StrOpt) iSCSI authentication username + * - ``hitachi_copy_check_interval`` = ``3`` + - (IntOpt) Interval to check copy + * - ``hitachi_copy_speed`` = ``3`` + - (IntOpt) Copy speed of storage system + * - ``hitachi_default_copy_method`` = ``FULL`` + - (StrOpt) Default copy method of storage system + * - ``hitachi_group_range`` = ``None`` + - (StrOpt) Range of group number + * - ``hitachi_group_request`` = ``False`` + - (BoolOpt) Request for creating HostGroup or iSCSI Target + * - ``hitachi_horcm_add_conf`` = ``True`` + - (BoolOpt) Add to HORCM configuration + * - ``hitachi_horcm_numbers`` = ``200,201`` + - (StrOpt) Instance numbers for HORCM + * - ``hitachi_horcm_password`` = ``None`` + - (StrOpt) Password of storage system for HORCM + * - ``hitachi_horcm_resource_lock_timeout`` = ``600`` + - (IntOpt) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200. + * - ``hitachi_horcm_user`` = ``None`` + - (StrOpt) Username of storage system for HORCM + * - ``hitachi_ldev_range`` = ``None`` + - (StrOpt) Range of logical device of storage system + * - ``hitachi_pool_id`` = ``None`` + - (IntOpt) Pool ID of storage system + * - ``hitachi_serial_number`` = ``None`` + - (StrOpt) Serial number of storage system + * - ``hitachi_target_ports`` = ``None`` + - (StrOpt) Control port names for HostGroup or iSCSI Target + * - ``hitachi_thin_pool_id`` = ``None`` + - (IntOpt) Thin pool ID of storage system + * - ``hitachi_unit_name`` = ``None`` + - (StrOpt) Name of an array unit + * - ``hitachi_zoning_request`` = ``False`` + - (BoolOpt) Request for FC Zone creating HostGroup diff --git a/doc/config-ref-rst/source/tables/cinder-hpe3par.rst b/doc/config-ref-rst/source/tables/cinder-hpe3par.rst new file mode 100644 index 0000000000..36723f9b1a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hpe3par.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HPE 3PAR Fibre Channel and iSCSI drivers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hpe3par_api_url`` = ```` + - (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 + * - ``hpe3par_cpg`` = ``OpenStack`` + - (ListOpt) List of the CPG(s) to use for volume creation + * - ``hpe3par_cpg_snap`` = ```` + - (StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used. + * - ``hpe3par_debug`` = ``False`` + - (BoolOpt) Enable HTTP debugging to 3PAR + * - ``hpe3par_iscsi_chap_enabled`` = ``False`` + - (BoolOpt) Enable CHAP authentication for iSCSI connections. + * - ``hpe3par_iscsi_ips`` = ```` + - (ListOpt) List of target iSCSI addresses to use. + * - ``hpe3par_password`` = ```` + - (StrOpt) 3PAR password for the user specified in hpe3par_username + * - ``hpe3par_snapshot_expiration`` = ```` + - (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration + * - ``hpe3par_snapshot_retention`` = ```` + - (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires. + * - ``hpe3par_username`` = ```` + - (StrOpt) 3PAR username with the 'edit' role diff --git a/doc/config-ref-rst/source/tables/cinder-hplefthand.rst b/doc/config-ref-rst/source/tables/cinder-hplefthand.rst new file mode 100644 index 0000000000..d8a8fe7bbc --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hplefthand.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HP LeftHand/StoreVirtual driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hplefthand_api_url`` = ``None`` + - (StrOpt) HP LeftHand WSAPI Server Url like https://:8081/lhos + * - ``hplefthand_clustername`` = ``None`` + - (StrOpt) HP LeftHand cluster name + * - ``hplefthand_debug`` = ``False`` + - (BoolOpt) Enable HTTP debugging to LeftHand + * - ``hplefthand_iscsi_chap_enabled`` = ``False`` + - (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled) + * - ``hplefthand_password`` = ``None`` + - (StrOpt) HP LeftHand Super user password + * - ``hplefthand_username`` = ``None`` + - (StrOpt) HP LeftHand Super user username diff --git a/doc/config-ref-rst/source/tables/cinder-hpmsa.rst b/doc/config-ref-rst/source/tables/cinder-hpmsa.rst new file mode 100644 index 0000000000..9764d507af --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hpmsa.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HP MSA volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hpmsa_api_protocol`` = ``https`` + - (StrOpt) HPMSA API interface protocol. + * - ``hpmsa_backend_name`` = ``A`` + - (StrOpt) Pool or Vdisk name to use for volume creation. + * - ``hpmsa_backend_type`` = ``virtual`` + - (StrOpt) linear (for Vdisk) or virtual (for Pool). + * - ``hpmsa_iscsi_ips`` = ```` + - (ListOpt) List of comma-separated target iSCSI IP addresses. + * - ``hpmsa_verify_certificate`` = ``False`` + - (BoolOpt) Whether to verify HPMSA array SSL certificate. + * - ``hpmsa_verify_certificate_path`` = ``None`` + - (StrOpt) HPMSA array SSL certificate path. diff --git a/doc/config-ref-rst/source/tables/cinder-hpxp.rst b/doc/config-ref-rst/source/tables/cinder-hpxp.rst new file mode 100644 index 0000000000..471cd7b5a1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-hpxp.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HP XP volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hpxp_async_copy_check_interval`` = ``10`` + - (IntOpt) Interval to check copy asynchronously + * - ``hpxp_compute_target_ports`` = ``None`` + - (ListOpt) Target port names of compute node for host group or iSCSI target + * - ``hpxp_copy_check_interval`` = ``3`` + - (IntOpt) Interval to check copy + * - ``hpxp_copy_speed`` = ``3`` + - (IntOpt) Copy speed of storage system + * - ``hpxp_default_copy_method`` = ``FULL`` + - (StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL" + * - ``hpxp_group_request`` = ``False`` + - (BoolOpt) Request for creating host group or iSCSI target + * - ``hpxp_horcm_add_conf`` = ``True`` + - (BoolOpt) Add to HORCM configuration + * - ``hpxp_horcm_name_only_discovery`` = ``False`` + - (BoolOpt) Only discover a specific name of host group or iSCSI target + * - ``hpxp_horcm_numbers`` = ``200, 201`` + - (ListOpt) Instance numbers for HORCM + * - ``hpxp_horcm_resource_name`` = ``meta_resource`` + - (StrOpt) Resource group name of storage system for HORCM + * - ``hpxp_horcm_user`` = ``None`` + - (StrOpt) Username of storage system for HORCM + * - ``hpxp_ldev_range`` = ``None`` + - (StrOpt) Logical device range of storage system + * - ``hpxp_pool`` = ``None`` + - (StrOpt) Pool of storage system + * - ``hpxp_storage_cli`` = ``None`` + - (StrOpt) Type of storage command line interface + * - ``hpxp_storage_id`` = ``None`` + - (StrOpt) ID of storage system + * - ``hpxp_target_ports`` = ``None`` + - (ListOpt) Target port names for host group or iSCSI target + * - ``hpxp_thin_pool`` = ``None`` + - (StrOpt) Thin pool of storage system + * - ``hpxp_zoning_request`` = ``False`` + - (BoolOpt) Request for FC Zone creating host group diff --git a/doc/config-ref-rst/source/tables/cinder-huawei.rst b/doc/config-ref-rst/source/tables/cinder-huawei.rst new file mode 100644 index 0000000000..c9b4ad5f52 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-huawei.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Huawei storage driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cinder_huawei_conf_file`` = ``/etc/cinder/cinder_huawei_conf.xml`` + - (StrOpt) The configuration file for the Cinder Huawei driver. + * - ``hypermetro_devices`` = ``None`` + - (StrOpt) The remote device hypermetro will use. diff --git a/doc/config-ref-rst/source/tables/cinder-ibmnas.rst b/doc/config-ref-rst/source/tables/cinder-ibmnas.rst new file mode 100644 index 0000000000..e5c760a745 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-ibmnas.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM SONAS and Storwise V7000 volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ibmnas_platform_type`` = ``v7ku`` + - (StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments. + * - ``nas_ip`` = ```` + - (StrOpt) IP address or Hostname of NAS system. + * - ``nas_login`` = ``admin`` + - (StrOpt) User name to connect to NAS system. + * - ``nas_mount_options`` = ``None`` + - (StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored. + * - ``nas_password`` = ```` + - (StrOpt) Password to connect to NAS system. + * - ``nas_private_key`` = ```` + - (StrOpt) Filename of private key to use for SSH authentication. + * - ``nas_secure_file_operations`` = ``auto`` + - (StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. + * - ``nas_secure_file_permissions`` = ``auto`` + - (StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. + * - ``nas_share_path`` = ```` + - (StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 . + * - ``nas_ssh_port`` = ``22`` + - (PortOpt) SSH port to use to connect to NAS system. diff --git a/doc/config-ref-rst/source/tables/cinder-images.rst b/doc/config-ref-rst/source/tables/cinder-images.rst new file mode 100644 index 0000000000..9bc97dfc03 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-images.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of images configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allowed_direct_url_schemes`` = ```` + - (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + * - ``glance_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL (https) requests to glance + * - ``glance_api_servers`` = ``$glance_host:$glance_port`` + - (ListOpt) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. + * - ``glance_api_ssl_compression`` = ``False`` + - (BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2. + * - ``glance_api_version`` = ``1`` + - (IntOpt) Version of the glance API to use + * - ``glance_ca_certificates_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for glance client requests. + * - ``glance_core_properties`` = ``checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size`` + - (ListOpt) Default core properties of image + * - ``glance_host`` = ``$my_ip`` + - (StrOpt) Default glance host name or IP + * - ``glance_num_retries`` = ``0`` + - (IntOpt) Number retries when downloading an image from glance + * - ``glance_port`` = ``9292`` + - (IntOpt) Default glance port + * - ``glance_request_timeout`` = ``None`` + - (IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. + * - ``image_conversion_dir`` = ``$state_path/conversion`` + - (StrOpt) Directory used for temporary storage during image conversion + * - ``image_upload_use_cinder_backend`` = ``False`` + - (BoolOpt) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2. + * - ``image_upload_use_internal_tenant`` = ``False`` + - (BoolOpt) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context's tenant. + * - ``image_volume_cache_enabled`` = ``False`` + - (BoolOpt) Enable the image volume cache for this backend. + * - ``image_volume_cache_max_count`` = ``0`` + - (IntOpt) Max number of entries allowed in the image volume cache. 0 => unlimited. + * - ``image_volume_cache_max_size_gb`` = ``0`` + - (IntOpt) Max size of the image volume cache for this backend in GB. 0 => unlimited. + * - ``use_multipath_for_image_xfer`` = ``False`` + - (BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? diff --git a/doc/config-ref-rst/source/tables/cinder-infortrend.rst b/doc/config-ref-rst/source/tables/cinder-infortrend.rst new file mode 100644 index 0000000000..a63e3c6925 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-infortrend.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Infortrend volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``infortrend_cli_max_retries`` = ``5`` + - (IntOpt) Maximum retry time for cli. Default is 5. + * - ``infortrend_cli_path`` = ``/opt/bin/Infortrend/raidcmd_ESDS10.jar`` + - (StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar + * - ``infortrend_cli_timeout`` = ``30`` + - (IntOpt) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes. + * - ``infortrend_pools_name`` = ```` + - (StrOpt) Infortrend raid pool name list. It is separated with comma. + * - ``infortrend_provisioning`` = ``full`` + - (StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. + * - ``infortrend_slots_a_channels_id`` = ``0,1,2,3,4,5,6,7`` + - (StrOpt) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. + * - ``infortrend_slots_b_channels_id`` = ``0,1,2,3,4,5,6,7`` + - (StrOpt) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. + * - ``infortrend_tiering`` = ``0`` + - (StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. diff --git a/doc/config-ref-rst/source/tables/cinder-keymgr.rst b/doc/config-ref-rst/source/tables/cinder-keymgr.rst new file mode 100644 index 0000000000..a0d298dc2d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-keymgr.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of key manager configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keymgr]** + - + * - ``api_class`` = ``cinder.keymgr.conf_key_mgr.ConfKeyManager`` + - (StrOpt) The full class name of the key manager API class + * - ``encryption_api_url`` = ``http://localhost:9311/v1`` + - (StrOpt) Url for encryption service. + * - ``encryption_auth_url`` = ``http://localhost:5000/v3`` + - (StrOpt) Authentication url for encryption service. + * - ``fixed_key`` = ``None`` + - (StrOpt) Fixed key returned by key manager, specified in hex diff --git a/doc/config-ref-rst/source/tables/cinder-lenovo.rst b/doc/config-ref-rst/source/tables/cinder-lenovo.rst new file mode 100644 index 0000000000..4e16fb94b1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-lenovo.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Lenovo volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``lenovo_api_protocol`` = ``https`` + - (StrOpt) Lenovo api interface protocol. + * - ``lenovo_backend_name`` = ``A`` + - (StrOpt) Pool or Vdisk name to use for volume creation. + * - ``lenovo_backend_type`` = ``virtual`` + - (StrOpt) linear (for VDisk) or virtual (for Pool). + * - ``lenovo_iscsi_ips`` = ```` + - (ListOpt) List of comma-separated target iSCSI IP addresses. + * - ``lenovo_verify_certificate`` = ``False`` + - (BoolOpt) Whether to verify Lenovo array SSL certificate. + * - ``lenovo_verify_certificate_path`` = ``None`` + - (StrOpt) Lenovo array SSL certificate path. diff --git a/doc/config-ref-rst/source/tables/cinder-logging.rst b/doc/config-ref-rst/source/tables/cinder-logging.rst new file mode 100644 index 0000000000..c0d7d4df0a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. diff --git a/doc/config-ref-rst/source/tables/cinder-lvm.rst b/doc/config-ref-rst/source/tables/cinder-lvm.rst new file mode 100644 index 0000000000..270fc781dd --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-lvm.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of LVM configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``lvm_conf_file`` = ``/etc/cinder/lvm.conf`` + - (StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists). + * - ``lvm_mirrors`` = ``0`` + - (IntOpt) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space + * - ``lvm_type`` = ``default`` + - (StrOpt) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. + * - ``volume_group`` = ``cinder-volumes`` + - (StrOpt) Name for the VG that will contain exported volumes diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst new file mode 100644 index 0000000000..d51a3547dd --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_iscsi.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp 7-Mode iSCSI driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system or proxy server. + * - ``netapp_partner_backend_name`` = ``None`` + - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_pool_name_search_pattern`` = ``(.+)`` + - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + * - ``netapp_server_port`` = ``None`` + - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_size_multiplier`` = ``1.2`` + - (FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + * - ``netapp_storage_protocol`` = ``None`` + - (StrOpt) The storage protocol to be used on the data path with the storage system. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + * - ``netapp_vfiler`` = ``None`` + - (StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst new file mode 100644 index 0000000000..e398024966 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-netapp_7mode_nfs.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp 7-Mode NFS driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``expiry_thres_minutes`` = ``720`` + - (IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system or proxy server. + * - ``netapp_partner_backend_name`` = ``None`` + - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_pool_name_search_pattern`` = ``(.+)`` + - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + * - ``netapp_server_port`` = ``None`` + - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + * - ``netapp_storage_protocol`` = ``None`` + - (StrOpt) The storage protocol to be used on the data path with the storage system. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + * - ``netapp_vfiler`` = ``None`` + - (StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system. + * - ``thres_avl_size_perc_start`` = ``20`` + - (IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. + * - ``thres_avl_size_perc_stop`` = ``60`` + - (IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst new file mode 100644 index 0000000000..83ca282a22 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_iscsi.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp cDOT iSCSI driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system or proxy server. + * - ``netapp_lun_ostype`` = ``None`` + - (StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. + * - ``netapp_lun_space_reservation`` = ``enabled`` + - (StrOpt) This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand. + * - ``netapp_partner_backend_name`` = ``None`` + - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_pool_name_search_pattern`` = ``(.+)`` + - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + * - ``netapp_server_port`` = ``None`` + - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_size_multiplier`` = ``1.2`` + - (FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + * - ``netapp_storage_protocol`` = ``None`` + - (StrOpt) The storage protocol to be used on the data path with the storage system. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + * - ``netapp_vserver`` = ``None`` + - (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst new file mode 100644 index 0000000000..41e86868be --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-netapp_cdot_nfs.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp cDOT NFS driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``expiry_thres_minutes`` = ``720`` + - (IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. + * - ``netapp_copyoffload_tool_path`` = ``None`` + - (StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. + * - ``netapp_host_type`` = ``None`` + - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + * - ``netapp_host_type`` = ``None`` + - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system or proxy server. + * - ``netapp_lun_ostype`` = ``None`` + - (StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. + * - ``netapp_partner_backend_name`` = ``None`` + - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_pool_name_search_pattern`` = ``(.+)`` + - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + * - ``netapp_server_port`` = ``None`` + - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + * - ``netapp_storage_protocol`` = ``None`` + - (StrOpt) The storage protocol to be used on the data path with the storage system. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + * - ``netapp_vserver`` = ``None`` + - (StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. + * - ``thres_avl_size_perc_start`` = ``20`` + - (IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned. + * - ``thres_avl_size_perc_stop`` = ``60`` + - (IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option. diff --git a/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst b/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst new file mode 100644 index 0000000000..f1f432557a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-netapp_eseries_iscsi.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp E-Series driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``netapp_controller_ips`` = ``None`` + - (StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. + * - ``netapp_enable_multiattach`` = ``False`` + - (BoolOpt) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host. + * - ``netapp_host_type`` = ``None`` + - (StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system or proxy server. + * - ``netapp_partner_backend_name`` = ``None`` + - (StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_pool_name_search_pattern`` = ``(.+)`` + - (StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. + * - ``netapp_sa_password`` = ``None`` + - (StrOpt) Password for the NetApp E-Series storage array. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system or proxy server. + * - ``netapp_server_port`` = ``None`` + - (IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. + * - ``netapp_webservice_path`` = ``/devmgr/v2`` + - (StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. diff --git a/doc/config-ref-rst/source/tables/cinder-nimble.rst b/doc/config-ref-rst/source/tables/cinder-nimble.rst new file mode 100644 index 0000000000..942728310b --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-nimble.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Nimble driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nimble_pool_name`` = ``default`` + - (StrOpt) Nimble Controller pool name + * - ``nimble_subnet_label`` = ``*`` + - (StrOpt) Nimble Subnet Label diff --git a/doc/config-ref-rst/source/tables/cinder-profiler.rst b/doc/config-ref-rst/source/tables/cinder-profiler.rst new file mode 100644 index 0000000000..21e21b1a79 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-profiler.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of profiler configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[profiler]** + - + * - ``profiler_enabled`` = ``False`` + - (BoolOpt) If False fully disable profiling feature. + * - ``trace_sqlalchemy`` = ``False`` + - (BoolOpt) If False doesn't trace SQL requests. diff --git a/doc/config-ref-rst/source/tables/cinder-prophetstor_dpl.rst b/doc/config-ref-rst/source/tables/cinder-prophetstor_dpl.rst new file mode 100644 index 0000000000..79212f6153 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-prophetstor_dpl.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ProphetStor Fibre Channel and iSCSi drivers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``dpl_pool`` = ```` + - (StrOpt) DPL pool uuid in which DPL volumes are stored. + * - ``dpl_port`` = ``8357`` + - (PortOpt) DPL port number. + * - ``iscsi_port`` = ``3260`` + - (PortOpt) The port that the iSCSI daemon is listening on + * - ``san_ip`` = ```` + - (StrOpt) IP address of SAN controller + * - ``san_login`` = ``admin`` + - (StrOpt) Username for SAN controller + * - ``san_password`` = ```` + - (StrOpt) Password for SAN controller + * - ``san_thin_provision`` = ``True`` + - (BoolOpt) Use thin provisioning for SAN volumes? diff --git a/doc/config-ref-rst/source/tables/cinder-pure.rst b/doc/config-ref-rst/source/tables/cinder-pure.rst new file mode 100644 index 0000000000..894f85a627 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-pure.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Pure Storage driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pure_api_token`` = ``None`` + - (StrOpt) REST API authorization token. diff --git a/doc/config-ref-rst/source/tables/cinder-qpid.rst b/doc/config-ref-rst/source/tables/cinder-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/cinder-quobyte.rst b/doc/config-ref-rst/source/tables/cinder-quobyte.rst new file mode 100644 index 0000000000..2a3eda76cd --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-quobyte.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Quobyte USP volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``quobyte_client_cfg`` = ``None`` + - (StrOpt) Path to a Quobyte Client configuration file. + * - ``quobyte_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base dir containing the mount point for the Quobyte volume. + * - ``quobyte_qcow2_volumes`` = ``True`` + - (BoolOpt) Create volumes as QCOW2 files rather than raw files. + * - ``quobyte_sparsed_volumes`` = ``True`` + - (BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time. + * - ``quobyte_volume_url`` = ``None`` + - (StrOpt) URL to the Quobyte volume e.g., quobyte:/// diff --git a/doc/config-ref-rst/source/tables/cinder-quota.rst b/doc/config-ref-rst/source/tables/cinder-quota.rst new file mode 100644 index 0000000000..a6bf180ce3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-quota.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of quota configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``max_age`` = ``0`` + - (IntOpt) Number of seconds between subsequent usage refreshes + * - ``quota_backup_gigabytes`` = ``1000`` + - (IntOpt) Total amount of storage, in gigabytes, allowed for backups per project + * - ``quota_backups`` = ``10`` + - (IntOpt) Number of volume backups allowed per project + * - ``quota_consistencygroups`` = ``10`` + - (IntOpt) Number of consistencygroups allowed per project + * - ``quota_driver`` = ``cinder.quota.DbQuotaDriver`` + - (StrOpt) Default driver to use for quota checks + * - ``quota_gigabytes`` = ``1000`` + - (IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project + * - ``quota_snapshots`` = ``10`` + - (IntOpt) Number of volume snapshots allowed per project + * - ``quota_volumes`` = ``10`` + - (IntOpt) Number of volumes allowed per project + * - ``reservation_expire`` = ``86400`` + - (IntOpt) Number of seconds until a reservation expires + * - ``use_default_quota_class`` = ``True`` + - (BoolOpt) Enables or disables use of default quota class with default quota. diff --git a/doc/config-ref-rst/source/tables/cinder-rabbitmq.rst b/doc/config-ref-rst/source/tables/cinder-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/cinder-redis.rst b/doc/config-ref-rst/source/tables/cinder-redis.rst new file mode 100644 index 0000000000..dca6654f9c --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-redis.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/cinder-rpc.rst b/doc/config-ref-rst/source/tables/cinder-rpc.rst new file mode 100644 index 0000000000..4c833e4cd1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-rpc.rst @@ -0,0 +1,70 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - ``volume_topic`` = ``cinder-volume`` + - (StrOpt) The topic that volume nodes listen on + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/cinder-san.rst b/doc/config-ref-rst/source/tables/cinder-san.rst new file mode 100644 index 0000000000..21a03e5545 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-san.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SAN configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``san_clustername`` = ```` + - (StrOpt) Cluster name to use for creating volumes + * - ``san_ip`` = ```` + - (StrOpt) IP address of SAN controller + * - ``san_is_local`` = ``False`` + - (BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device + * - ``san_login`` = ``admin`` + - (StrOpt) Username for SAN controller + * - ``san_password`` = ```` + - (StrOpt) Password for SAN controller + * - ``san_private_key`` = ```` + - (StrOpt) Filename of private key to use for SSH authentication + * - ``san_secondary_ip`` = ``None`` + - (StrOpt) VNX secondary SP IP Address. + * - ``san_ssh_port`` = ``22`` + - (PortOpt) SSH port to use with SAN + * - ``san_thin_provision`` = ``True`` + - (BoolOpt) Use thin provisioning for SAN volumes? + * - ``ssh_conn_timeout`` = ``30`` + - (IntOpt) SSH connection timeout in seconds + * - ``ssh_max_pool_conn`` = ``5`` + - (IntOpt) Maximum ssh connections in the pool + * - ``ssh_min_pool_conn`` = ``1`` + - (IntOpt) Minimum ssh connections in the pool diff --git a/doc/config-ref-rst/source/tables/cinder-scality.rst b/doc/config-ref-rst/source/tables/cinder-scality.rst new file mode 100644 index 0000000000..c33c6cd2a8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-scality.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Scality SOFS volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``scality_sofs_config`` = ``None`` + - (StrOpt) Path or URL to Scality SOFS configuration file + * - ``scality_sofs_mount_point`` = ``$state_path/scality`` + - (StrOpt) Base dir where Scality SOFS shall be mounted + * - ``scality_sofs_volume_dir`` = ``cinder/volumes`` + - (StrOpt) Path from Scality SOFS root to volume dir diff --git a/doc/config-ref-rst/source/tables/cinder-scheduler.rst b/doc/config-ref-rst/source/tables/cinder-scheduler.rst new file mode 100644 index 0000000000..2f29ee5a3a --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-scheduler.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of scheduler configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``filter_function`` = ``None`` + - (StrOpt) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. + * - ``goodness_function`` = ``None`` + - (StrOpt) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. + * - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter`` + - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. + * - ``scheduler_default_weighers`` = ``CapacityWeigher`` + - (ListOpt) Which weigher class names to use for weighing hosts. + * - ``scheduler_driver`` = ``cinder.scheduler.filter_scheduler.FilterScheduler`` + - (StrOpt) Default scheduler driver to use + * - ``scheduler_host_manager`` = ``cinder.scheduler.host_manager.HostManager`` + - (StrOpt) The scheduler host manager class to use + * - ``scheduler_json_config_location`` = ```` + - (StrOpt) Absolute path to scheduler configuration JSON file. + * - ``scheduler_manager`` = ``cinder.scheduler.manager.SchedulerManager`` + - (StrOpt) Full class name for the Manager for scheduler + * - ``scheduler_max_attempts`` = ``3`` + - (IntOpt) Maximum number of attempts to schedule an volume + * - ``scheduler_topic`` = ``cinder-scheduler`` + - (StrOpt) The topic that scheduler nodes listen on diff --git a/doc/config-ref-rst/source/tables/cinder-scst.rst b/doc/config-ref-rst/source/tables/cinder-scst.rst new file mode 100644 index 0000000000..148f6c4dbd --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-scst.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SCST volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``scst_target_driver`` = ``iscsi`` + - (StrOpt) SCST target implementation can choose from multiple SCST target drivers. + * - ``scst_target_iqn_name`` = ``None`` + - (StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name. diff --git a/doc/config-ref-rst/source/tables/cinder-sheepdog.rst b/doc/config-ref-rst/source/tables/cinder-sheepdog.rst new file mode 100644 index 0000000000..b87f6eae87 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-sheepdog.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Sheepdog driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``sheepdog_store_address`` = ``127.0.0.1`` + - (StrOpt) IP address of sheep daemon. + * - ``sheepdog_store_port`` = ``7000`` + - (PortOpt) Port of sheep daemon. diff --git a/doc/config-ref-rst/source/tables/cinder-smbfs.rst b/doc/config-ref-rst/source/tables/cinder-smbfs.rst new file mode 100644 index 0000000000..5b5ad20048 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-smbfs.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Samba volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``smbfs_allocation_info_file_path`` = ``$state_path/allocation_data`` + - (StrOpt) The path of the automatically generated file containing information about volume disk space allocation. + * - ``smbfs_default_volume_format`` = ``qcow2`` + - (StrOpt) Default format that will be used when creating volumes if no volume format is specified. + * - ``smbfs_mount_options`` = ``noperm,file_mode=0775,dir_mode=0775`` + - (StrOpt) Mount options passed to the smbfs client. See mount.cifs man page for details. + * - ``smbfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base dir containing mount points for smbfs shares. + * - ``smbfs_oversub_ratio`` = ``1.0`` + - (FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. + * - ``smbfs_shares_config`` = ``/etc/cinder/smbfs_shares`` + - (StrOpt) File with the list of available smbfs shares. + * - ``smbfs_sparsed_volumes`` = ``True`` + - (BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. + * - ``smbfs_used_ratio`` = ``0.95`` + - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. diff --git a/doc/config-ref-rst/source/tables/cinder-solidfire.rst b/doc/config-ref-rst/source/tables/cinder-solidfire.rst new file mode 100644 index 0000000000..13d0011793 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-solidfire.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SolidFire driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``sf_account_prefix`` = ``None`` + - (StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix. + * - ``sf_allow_template_caching`` = ``True`` + - (BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls. + * - ``sf_allow_tenant_qos`` = ``False`` + - (BoolOpt) Allow tenants to specify QOS on create + * - ``sf_api_port`` = ``443`` + - (PortOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. + * - ``sf_emulate_512`` = ``True`` + - (BoolOpt) Set 512 byte emulation on volume creation; + * - ``sf_enable_volume_mapping`` = ``True`` + - (BoolOpt) Create an internal mapping of volume IDs and account. Optimizes lookups and performance at the expense of memory, very large deployments may want to consider setting to False. + * - ``sf_svip`` = ``None`` + - (StrOpt) Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud. + * - ``sf_template_account_name`` = ``openstack-vtemplate`` + - (StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist). + * - ``sf_volume_prefix`` = ``UUID-`` + - (StrOpt) Create SolidFire volumes with this prefix. Volume names are of the form . The default is to use a prefix of 'UUID-'. diff --git a/doc/config-ref-rst/source/tables/cinder-srb.rst b/doc/config-ref-rst/source/tables/cinder-srb.rst new file mode 100644 index 0000000000..7a665dbd1b --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-srb.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Scality REST Block storage driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``srb_base_urls`` = ``None`` + - (StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path diff --git a/doc/config-ref-rst/source/tables/cinder-storage.rst b/doc/config-ref-rst/source/tables/cinder-storage.rst new file mode 100644 index 0000000000..cb6529a93c --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storage.rst @@ -0,0 +1,78 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allocated_capacity_weight_multiplier`` = ``-1.0`` + - (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. + * - ``capacity_weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. + * - ``enabled_backends`` = ``None`` + - (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options + * - ``iscsi_helper`` = ``tgtadm`` + - (StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. + * - ``iscsi_iotype`` = ``fileio`` + - (StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device + * - ``iscsi_ip_address`` = ``$my_ip`` + - (StrOpt) The IP address that the iSCSI daemon is listening on + * - ``iscsi_port`` = ``3260`` + - (PortOpt) The port that the iSCSI daemon is listening on + * - ``iscsi_protocol`` = ``iscsi`` + - (StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser". + * - ``iscsi_target_flags`` = ```` + - (StrOpt) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. + * - ``iscsi_target_prefix`` = ``iqn.2010-10.org.openstack:`` + - (StrOpt) Prefix for iSCSI volumes + * - ``iscsi_write_cache`` = ``on`` + - (StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm. + * - ``iser_helper`` = ``tgtadm`` + - (StrOpt) The name of the iSER target user-land tool to use + * - ``iser_ip_address`` = ``$my_ip`` + - (StrOpt) The IP address that the iSER daemon is listening on + * - ``iser_port`` = ``3260`` + - (PortOpt) The port that the iSER daemon is listening on + * - ``iser_target_prefix`` = ``iqn.2010-10.org.openstack:`` + - (StrOpt) Prefix for iSER volumes + * - ``migration_create_volume_timeout_secs`` = ``300`` + - (IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds) + * - ``num_iser_scan_tries`` = ``3`` + - (IntOpt) The maximum number of times to rescan iSER targetto find volume + * - ``num_volume_device_scan_tries`` = ``3`` + - (IntOpt) The maximum number of times to rescan targets to find volume + * - ``volume_backend_name`` = ``None`` + - (StrOpt) The backend name for a given driver implementation + * - ``volume_clear`` = ``zero`` + - (StrOpt) Method used to wipe old volumes + * - ``volume_clear_ionice`` = ``None`` + - (StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. + * - ``volume_clear_size`` = ``0`` + - (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + * - ``volume_copy_blkio_cgroup_name`` = ``cinder-volume-copy`` + - (StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy + * - ``volume_copy_bps_limit`` = ``0`` + - (IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited + * - ``volume_dd_blocksize`` = ``1M`` + - (StrOpt) The default block size used when copying/clearing volumes + * - ``volume_driver`` = ``cinder.volume.drivers.lvm.LVMVolumeDriver`` + - (StrOpt) Driver to use for volume creation + * - ``volume_manager`` = ``cinder.volume.manager.VolumeManager`` + - (StrOpt) Full class name for the Manager for volume + * - ``volume_service_inithost_offload`` = ``False`` + - (BoolOpt) Offload pending volume delete during volume service startup + * - ``volume_usage_audit_period`` = ``month`` + - (StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year. + * - ``volumes_dir`` = ``$state_path/volumes`` + - (StrOpt) Volume configuration file storage directory diff --git a/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst b/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst new file mode 100644 index 0000000000..268dce833c --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storage_ceph.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Ceph storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rados_connect_timeout`` = ``-1`` + - (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. + * - ``rados_connection_interval`` = ``5`` + - (IntOpt) Interval value (in seconds) between connection retries to ceph cluster. + * - ``rados_connection_retries`` = ``3`` + - (IntOpt) Number of retries if connection to ceph cluster failed. + * - ``rbd_ceph_conf`` = ```` + - (StrOpt) Path to the ceph configuration file + * - ``rbd_cluster_name`` = ``ceph`` + - (StrOpt) The name of ceph cluster + * - ``rbd_flatten_volume_from_snapshot`` = ``False`` + - (BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot + * - ``rbd_max_clone_depth`` = ``5`` + - (IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. + * - ``rbd_pool`` = ``rbd`` + - (StrOpt) The RADOS pool where rbd volumes are stored + * - ``rbd_secret_uuid`` = ``None`` + - (StrOpt) The libvirt uuid of the secret for the rbd_user volumes + * - ``rbd_store_chunk_size`` = ``4`` + - (IntOpt) Volumes will be chunked into objects of this size (in megabytes). + * - ``rbd_user`` = ``None`` + - (StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication + * - ``volume_tmp_dir`` = ``None`` + - (StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead. diff --git a/doc/config-ref-rst/source/tables/cinder-storage_glusterfs.rst b/doc/config-ref-rst/source/tables/cinder-storage_glusterfs.rst new file mode 100644 index 0000000000..703e8e8799 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storage_glusterfs.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of GlusterFS storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``glusterfs_backup_mount_point`` = ``$state_path/backup_mount`` + - (StrOpt) Base dir containing mount point for gluster share. + * - ``glusterfs_backup_share`` = ``None`` + - (StrOpt) GlusterFS share in : format. Eg: 1.2.3.4:backup_vol + * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base dir containing mount points for gluster shares. + * - ``glusterfs_shares_config`` = ``/etc/cinder/glusterfs_shares`` + - (StrOpt) File with the list of available gluster shares + * - ``nas_volume_prov_type`` = ``thin`` + - (StrOpt) Provisioning type that will be used when creating volumes. diff --git a/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst b/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst new file mode 100644 index 0000000000..35d6e34057 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storage_gpfs.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of GPFS storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``gpfs_images_dir`` = ``None`` + - (StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. + * - ``gpfs_images_share_mode`` = ``None`` + - (StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently. + * - ``gpfs_max_clone_depth`` = ``0`` + - (IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth. + * - ``gpfs_mount_point_base`` = ``None`` + - (StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. + * - ``gpfs_sparse_volumes`` = ``True`` + - (BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time. + * - ``gpfs_storage_pool`` = ``system`` + - (StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. diff --git a/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst b/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst new file mode 100644 index 0000000000..d8a82f6932 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storage_nfs.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NFS storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nfs_mount_attempts`` = ``3`` + - (IntOpt) The number of attempts to mount NFS shares before raising an error. At least one attempt will be made to mount an NFS share, regardless of the value specified. + * - ``nfs_mount_options`` = ``None`` + - (StrOpt) Mount options passed to the NFS client. See section of the NFS man page for details. + * - ``nfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base dir containing mount points for NFS shares. + * - ``nfs_oversub_ratio`` = ``1.0`` + - (FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. Note that this option is deprecated in favor of "max_oversubscription_ratio" and will be removed in the Mitaka release. + * - ``nfs_shares_config`` = ``/etc/cinder/nfs_shares`` + - (StrOpt) File with the list of available NFS shares + * - ``nfs_sparsed_volumes`` = ``True`` + - (BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. + * - ``nfs_used_ratio`` = ``0.95`` + - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. Note that this option is deprecated in favor of "reserved_percentage" and will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/cinder-storwize.rst b/doc/config-ref-rst/source/tables/cinder-storwize.rst new file mode 100644 index 0000000000..c34c2ca496 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-storwize.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM Storwise driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``storwize_svc_allow_tenant_qos`` = ``False`` + - (BoolOpt) Allow tenants to specify QOS on create + * - ``storwize_svc_connection_protocol`` = ``iSCSI`` + - (StrOpt) Connection protocol (iSCSI/FC) + * - ``storwize_svc_flashcopy_timeout`` = ``120`` + - (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. + * - ``storwize_svc_iscsi_chap_enabled`` = ``True`` + - (BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled) + * - ``storwize_svc_multihostmap_enabled`` = ``True`` + - (BoolOpt) Allows vdisk to multi host mapping + * - ``storwize_svc_multipath_enabled`` = ``False`` + - (BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) + * - ``storwize_svc_stretched_cluster_partner`` = ``None`` + - (StrOpt) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" + * - ``storwize_svc_vol_autoexpand`` = ``True`` + - (BoolOpt) Storage system autoexpand parameter for volumes (True/False) + * - ``storwize_svc_vol_compression`` = ``False`` + - (BoolOpt) Storage system compression option for volumes + * - ``storwize_svc_vol_easytier`` = ``True`` + - (BoolOpt) Enable Easy Tier for volumes + * - ``storwize_svc_vol_grainsize`` = ``256`` + - (IntOpt) Storage system grain size parameter for volumes (32/64/128/256) + * - ``storwize_svc_vol_iogrp`` = ``0`` + - (IntOpt) The I/O group in which to allocate volumes + * - ``storwize_svc_vol_nofmtdisk`` = ``False`` + - (BoolOpt) Specifies that the volume not be formatted during creation. + * - ``storwize_svc_vol_rsize`` = ``2`` + - (IntOpt) Storage system space-efficiency parameter for volumes (percentage) + * - ``storwize_svc_vol_warning`` = ``0`` + - (IntOpt) Storage system threshold for volume capacity warnings (percentage) + * - ``storwize_svc_volpool_name`` = ``volpool`` + - (StrOpt) Storage system storage pool for volumes diff --git a/doc/config-ref-rst/source/tables/cinder-swift.rst b/doc/config-ref-rst/source/tables/cinder-swift.rst new file mode 100644 index 0000000000..4c31c626e7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-swift.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_swift_auth_insecure`` = ``False`` + - (BoolOpt) Bypass verification of server certificate when making SSL connection to Swift. + * - ``backup_swift_auth_url`` = ``None`` + - (StrOpt) The URL of the Keystone endpoint diff --git a/doc/config-ref-rst/source/tables/cinder-tintri.rst b/doc/config-ref-rst/source/tables/cinder-tintri.rst new file mode 100644 index 0000000000..c5af60cd3b --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-tintri.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Tintri volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``tintri_api_version`` = ``v310`` + - (StrOpt) API version for the storage system + * - ``tintri_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system + * - ``tintri_server_password`` = ``None`` + - (StrOpt) Password for the storage system + * - ``tintri_server_username`` = ``None`` + - (StrOpt) User name for the storage system diff --git a/doc/config-ref-rst/source/tables/cinder-violin.rst b/doc/config-ref-rst/source/tables/cinder-violin.rst new file mode 100644 index 0000000000..5c9e3e3e65 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-violin.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Violin volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``gateway_mga`` = ``None`` + - (StrOpt) IP address or hostname of mg-a + * - ``gateway_mgb`` = ``None`` + - (StrOpt) IP address or hostname of mg-b + * - ``use_igroups`` = ``False`` + - (BoolOpt) Use igroups to manage targets and initiators + * - ``violin_request_timeout`` = ``300`` + - (IntOpt) Global backend request timeout, in seconds. diff --git a/doc/config-ref-rst/source/tables/cinder-vmware.rst b/doc/config-ref-rst/source/tables/cinder-vmware.rst new file mode 100644 index 0000000000..bb5236518e --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-vmware.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VMware configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``vmware_api_retry_count`` = ``10`` + - (IntOpt) Number of times VMware vCenter server API must be retried upon connection related issues. + * - ``vmware_ca_file`` = ``None`` + - (StrOpt) CA bundle file to use in verifying the vCenter server certificate. + * - ``vmware_cluster_name`` = ``None`` + - (MultiStrOpt) Name of a vCenter compute cluster where volumes should be created. + * - ``vmware_host_ip`` = ``None`` + - (StrOpt) IP address for connecting to VMware vCenter server. + * - ``vmware_host_password`` = ``None`` + - (StrOpt) Password for authenticating with VMware vCenter server. + * - ``vmware_host_username`` = ``None`` + - (StrOpt) Username for authenticating with VMware vCenter server. + * - ``vmware_host_version`` = ``None`` + - (StrOpt) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. + * - ``vmware_image_transfer_timeout_secs`` = ``7200`` + - (IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance. + * - ``vmware_insecure`` = ``False`` + - (BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set. + * - ``vmware_max_objects_retrieval`` = ``100`` + - (IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. + * - ``vmware_task_poll_interval`` = ``0.5`` + - (FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. + * - ``vmware_tmp_dir`` = ``/tmp`` + - (StrOpt) Directory where virtual disks are stored during volume backup and restore. + * - ``vmware_volume_folder`` = ``Volumes`` + - (StrOpt) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/", where project_folder is of format "Project ()". + * - ``vmware_wsdl_location`` = ``None`` + - (StrOpt) Optional VIM service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds. diff --git a/doc/config-ref-rst/source/tables/cinder-vzstorage.rst b/doc/config-ref-rst/source/tables/cinder-vzstorage.rst new file mode 100644 index 0000000000..e49e5f839d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-vzstorage.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VidZapper Storage volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``vzstorage_mount_options`` = ``None`` + - (ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. + * - ``vzstorage_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base dir containing mount points for vzstorage shares. + * - ``vzstorage_shares_config`` = ``/etc/cinder/vzstorage_shares`` + - (StrOpt) File with the list of available vzstorage shares. + * - ``vzstorage_sparsed_volumes`` = ``True`` + - (BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time. + * - ``vzstorage_used_ratio`` = ``0.95`` + - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. diff --git a/doc/config-ref-rst/source/tables/cinder-windows.rst b/doc/config-ref-rst/source/tables/cinder-windows.rst new file mode 100644 index 0000000000..87b21ee368 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-windows.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Windows configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``windows_iscsi_lun_path`` = ``C:\iSCSIVirtualDisks`` + - (StrOpt) Path to store VHD backed volumes diff --git a/doc/config-ref-rst/source/tables/cinder-xio.rst b/doc/config-ref-rst/source/tables/cinder-xio.rst new file mode 100644 index 0000000000..bb319f224c --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-xio.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of X-IO volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``driver_use_ssl`` = ``False`` + - (BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it. + * - ``ise_completion_retries`` = ``30`` + - (IntOpt) Number on retries to get completion status after issuing a command to ISE. + * - ``ise_connection_retries`` = ``5`` + - (IntOpt) Number of retries (per port) when establishing connection to ISE management port. + * - ``ise_raid`` = ``1`` + - (IntOpt) Raid level for ISE volumes. + * - ``ise_retry_interval`` = ``1`` + - (IntOpt) Interval (secs) between retries. + * - ``ise_storage_pool`` = ``1`` + - (IntOpt) Default storage pool for volumes. diff --git a/doc/config-ref-rst/source/tables/cinder-xiv.rst b/doc/config-ref-rst/source/tables/cinder-xiv.rst new file mode 100644 index 0000000000..a9968ed503 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-xiv.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM XIV and DS8000 volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``san_clustername`` = ```` + - (StrOpt) Cluster name to use for creating volumes + * - ``san_ip`` = ```` + - (StrOpt) IP address of SAN controller + * - ``san_login`` = ``admin`` + - (StrOpt) Username for SAN controller + * - ``san_password`` = ```` + - (StrOpt) Password for SAN controller + * - ``xiv_chap`` = ``disabled`` + - (StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled) + * - ``xiv_ds8k_connection_type`` = ``iscsi`` + - (StrOpt) Connection type to the IBM Storage Array + * - ``xiv_ds8k_proxy`` = ``xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy`` + - (StrOpt) Proxy driver that connects to the IBM Storage Array diff --git a/doc/config-ref-rst/source/tables/cinder-zeromq.rst b/doc/config-ref-rst/source/tables/cinder-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/cinder-zfssa-iscsi.rst b/doc/config-ref-rst/source/tables/cinder-zfssa-iscsi.rst new file mode 100644 index 0000000000..9fd9e48a65 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zfssa-iscsi.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZFS Storage Appliance iSCSI driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zfssa_initiator`` = ```` + - (StrOpt) iSCSI initiator IQNs. (comma separated) + * - ``zfssa_initiator_config`` = ```` + - (StrOpt) iSCSI initiators configuration. + * - ``zfssa_initiator_group`` = ```` + - (StrOpt) iSCSI initiator group. + * - ``zfssa_initiator_password`` = ```` + - (StrOpt) Secret of the iSCSI initiator CHAP user. + * - ``zfssa_initiator_user`` = ```` + - (StrOpt) iSCSI initiator CHAP user (name). + * - ``zfssa_lun_compression`` = ``off`` + - (StrOpt) Data compression. + * - ``zfssa_lun_logbias`` = ``latency`` + - (StrOpt) Synchronous write bias. + * - ``zfssa_lun_sparse`` = ``False`` + - (BoolOpt) Flag to enable sparse (thin-provisioned): True, False. + * - ``zfssa_lun_volblocksize`` = ``8k`` + - (StrOpt) Block size. + * - ``zfssa_pool`` = ``None`` + - (StrOpt) Storage pool name. + * - ``zfssa_project`` = ``None`` + - (StrOpt) Project name. + * - ``zfssa_replication_ip`` = ```` + - (StrOpt) IP address used for replication data. (maybe the same as data ip) + * - ``zfssa_rest_timeout`` = ``None`` + - (IntOpt) REST connection timeout. (seconds) + * - ``zfssa_target_group`` = ``tgt-grp`` + - (StrOpt) iSCSI target group name. + * - ``zfssa_target_interfaces`` = ``None`` + - (StrOpt) Network interfaces of iSCSI targets. (comma separated) + * - ``zfssa_target_password`` = ```` + - (StrOpt) Secret of the iSCSI target CHAP user. + * - ``zfssa_target_portal`` = ``None`` + - (StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260). + * - ``zfssa_target_user`` = ```` + - (StrOpt) iSCSI target CHAP user (name). diff --git a/doc/config-ref-rst/source/tables/cinder-zfssa-nfs.rst b/doc/config-ref-rst/source/tables/cinder-zfssa-nfs.rst new file mode 100644 index 0000000000..45e1f09f1d --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zfssa-nfs.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZFS Storage Appliance NFS driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zfssa_cache_directory`` = ``os-cinder-cache`` + - (StrOpt) Name of directory inside zfssa_nfs_share where cache volumes are stored. + * - ``zfssa_cache_project`` = ``os-cinder-cache`` + - (StrOpt) Name of ZFSSA project where cache volumes are stored. + * - ``zfssa_data_ip`` = ``None`` + - (StrOpt) Data path IP address + * - ``zfssa_enable_local_cache`` = ``True`` + - (BoolOpt) Flag to enable local caching: True, False. + * - ``zfssa_https_port`` = ``443`` + - (StrOpt) HTTPS port number + * - ``zfssa_nfs_mount_options`` = ```` + - (StrOpt) Options to be passed while mounting share over nfs + * - ``zfssa_nfs_pool`` = ```` + - (StrOpt) Storage pool name. + * - ``zfssa_nfs_project`` = ``NFSProject`` + - (StrOpt) Project name. + * - ``zfssa_nfs_share`` = ``nfs_share`` + - (StrOpt) Share name. + * - ``zfssa_nfs_share_compression`` = ``off`` + - (StrOpt) Data compression. + * - ``zfssa_nfs_share_logbias`` = ``latency`` + - (StrOpt) Synchronous write bias-latency, throughput. + * - ``zfssa_rest_timeout`` = ``None`` + - (IntOpt) REST connection timeout. (seconds) diff --git a/doc/config-ref-rst/source/tables/cinder-zones.rst b/doc/config-ref-rst/source/tables/cinder-zones.rst new file mode 100644 index 0000000000..68c8bf6096 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zones.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of zones configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cloned_volume_same_az`` = ``True`` + - (BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume diff --git a/doc/config-ref-rst/source/tables/cinder-zoning.rst b/doc/config-ref-rst/source/tables/cinder-zoning.rst new file mode 100644 index 0000000000..b78e7620b9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zoning.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of zoning configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zoning_mode`` = ``None`` + - (StrOpt) FC Zoning mode configured + * - **[fc-zone-manager]** + - + * - ``fc_fabric_names`` = ``None`` + - (StrOpt) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric + * - ``fc_san_lookup_service`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService`` + - (StrOpt) FC SAN Lookup Service + * - ``zone_driver`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver`` + - (StrOpt) FC Zone Driver responsible for zone management + * - ``zoning_policy`` = ``initiator-target`` + - (StrOpt) Zoning policy configured by user; valid values include "initiator-target" or "initiator" diff --git a/doc/config-ref-rst/source/tables/cinder-zoning_fabric.rst b/doc/config-ref-rst/source/tables/cinder-zoning_fabric.rst new file mode 100644 index 0000000000..53d3b750e9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zoning_fabric.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of zoning fabrics configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[BRCD_FABRIC_EXAMPLE]** + - + * - ``fc_fabric_address`` = ```` + - (StrOpt) Management IP of fabric + * - ``fc_fabric_password`` = ```` + - (StrOpt) Password for user + * - ``fc_fabric_port`` = ``22`` + - (PortOpt) Connecting port + * - ``fc_fabric_user`` = ```` + - (StrOpt) Fabric user ID + * - ``principal_switch_wwn`` = ``None`` + - (StrOpt) Principal switch WWN of the fabric + * - ``zone_activate`` = ``True`` + - (BoolOpt) overridden zoning activation state + * - ``zone_name_prefix`` = ``None`` + - (StrOpt) overridden zone name prefix + * - ``zoning_policy`` = ``initiator-target`` + - (StrOpt) overridden zoning policy diff --git a/doc/config-ref-rst/source/tables/cinder-zoning_fabric_cisco.rst b/doc/config-ref-rst/source/tables/cinder-zoning_fabric_cisco.rst new file mode 100644 index 0000000000..3405d92c71 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zoning_fabric_cisco.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cisco zoning fabrics configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[CISCO_FABRIC_EXAMPLE]** + - + * - ``cisco_fc_fabric_address`` = ```` + - (StrOpt) Management IP of fabric + * - ``cisco_fc_fabric_password`` = ```` + - (StrOpt) Password for user + * - ``cisco_fc_fabric_port`` = ``22`` + - (PortOpt) Connecting port + * - ``cisco_fc_fabric_user`` = ```` + - (StrOpt) Fabric user ID + * - ``cisco_zone_activate`` = ``True`` + - (BoolOpt) overridden zoning activation state + * - ``cisco_zone_name_prefix`` = ``None`` + - (StrOpt) overridden zone name prefix + * - ``cisco_zoning_policy`` = ``initiator-target`` + - (StrOpt) overridden zoning policy + * - ``cisco_zoning_vsan`` = ``None`` + - (StrOpt) VSAN of the Fabric diff --git a/doc/config-ref-rst/source/tables/cinder-zoning_manager.rst b/doc/config-ref-rst/source/tables/cinder-zoning_manager.rst new file mode 100644 index 0000000000..6c217644c6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zoning_manager.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of zoning manager configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[fc-zone-manager]** + - + * - ``brcd_sb_connector`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI`` + - (StrOpt) Southbound connector for zoning operation diff --git a/doc/config-ref-rst/source/tables/cinder-zoning_manager_cisco.rst b/doc/config-ref-rst/source/tables/cinder-zoning_manager_cisco.rst new file mode 100644 index 0000000000..1d0fb1c684 --- /dev/null +++ b/doc/config-ref-rst/source/tables/cinder-zoning_manager_cisco.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cisco zoning manager configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[fc-zone-manager]** + - + * - ``cisco_sb_connector`` = ``cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI`` + - (StrOpt) Southbound connector for zoning operation diff --git a/doc/config-ref-rst/source/tables/glance-amqp.rst b/doc/config-ref-rst/source/tables/glance-amqp.rst new file mode 100644 index 0000000000..b0a3d99ddc --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-amqp.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``default_publisher_id`` = ``image.localhost`` + - (StrOpt) Default publisher_id for outgoing notifications. + * - ``disabled_notifications`` = ```` + - (ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create", "metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/glance-api.rst b/doc/config-ref-rst/source/tables/glance-api.rst new file mode 100644 index 0000000000..540354cd39 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-api.rst @@ -0,0 +1,84 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``admin_role`` = ``admin`` + - (StrOpt) Role used to identify an authenticated user as administrator. + * - ``allow_anonymous_access`` = ``False`` + - (BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware. + * - ``available_plugins`` = ```` + - (ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded. + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + * - ``enable_v1_api`` = ``True`` + - (BoolOpt) Deploy the v1 OpenStack Images API. + * - ``enable_v1_registry`` = ``True`` + - (BoolOpt) Deploy the v1 OpenStack Registry API. + * - ``enable_v2_api`` = ``True`` + - (BoolOpt) Deploy the v2 OpenStack Images API. + * - ``enable_v2_registry`` = ``True`` + - (BoolOpt) Deploy the v2 OpenStack Registry API. + * - ``enable_v3_api`` = ``False`` + - (BoolOpt) Deploy the v3 OpenStack Objects API. + * - ``http_keepalive`` = ``True`` + - (BoolOpt) If False, server will return the header "Connection: close", If True, server will return "Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server. + * - ``image_size_cap`` = ``1099511627776`` + - (IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808). + * - ``load_enabled`` = ``True`` + - (BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded. + * - ``location_strategy`` = ``location_order`` + - (StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs + * - ``max_request_id_length`` = ``64`` + - (IntOpt) Limits request ID length. + * - ``owner_is_tenant`` = ``True`` + - (BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request. + * - ``public_endpoint`` = ``None`` + - (StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Glance is operating behind a proxy, you will want to change this to represent the proxy's URL. + * - ``send_identity_headers`` = ``False`` + - (BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware. + * - ``show_multiple_locations`` = ``False`` + - (BoolOpt) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' meta-data field. Revealing storage location can be a security risk, so use this setting with caution! Setting this to true overrides the show_image_direct_url option. + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``use_user_token`` = ``True`` + - (BoolOpt) Whether to pass through the user token when making requests to the registry. To prevent failures with token expiration during big files upload, it is recommended to set this parameter to False.If "use_user_token" is not in effect, then admin credentials can be specified. + * - **[glance_store]** + - + * - ``default_store`` = ``file`` + - (StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option. + * - ``store_capabilities_update_min_interval`` = ``0`` + - (IntOpt) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero. + * - ``stores`` = ``file, http`` + - (ListOpt) List of stores enabled + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[paste_deploy]** + - + * - ``config_file`` = ``None`` + - (StrOpt) Name of the paste configuration file. + * - ``flavor`` = ``None`` + - (StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone" + * - **[store_type_location_strategy]** + - + * - ``store_type_preference`` = ```` + - (ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option. diff --git a/doc/config-ref-rst/source/tables/glance-auth_token.rst b/doc/config-ref-rst/source/tables/glance-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/glance-ca.rst b/doc/config-ref-rst/source/tables/glance-ca.rst new file mode 100644 index 0000000000..54223a4af0 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-ca.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CA and SSL configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) CA certificate file to use to verify connecting clients. + * - ``cert_file`` = ``None`` + - (StrOpt) Certificate file to use when starting API server securely. + * - ``key_file`` = ``None`` + - (StrOpt) Private key file to use when starting API server securely. diff --git a/doc/config-ref-rst/source/tables/glance-cinder.rst b/doc/config-ref-rst/source/tables/glance-cinder.rst new file mode 100644 index 0000000000..b1586bba87 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-cinder.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cinder configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``cinder_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to cinder + * - ``cinder_ca_certificates_file`` = ``None`` + - (StrOpt) Location of ca certicates file to use for cinder client requests. + * - ``cinder_catalog_info`` = ``volume:cinder:publicURL`` + - (StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: :: + * - ``cinder_endpoint_template`` = ``None`` + - (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s + * - ``cinder_http_retries`` = ``3`` + - (IntOpt) Number of cinderclient retries on failed http calls diff --git a/doc/config-ref-rst/source/tables/glance-common.rst b/doc/config-ref-rst/source/tables/glance-common.rst new file mode 100644 index 0000000000..c098c20426 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-common.rst @@ -0,0 +1,82 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allow_additional_image_properties`` = ``True`` + - (BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides + * - ``api_limit_max`` = ``1000`` + - (IntOpt) Maximum permissible number of items that could be returned by a request + * - ``backlog`` = ``4096`` + - (IntOpt) The backlog value that will be used when creating the TCP listener socket. + * - ``bind_host`` = ``0.0.0.0`` + - (StrOpt) Address to bind the server. Useful when selecting a particular network interface. + * - ``bind_port`` = ``None`` + - (PortOpt) The port on which the server will listen. + * - ``data_api`` = ``glance.db.sqlalchemy.api`` + - (StrOpt) Python module path of data access API + * - ``digest_algorithm`` = ``sha256`` + - (StrOpt) Digest algorithm which will be used for digital signature. Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are "sha1", "sha256", "sha512", etc. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``image_location_quota`` = ``10`` + - (IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. + * - ``image_member_quota`` = ``128`` + - (IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. + * - ``image_property_quota`` = ``128`` + - (IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. + * - ``image_tag_quota`` = ``128`` + - (IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. + * - ``limit_param_default`` = ``25`` + - (IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``metadata_encryption_key`` = ``None`` + - (StrOpt) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes + * - ``metadata_source_path`` = ``/etc/glance/metadefs/`` + - (StrOpt) Path to the directory where json metadata files are stored + * - ``property_protection_file`` = ``None`` + - (StrOpt) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it. If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glance-api service will not start. + * - ``property_protection_rule_format`` = ``roles`` + - (StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. + * - ``show_image_direct_url`` = ``False`` + - (BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution! + * - ``user_storage_quota`` = ``0`` + - (StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive. + * - ``workers`` = ``4`` + - (IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available. + * - **[glance_store]** + - + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name of this node + * - **[image_format]** + - + * - ``container_formats`` = ``ami, ari, aki, bare, ovf, ova`` + - (ListOpt) Supported values for the 'container_format' image attribute + * - ``disk_formats`` = ``ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso`` + - (ListOpt) Supported values for the 'disk_format' image attribute + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - **[task]** + - + * - ``task_executor`` = ``taskflow`` + - (StrOpt) Specifies which task executor to be used to run the task scripts. + * - ``task_time_to_live`` = ``48`` + - (IntOpt) Time in hours for which a task lives after, either succeeding or failing + * - ``work_dir`` = ``None`` + - (StrOpt) Work dir for asynchronous task operations. The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB). The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong. diff --git a/doc/config-ref-rst/source/tables/glance-cors.rst b/doc/config-ref-rst/source/tables/glance-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/glance-database.rst b/doc/config-ref-rst/source/tables/glance-database.rst new file mode 100644 index 0000000000..fe0826d256 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-database.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/glance-filesystem.rst b/doc/config-ref-rst/source/tables/glance-filesystem.rst new file mode 100644 index 0000000000..f145d6c660 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-filesystem.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of filesystem configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``filesystem_store_datadir`` = ``None`` + - (StrOpt) Directory to which the Filesystem backend store writes images. + * - ``filesystem_store_datadirs`` = ``None`` + - (MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images. + * - ``filesystem_store_file_perm`` = ``0`` + - (IntOpt) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit. + * - ``filesystem_store_metadata_file`` = ``None`` + - (StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys 'id' and 'mountpoint'. The value for both keys should be 'string'. diff --git a/doc/config-ref-rst/source/tables/glance-gridfs.rst b/doc/config-ref-rst/source/tables/glance-gridfs.rst new file mode 100644 index 0000000000..73a47249b3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-gridfs.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of GridFS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``mongodb_store_db`` = ``None`` + - (StrOpt) Database to use + * - ``mongodb_store_uri`` = ``None`` + - (StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost) diff --git a/doc/config-ref-rst/source/tables/glance-imagecache.rst b/doc/config-ref-rst/source/tables/glance-imagecache.rst new file mode 100644 index 0000000000..0e40c1b369 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-imagecache.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of flagmappings configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``delayed_delete`` = ``False`` + - (BoolOpt) Turn on/off delayed delete. + * - ``image_cache_dir`` = ``None`` + - (StrOpt) Base directory that the Image Cache uses. + * - ``image_cache_driver`` = ``sqlite`` + - (StrOpt) The driver to use for image cache management. + * - ``image_cache_max_size`` = ``10737418240`` + - (IntOpt) The upper limit (the maximum size of accumulated cache in bytes) beyond which pruner, if running, starts cleaning the images cache. + * - ``image_cache_sqlite_db`` = ``cache.db`` + - (StrOpt) The path to the sqlite file database that will be used for image cache management. + * - ``image_cache_stall_time`` = ``86400`` + - (IntOpt) The amount of time to let an image remain in the cache without being accessed. + * - ``scrub_pool_size`` = ``1`` + - (IntOpt) The size of thread pool to be used for scrubbing images. The default is one, which signifies serial scrubbing. Any value above one indicates the max number of images that may be scrubbed in parallel. + * - ``scrub_time`` = ``0`` + - (IntOpt) The amount of time in seconds to delay before performing a delete. diff --git a/doc/config-ref-rst/source/tables/glance-logging.rst b/doc/config-ref-rst/source/tables/glance-logging.rst new file mode 100644 index 0000000000..bbe00ece82 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/glance-policy.rst b/doc/config-ref-rst/source/tables/glance-policy.rst new file mode 100644 index 0000000000..3839d589e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-policy.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/glance-profiler.rst b/doc/config-ref-rst/source/tables/glance-profiler.rst new file mode 100644 index 0000000000..ac098424fd --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-profiler.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of profiler configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[profiler]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) If False fully disable profiling feature. + * - ``trace_sqlalchemy`` = ``False`` + - (BoolOpt) If False doesn't trace SQL requests. diff --git a/doc/config-ref-rst/source/tables/glance-qpid.rst b/doc/config-ref-rst/source/tables/glance-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/glance-rabbitmq.rst b/doc/config-ref-rst/source/tables/glance-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/glance-rbd.rst b/doc/config-ref-rst/source/tables/glance-rbd.rst new file mode 100644 index 0000000000..17443b19bb --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-rbd.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RADOS Block Devices (RBD) configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``rados_connect_timeout`` = ``0`` + - (IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value <= 0, no timeout is set and default librados value is used. + * - ``rbd_store_ceph_conf`` = ``/etc/ceph/ceph.conf`` + - (StrOpt) Ceph configuration file path. If , librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client. section + * - ``rbd_store_chunk_size`` = ``8`` + - (IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. + * - ``rbd_store_pool`` = ``images`` + - (StrOpt) RADOS pool in which images are stored. + * - ``rbd_store_user`` = ``None`` + - (StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If , a default will be chosen based on the client. section in rbd_store_ceph_conf) diff --git a/doc/config-ref-rst/source/tables/glance-redis.rst b/doc/config-ref-rst/source/tables/glance-redis.rst new file mode 100644 index 0000000000..ac62f687cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-redis.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/glance-registry.rst b/doc/config-ref-rst/source/tables/glance-registry.rst new file mode 100644 index 0000000000..6c7ec5c0eb --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-registry.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of registry configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. + * - ``admin_tenant_name`` = ``None`` + - (StrOpt) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. + * - ``admin_user`` = ``None`` + - (StrOpt) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. + * - ``auth_region`` = ``None`` + - (StrOpt) The region for the authentication service. If "use_user_token" is not in effect and using keystone auth, then region name can be specified. + * - ``auth_strategy`` = ``noauth`` + - (StrOpt) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. + * - ``auth_url`` = ``None`` + - (StrOpt) The URL to the keystone service. If "use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified. + * - ``registry_client_ca_file`` = ``None`` + - (StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file. + * - ``registry_client_cert_file`` = ``None`` + - (StrOpt) The path to the cert file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file + * - ``registry_client_insecure`` = ``False`` + - (BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API. + * - ``registry_client_key_file`` = ``None`` + - (StrOpt) The path to the key file to use in SSL connections to the registry server, if any. Alternately, you may set the GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file + * - ``registry_client_protocol`` = ``http`` + - (StrOpt) The protocol to use for communication with the registry server. Either http or https. + * - ``registry_client_timeout`` = ``600`` + - (IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout. + * - ``registry_host`` = ``0.0.0.0`` + - (StrOpt) Address to find the registry server. + * - ``registry_port`` = ``9191`` + - (PortOpt) Port the registry server is listening on. diff --git a/doc/config-ref-rst/source/tables/glance-replicator.rst b/doc/config-ref-rst/source/tables/glance-replicator.rst new file mode 100644 index 0000000000..fe3d54bca8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-replicator.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of replicator configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``args`` = ``None`` + - (ListOpt) Arguments for the command + * - ``chunksize`` = ``65536`` + - (IntOpt) Amount of data to transfer per HTTP write. + * - ``command`` = ``None`` + - (StrOpt) Command to be given to replicator + * - ``dontreplicate`` = ``created_at date deleted_at location updated_at`` + - (StrOpt) List of fields to not replicate. + * - ``mastertoken`` = ```` + - (StrOpt) Pass in your authentication token if you have one. This is the token used for the master. + * - ``metaonly`` = ``False`` + - (BoolOpt) Only replicate metadata, not images. + * - ``slavetoken`` = ```` + - (StrOpt) Pass in your authentication token if you have one. This is the token used for the slave. + * - ``token`` = ```` + - (StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave. diff --git a/doc/config-ref-rst/source/tables/glance-rpc.rst b/doc/config-ref-rst/source/tables/glance-rpc.rst new file mode 100644 index 0000000000..e14d8755db --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-rpc.rst @@ -0,0 +1,70 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allowed_rpc_exception_modules`` = ``glance.common.exception, builtins, exceptions`` + - (ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call. + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/glance-s3.rst b/doc/config-ref-rst/source/tables/glance-s3.rst new file mode 100644 index 0000000000..c13e037e35 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-s3.rst @@ -0,0 +1,48 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of S3 configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``s3_store_access_key`` = ``None`` + - (StrOpt) The S3 query token access key. + * - ``s3_store_bucket`` = ``None`` + - (StrOpt) The S3 bucket to be used to store the Glance data. + * - ``s3_store_bucket_url_format`` = ``subdomain`` + - (StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used. + * - ``s3_store_create_bucket_on_put`` = ``False`` + - (BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user. + * - ``s3_store_enable_proxy`` = ``False`` + - (BoolOpt) Enable the use of a proxy. + * - ``s3_store_host`` = ``None`` + - (StrOpt) The host where the S3 server is listening. + * - ``s3_store_large_object_chunk_size`` = ``10`` + - (IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M. + * - ``s3_store_large_object_size`` = ``100`` + - (IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3. + * - ``s3_store_object_buffer_dir`` = ``None`` + - (StrOpt) The local directory where uploads will be staged before they are transferred into S3. + * - ``s3_store_proxy_host`` = ``None`` + - (StrOpt) Address or hostname for the proxy server. + * - ``s3_store_proxy_password`` = ``None`` + - (StrOpt) The password to use when connecting over a proxy. + * - ``s3_store_proxy_port`` = ``8080`` + - (IntOpt) The port to use when connecting over a proxy. + * - ``s3_store_proxy_user`` = ``None`` + - (StrOpt) The username to connect to the proxy. + * - ``s3_store_secret_key`` = ``None`` + - (StrOpt) The S3 query token secret key. + * - ``s3_store_thread_pools`` = ``10`` + - (IntOpt) The number of thread pools to perform a multipart upload in S3. diff --git a/doc/config-ref-rst/source/tables/glance-scrubber.rst b/doc/config-ref-rst/source/tables/glance-scrubber.rst new file mode 100644 index 0000000000..c631090917 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-scrubber.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of scrubber configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``wakeup_time`` = ``300`` + - (IntOpt) Loop time between checking for new items to schedule for delete. diff --git a/doc/config-ref-rst/source/tables/glance-sheepdog.rst b/doc/config-ref-rst/source/tables/glance-sheepdog.rst new file mode 100644 index 0000000000..5eaa462249 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-sheepdog.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Sheepdog configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``sheepdog_store_address`` = ``localhost`` + - (StrOpt) IP address of sheep daemon. + * - ``sheepdog_store_chunk_size`` = ``64`` + - (IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two. + * - ``sheepdog_store_port`` = ``7000`` + - (IntOpt) Port of sheep daemon. diff --git a/doc/config-ref-rst/source/tables/glance-swift.rst b/doc/config-ref-rst/source/tables/glance-swift.rst new file mode 100644 index 0000000000..057648a1fd --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-swift.rst @@ -0,0 +1,72 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``default_swift_reference`` = ``ref1`` + - (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. + * - ``swift_store_auth_address`` = ``None`` + - (StrOpt) The address where the Swift authentication service is listening.(deprecated) + * - ``swift_store_config_file`` = ``None`` + - (StrOpt) The config file that has the swift account(s)configs. + * - ``swift_store_key`` = ``None`` + - (StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated) + * - ``swift_store_user`` = ``None`` + - (StrOpt) The user to authenticate against the Swift authentication service (deprecated) + * - **[glance_store]** + - + * - ``default_swift_reference`` = ``ref1`` + - (StrOpt) The reference to the default swift account/backing store parameters to use for adding new images. + * - ``swift_store_admin_tenants`` = ```` + - (ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode. + * - ``swift_store_auth_address`` = ``None`` + - (StrOpt) The address where the Swift authentication service is listening. (deprecated - use "auth_address" in swift_store_config_file) + * - ``swift_store_auth_insecure`` = ``False`` + - (BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating. + * - ``swift_store_auth_version`` = ``2`` + - (StrOpt) Version of the authentication service to use. Valid versions are 2 and 3 for keystone and 1 (deprecated) for swauth and rackspace. (deprecated - use "auth_version" in swift_store_config_file) + * - ``swift_store_cacert`` = ``None`` + - (StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs. + * - ``swift_store_config_file`` = ``None`` + - (StrOpt) The config file that has the swift account(s)configs. + * - ``swift_store_container`` = ``glance`` + - (StrOpt) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers. + * - ``swift_store_create_container_on_put`` = ``False`` + - (BoolOpt) A boolean value that determines if we create the container if it does not exist. + * - ``swift_store_endpoint`` = ``None`` + - (StrOpt) If set, the configured endpoint will be used. If None, the storage url from the auth response will be used. + * - ``swift_store_endpoint_type`` = ``publicURL`` + - (StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2. + * - ``swift_store_key`` = ``None`` + - (StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated - use "key" in swift_store_config_file) + * - ``swift_store_large_object_chunk_size`` = ``200`` + - (IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file. + * - ``swift_store_large_object_size`` = ``5120`` + - (IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift. + * - ``swift_store_multi_tenant`` = ``False`` + - (BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts. + * - ``swift_store_multiple_containers_seed`` = ``0`` + - (IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to 16^N, so if this config option is set to 2, then 16^2=256 containers will be used to store images. + * - ``swift_store_region`` = ``None`` + - (StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints. + * - ``swift_store_retry_get_count`` = ``0`` + - (IntOpt) The number of times a Swift download will be retried before the request fails. + * - ``swift_store_service_type`` = ``object-store`` + - (StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2. + * - ``swift_store_ssl_compression`` = ``True`` + - (BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2. + * - ``swift_store_user`` = ``None`` + - (StrOpt) The user to authenticate against the Swift authentication service (deprecated - use "user" in swift_store_config_file) diff --git a/doc/config-ref-rst/source/tables/glance-taskflow.rst b/doc/config-ref-rst/source/tables/glance-taskflow.rst new file mode 100644 index 0000000000..58064d2ef5 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-taskflow.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of TaskFlow configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[taskflow_executor]** + - + * - ``conversion_format`` = ``None`` + - (StrOpt) The format to which images will be automatically converted. + * - ``engine_mode`` = ``parallel`` + - (StrOpt) The mode in which the engine will run. Can be 'serial' or 'parallel'. + * - ``max_workers`` = ``10`` + - (IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is 'parallel'. diff --git a/doc/config-ref-rst/source/tables/glance-testing.rst b/doc/config-ref-rst/source/tables/glance-testing.rst new file mode 100644 index 0000000000..d3240c0697 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-testing.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of testing configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pydev_worker_debug_host`` = ``None`` + - (StrOpt) The hostname/IP of the pydev process listening for debug connections + * - ``pydev_worker_debug_port`` = ``5678`` + - (PortOpt) The port on which a pydev process is listening for connections. diff --git a/doc/config-ref-rst/source/tables/glance-vmware.rst b/doc/config-ref-rst/source/tables/glance-vmware.rst new file mode 100644 index 0000000000..72343bcc22 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-vmware.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VMware configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance_store]** + - + * - ``vmware_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to ESX/VC. + * - ``vmware_api_retry_count`` = ``10`` + - (IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues. + * - ``vmware_datacenter_path`` = ``ha-datacenter`` + - (StrOpt) DEPRECATED. Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter". This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release. + * - ``vmware_datastore_name`` = ``None`` + - (StrOpt) DEPRECATED. Datastore associated with the datacenter. This option is deprecated in favor of vmware_datastores and will be removed in the Liberty release. + * - ``vmware_datastores`` = ``None`` + - (MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores. Either one of vmware_datastore_name or vmware_datastores is required. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":". Thus, the required format becomes ::. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected. + * - ``vmware_server_host`` = ``None`` + - (StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name. + * - ``vmware_server_password`` = ``None`` + - (StrOpt) Password for authenticating with VMware ESX/VC server. + * - ``vmware_server_username`` = ``None`` + - (StrOpt) Username for authenticating with VMware ESX/VC server. + * - ``vmware_store_image_dir`` = ``/openstack_glance`` + - (StrOpt) The name of the directory where the glance images will be stored in the VMware datastore. + * - ``vmware_task_poll_interval`` = ``5`` + - (IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server. diff --git a/doc/config-ref-rst/source/tables/glance-zeromq.rst b/doc/config-ref-rst/source/tables/glance-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/glance-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/heat-amqp.rst b/doc/config-ref-rst/source/tables/heat-amqp.rst new file mode 100644 index 0000000000..777acd0514 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-amqp.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``default_notification_level`` = ``INFO`` + - (StrOpt) Default notification level for outgoing notifications. + * - ``default_publisher_id`` = ``None`` + - (StrOpt) Default publisher_id for outgoing notifications. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/heat-api.rst b/doc/config-ref-rst/source/tables/heat-api.rst new file mode 100644 index 0000000000..57e40b9d68 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-api.rst @@ -0,0 +1,124 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``action_retry_limit`` = ``5`` + - (IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries. + * - ``enable_stack_abandon`` = ``False`` + - (BoolOpt) Enable the preview Stack Abandon feature. + * - ``enable_stack_adopt`` = ``False`` + - (BoolOpt) Enable the preview Stack Adopt feature. + * - ``encrypt_parameters_and_properties`` = ``False`` + - (BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database. + * - ``heat_metadata_server_url`` = ```` + - (StrOpt) URL of the Heat metadata server. + * - ``heat_stack_user_role`` = ``heat_stack_user`` + - (StrOpt) Keystone role for heat template-defined users. + * - ``heat_waitcondition_server_url`` = ``None`` + - (StrOpt) URL of the Heat waitcondition server. + * - ``heat_watch_server_url`` = ```` + - (StrOpt) URL of the Heat CloudWatch server. + * - ``hidden_stack_tags`` = ``data-processing-cluster`` + - (ListOpt) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too). + * - ``max_json_body_size`` = ``1048576`` + - (IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size. + * - ``num_engine_workers`` = ``4`` + - (IntOpt) Number of heat-engine processes to fork and run. + * - ``stack_action_timeout`` = ``3600`` + - (IntOpt) Timeout in seconds for stack action (ie. create or update). + * - ``stack_domain_admin`` = ``None`` + - (StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain. + * - ``stack_domain_admin_password`` = ``None`` + - (StrOpt) Keystone password for stack_domain_admin user. + * - ``stack_scheduler_hints`` = ``False`` + - (BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id. + * - ``stack_user_domain_id`` = ``None`` + - (StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored. + * - ``stack_user_domain_name`` = ``None`` + - (StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored. + * - ``trusts_delegated_roles`` = ```` + - (ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack. + * - **[auth_password]** + - + * - ``allowed_auth_uris`` = ```` + - (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. + * - ``multi_cloud`` = ``False`` + - (BoolOpt) Allow orchestration of multiple clouds. + * - **[ec2authtoken]** + - + * - ``allowed_auth_uris`` = ```` + - (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified. + * - ``auth_uri`` = ``None`` + - (StrOpt) Authentication Endpoint URI. + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``insecure`` = ``False`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. + * - ``multi_cloud`` = ``False`` + - (BoolOpt) Allow orchestration of multiple clouds. + * - **[eventlet_opts]** + - + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + * - ``wsgi_keep_alive`` = ``True`` + - (BoolOpt) If False, closes the client socket connection explicitly. + * - **[heat_api]** + - + * - ``backlog`` = ``4096`` + - (IntOpt) Number of backlog requests to configure the socket with. + * - ``bind_host`` = ``0.0.0.0`` + - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + * - ``bind_port`` = ``8004`` + - (PortOpt) The port on which the server will listen. + * - ``cert_file`` = ``None`` + - (StrOpt) Location of the SSL certificate file to use for SSL mode. + * - ``key_file`` = ``None`` + - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``4`` + - (IntOpt) Number of workers for Heat service. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. + * - **[oslo_versionedobjects]** + - + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal + * - **[paste_deploy]** + - + * - ``api_paste_config`` = ``api-paste.ini`` + - (StrOpt) The API paste config file to use. + * - ``flavor`` = ``None`` + - (StrOpt) The flavor to use. diff --git a/doc/config-ref-rst/source/tables/heat-auth_token.rst b/doc/config-ref-rst/source/tables/heat-auth_token.rst new file mode 100644 index 0000000000..6865b79516 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-auth_token.rst @@ -0,0 +1,94 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/heat-cfn_api.rst b/doc/config-ref-rst/source/tables/heat-cfn_api.rst new file mode 100644 index 0000000000..c0f946ffb8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-cfn_api.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Cloudformation-compatible API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``instance_connection_https_validate_certificates`` = ``1`` + - (StrOpt) Instance connection to CFN/CW API validate certs if SSL is used. + * - ``instance_connection_is_secure`` = ``0`` + - (StrOpt) Instance connection to CFN/CW API via https. + * - **[heat_api_cfn]** + - + * - ``backlog`` = ``4096`` + - (IntOpt) Number of backlog requests to configure the socket with. + * - ``bind_host`` = ``0.0.0.0`` + - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + * - ``bind_port`` = ``8000`` + - (PortOpt) The port on which the server will listen. + * - ``cert_file`` = ``None`` + - (StrOpt) Location of the SSL certificate file to use for SSL mode. + * - ``key_file`` = ``None`` + - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``0`` + - (IntOpt) Number of workers for Heat service. diff --git a/doc/config-ref-rst/source/tables/heat-clients.rst b/doc/config-ref-rst/source/tables/heat-clients.rst new file mode 100644 index 0000000000..1b61aef9b4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``region_name_for_services`` = ``None`` + - (StrOpt) Default region name used to get services endpoints. + * - **[clients]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``publicURL`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``False`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_backends.rst b/doc/config-ref-rst/source/tables/heat-clients_backends.rst new file mode 100644 index 0000000000..c28620bbcf --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_backends.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of client backends configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cloud_backend`` = ``heat.engine.clients.OpenStackClients`` + - (StrOpt) Fully qualified class name to use as a client backend. diff --git a/doc/config-ref-rst/source/tables/heat-clients_ceilometer.rst b/doc/config-ref-rst/source/tables/heat-clients_ceilometer.rst new file mode 100644 index 0000000000..786fbd7cff --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_ceilometer.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ceilometer clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_ceilometer]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_cinder.rst b/doc/config-ref-rst/source/tables/heat-clients_cinder.rst new file mode 100644 index 0000000000..0f679c7e13 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_cinder.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cinder clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_cinder]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``http_log_debug`` = ``False`` + - (BoolOpt) Allow client's debug log output. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_glance.rst b/doc/config-ref-rst/source/tables/heat-clients_glance.rst new file mode 100644 index 0000000000..8e1b19cf33 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_glance.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of glance clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_glance]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_heat.rst b/doc/config-ref-rst/source/tables/heat-clients_heat.rst new file mode 100644 index 0000000000..ab9adf6d70 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_heat.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of heat clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_heat]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. + * - ``url`` = ```` + - (StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s. diff --git a/doc/config-ref-rst/source/tables/heat-clients_keystone.rst b/doc/config-ref-rst/source/tables/heat-clients_keystone.rst new file mode 100644 index 0000000000..ee007b13ee --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_keystone.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of keystone clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_keystone]** + - + * - ``auth_uri`` = ```` + - (StrOpt) Unversioned keystone url in format like http://0.0.0.0:5000. + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_neutron.rst b/doc/config-ref-rst/source/tables/heat-clients_neutron.rst new file mode 100644 index 0000000000..68379c1853 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_neutron.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of neutron clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_neutron]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_nova.rst b/doc/config-ref-rst/source/tables/heat-clients_nova.rst new file mode 100644 index 0000000000..c697b0c917 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_nova.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of nova clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_nova]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``http_log_debug`` = ``False`` + - (BoolOpt) Allow client's debug log output. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_sahara.rst b/doc/config-ref-rst/source/tables/heat-clients_sahara.rst new file mode 100644 index 0000000000..25b383f822 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_sahara.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of sahara clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_sahara]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_swift.rst b/doc/config-ref-rst/source/tables/heat-clients_swift.rst new file mode 100644 index 0000000000..97fe8a2c07 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_swift.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_swift]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-clients_trove.rst b/doc/config-ref-rst/source/tables/heat-clients_trove.rst new file mode 100644 index 0000000000..1e1f5d15c2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-clients_trove.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of trove clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[clients_trove]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) Optional CA cert file to use in SSL connections. + * - ``cert_file`` = ``None`` + - (StrOpt) Optional PEM-formatted certificate chain file. + * - ``endpoint_type`` = ``None`` + - (StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service. + * - ``insecure`` = ``None`` + - (BoolOpt) If set, then the server's certificate will not be verified. + * - ``key_file`` = ``None`` + - (StrOpt) Optional PEM-formatted file that contains the private key. diff --git a/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst b/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst new file mode 100644 index 0000000000..a8d35821bc --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-cloudwatch_api.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CloudWatch API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``enable_cloud_watch_lite`` = ``False`` + - (BoolOpt) Enable the legacy OS::Heat::CWLiteAlarm resource. + * - ``heat_watch_server_url`` = ```` + - (StrOpt) URL of the Heat CloudWatch server. + * - **[heat_api_cloudwatch]** + - + * - ``backlog`` = ``4096`` + - (IntOpt) Number of backlog requests to configure the socket with. + * - ``bind_host`` = ``0.0.0.0`` + - (IPOpt) Address to bind the server. Useful when selecting a particular network interface. + * - ``bind_port`` = ``8003`` + - (PortOpt) The port on which the server will listen. + * - ``cert_file`` = ``None`` + - (StrOpt) Location of the SSL certificate file to use for SSL mode. + * - ``key_file`` = ``None`` + - (StrOpt) Location of the SSL key file to use for enabling SSL mode. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.) + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes. + * - ``workers`` = ``0`` + - (IntOpt) Number of workers for Heat service. diff --git a/doc/config-ref-rst/source/tables/heat-common.rst b/doc/config-ref-rst/source/tables/heat-common.rst new file mode 100644 index 0000000000..43e9144884 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-common.rst @@ -0,0 +1,94 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``convergence_engine`` = ``False`` + - (BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine . + * - ``default_deployment_signal_transport`` = ``CFN_SIGNAL`` + - (StrOpt) Template default for how the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-api-cfn). TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL). HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. + * - ``default_software_config_transport`` = ``POLL_SERVER_CFN`` + - (StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling. + * - ``deferred_auth_method`` = ``trusts`` + - (StrOpt) Select deferred auth method, stored password or trusts. + * - ``environment_dir`` = ``/etc/heat/environment.d`` + - (StrOpt) The directory to search for environment files. + * - ``error_wait_time`` = ``240`` + - (IntOpt) Error wait time in seconds for stack action (ie. create or update). + * - ``event_purge_batch_size`` = ``10`` + - (IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``host`` = ``localhost`` + - (StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. + * - ``keystone_backend`` = ``heat.common.heat_keystoneclient.KeystoneClientV3`` + - (StrOpt) Fully qualified class name to use as a keystone backend. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``periodic_interval`` = ``60`` + - (IntOpt) Seconds between running periodic tasks. + * - ``plugin_dirs`` = ``/usr/lib64/heat, /usr/lib/heat, /usr/local/lib/heat, /usr/local/lib64/heat`` + - (ListOpt) List of directories to search for plug-ins. + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. + * - **[cache]** + - + * - ``backend`` = ``dogpile.cache.null`` + - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + * - ``backend_argument`` = ``[]`` + - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + * - ``config_prefix`` = ``cache.oslo`` + - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + * - ``debug_cache_backend`` = ``False`` + - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + * - ``enabled`` = ``False`` + - (BoolOpt) Global toggle for caching. + * - ``expiration_time`` = ``600`` + - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + * - ``memcache_dead_retry`` = ``300`` + - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``memcache_pool_connection_get_timeout`` = ``10`` + - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + * - ``memcache_servers`` = ``localhost:11211`` + - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``memcache_socket_timeout`` = ``3`` + - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``proxies`` = ```` + - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + * - **[constraint_validation_cache]** + - + * - ``caching`` = ``True`` + - (BoolOpt) Toggle to enable/disable caching when Orchestration Engine validates property constraints of stack.During property validation with constraints Orchestration Engine caches requests to other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. + * - ``expiration_time`` = ``60`` + - (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of validation constraints. + * - **[revision]** + - + * - ``heat_revision`` = ``unknown`` + - (StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option. + * - **[service_extension_cache]** + - + * - ``caching`` = ``True`` + - (BoolOpt) Toggle to enable/disable caching when Orchestration Engine retrieves extensions from other OpenStack services. Please note that the global toggle for oslo.cache(enabled=True in [cache] group) must be enabled to use this feature. + * - ``expiration_time`` = ``3600`` + - (IntOpt) TTL, in seconds, for any cached item in the dogpile.cache region used for caching of service extensions. diff --git a/doc/config-ref-rst/source/tables/heat-cors.rst b/doc/config-ref-rst/source/tables/heat-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/heat-crypt.rst b/doc/config-ref-rst/source/tables/heat-crypt.rst new file mode 100644 index 0000000000..00556285cd --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-crypt.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of crypt configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``auth_encryption_key`` = ``notgood but just long enough i t`` + - (StrOpt) Key used to encrypt authentication info in the database. Length of this key must be 32 characters. diff --git a/doc/config-ref-rst/source/tables/heat-database.rst b/doc/config-ref-rst/source/tables/heat-database.rst new file mode 100644 index 0000000000..fe0826d256 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-database.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/heat-loadbalancer.rst b/doc/config-ref-rst/source/tables/heat-loadbalancer.rst new file mode 100644 index 0000000000..e9026eb748 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-loadbalancer.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of load balancer configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``loadbalancer_template`` = ``None`` + - (StrOpt) Custom template for the built-in loadbalancer nested stack. diff --git a/doc/config-ref-rst/source/tables/heat-logging.rst b/doc/config-ref-rst/source/tables/heat-logging.rst new file mode 100644 index 0000000000..4acc74cfcc --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-logging.rst @@ -0,0 +1,60 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. diff --git a/doc/config-ref-rst/source/tables/heat-metadata_api.rst b/doc/config-ref-rst/source/tables/heat-metadata_api.rst new file mode 100644 index 0000000000..c1032a3cfc --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-metadata_api.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of metadata API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``heat_metadata_server_url`` = ```` + - (StrOpt) URL of the Heat metadata server. diff --git a/doc/config-ref-rst/source/tables/heat-notification.rst b/doc/config-ref-rst/source/tables/heat-notification.rst new file mode 100644 index 0000000000..f8bace66b8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-notification.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of notification configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``onready`` = ``None`` + - (StrOpt) Deprecated. diff --git a/doc/config-ref-rst/source/tables/heat-qpid.rst b/doc/config-ref-rst/source/tables/heat-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/heat-quota.rst b/doc/config-ref-rst/source/tables/heat-quota.rst new file mode 100644 index 0000000000..f708cf8c9b --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-quota.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of quota configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``max_events_per_stack`` = ``1000`` + - (IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack. + * - ``max_nested_stack_depth`` = ``5`` + - (IntOpt) Maximum depth allowed when using nested stacks. + * - ``max_resources_per_stack`` = ``1000`` + - (IntOpt) Maximum resources allowed per top-level stack. -1 stands for unlimited. + * - ``max_stacks_per_tenant`` = ``100`` + - (IntOpt) Maximum number of stacks any one tenant may have active at one time. + * - ``max_template_size`` = ``524288`` + - (IntOpt) Maximum raw byte size of any template. diff --git a/doc/config-ref-rst/source/tables/heat-rabbitmq.rst b/doc/config-ref-rst/source/tables/heat-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/heat-redis.rst b/doc/config-ref-rst/source/tables/heat-redis.rst new file mode 100644 index 0000000000..dca6654f9c --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-redis.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/heat-rpc.rst b/doc/config-ref-rst/source/tables/heat-rpc.rst new file mode 100644 index 0000000000..394b301956 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-rpc.rst @@ -0,0 +1,70 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``engine_life_check_timeout`` = ``2`` + - (IntOpt) RPC timeout for the engine liveness check that is used for stack locking. + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/heat-testing.rst b/doc/config-ref-rst/source/tables/heat-testing.rst new file mode 100644 index 0000000000..4748d221d0 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-testing.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of testing configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[profiler]** + - + * - ``profiler_enabled`` = ``False`` + - (BoolOpt) If False fully disable profiling feature. + * - ``trace_sqlalchemy`` = ``False`` + - (BoolOpt) If False do not trace SQL requests. diff --git a/doc/config-ref-rst/source/tables/heat-trustee.rst b/doc/config-ref-rst/source/tables/heat-trustee.rst new file mode 100644 index 0000000000..cfc6f7c7ba --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-trustee.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of trustee configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[trustee]** + - + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options diff --git a/doc/config-ref-rst/source/tables/heat-waitcondition_api.rst b/doc/config-ref-rst/source/tables/heat-waitcondition_api.rst new file mode 100644 index 0000000000..d14f541afe --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-waitcondition_api.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of waitcondition API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``heat_waitcondition_server_url`` = ``None`` + - (StrOpt) URL of the Heat waitcondition server. diff --git a/doc/config-ref-rst/source/tables/heat-zeromq.rst b/doc/config-ref-rst/source/tables/heat-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/heat-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/ironic-agent.rst b/doc/config-ref-rst/source/tables/ironic-agent.rst new file mode 100644 index 0000000000..bd9a64835b --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-agent.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of agent configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[agent]** + - + * - ``agent_api_version`` = ``v1`` + - (StrOpt) API version to use for communicating with the ramdisk agent. + * - ``agent_pxe_append_params`` = ``nofb nomodeset vga=normal`` + - (StrOpt) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead. + * - ``agent_pxe_config_template`` = ``$pybasedir/drivers/modules/agent_config.template`` + - (StrOpt) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. + * - ``heartbeat_timeout`` = ``300`` + - (IntOpt) Maximum interval (in seconds) for agent heartbeats. + * - ``manage_agent_boot`` = ``True`` + - (BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. + * - ``memory_consumed_by_agent`` = ``0`` + - (IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. + * - ``post_deploy_get_power_state_retries`` = ``6`` + - (IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. + * - ``post_deploy_get_power_state_retry_interval`` = ``5`` + - (IntOpt) Amount of time (in seconds) to wait between polling power state after trigger soft poweroff. diff --git a/doc/config-ref-rst/source/tables/ironic-amqp.rst b/doc/config-ref-rst/source/tables/ironic-amqp.rst new file mode 100644 index 0000000000..84ac08e209 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-amqp.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/ironic-amt.rst b/doc/config-ref-rst/source/tables/ironic-amt.rst new file mode 100644 index 0000000000..9705e244ac --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-amt.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMT configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[amt]** + - + * - ``action_wait`` = ``10`` + - (IntOpt) Amount of time (in seconds) to wait, before retrying an AMT operation + * - ``max_attempts`` = ``3`` + - (IntOpt) Maximum number of times to attempt an AMT operation, before failing + * - ``protocol`` = ``http`` + - (StrOpt) Protocol used for AMT endpoint, support http/https diff --git a/doc/config-ref-rst/source/tables/ironic-api.rst b/doc/config-ref-rst/source/tables/ironic-api.rst new file mode 100644 index 0000000000..8a55004d5b --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-api.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[api]** + - + * - ``host_ip`` = ``0.0.0.0`` + - (StrOpt) The IP address on which ironic-api listens. + * - ``max_limit`` = ``1000`` + - (IntOpt) The maximum number of items returned in a single response from a collection resource. + * - ``port`` = ``6385`` + - (PortOpt) The TCP port on which ironic-api listens. + * - ``public_endpoint`` = ``None`` + - (StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[oslo_versionedobjects]** + - + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal diff --git a/doc/config-ref-rst/source/tables/ironic-auth.rst b/doc/config-ref-rst/source/tables/ironic-auth.rst new file mode 100644 index 0000000000..1cfc88e964 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-auth.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) Authentication strategy used by ironic-api: one of "keystone" or "noauth". "noauth" should not be used in a production environment because all authentication will be disabled. diff --git a/doc/config-ref-rst/source/tables/ironic-auth_token.rst b/doc/config-ref-rst/source/tables/ironic-auth_token.rst new file mode 100644 index 0000000000..6865b79516 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-auth_token.rst @@ -0,0 +1,94 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/ironic-cisco_ucs.rst b/doc/config-ref-rst/source/tables/ironic-cisco_ucs.rst new file mode 100644 index 0000000000..aa36fbdf60 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-cisco_ucs.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Cisco UCS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cimc]** + - + * - ``action_interval`` = ``10`` + - (IntOpt) Amount of time in seconds to wait in between power operations + * - ``max_retry`` = ``6`` + - (IntOpt) Number of times a power operation needs to be retried + * - **[cisco_ucs]** + - + * - ``action_interval`` = ``5`` + - (IntOpt) Amount of time in seconds to wait in between power operations + * - ``max_retry`` = ``6`` + - (IntOpt) Number of times a power operation needs to be retried diff --git a/doc/config-ref-rst/source/tables/ironic-common.rst b/doc/config-ref-rst/source/tables/ironic-common.rst new file mode 100644 index 0000000000..b36acf3236 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-common.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``bindir`` = ``/usr/local/bin`` + - (StrOpt) Directory where ironic binaries are installed. + * - ``enabled_drivers`` = ``pxe_ipmitool`` + - (ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``force_raw_images`` = ``True`` + - (BoolOpt) If True, convert backing images to "raw" disk image format. + * - ``grub_config_template`` = ``$pybasedir/common/grub_conf.template`` + - (StrOpt) Template file for grub configuration file. + * - ``hash_distribution_replicas`` = ``1`` + - (IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated. + * - ``hash_partition_exponent`` = ``5`` + - (IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact. + * - ``hash_ring_reset_interval`` = ``180`` + - (IntOpt) Interval (in seconds) between hash ring resets. + * - ``host`` = ``shock.local.net`` + - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. + * - ``isolinux_bin`` = ``/usr/lib/syslinux/isolinux.bin`` + - (StrOpt) Path to isolinux binary file. + * - ``isolinux_config_template`` = ``$pybasedir/common/isolinux_config.template`` + - (StrOpt) Template file for isolinux configuration file. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``my_ip`` = ``10.0.0.1`` + - (StrOpt) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". + * - ``parallel_image_downloads`` = ``False`` + - (BoolOpt) Run image downloads and raw format conversions in parallel. + * - ``periodic_interval`` = ``60`` + - (IntOpt) Seconds between running periodic tasks. + * - ``pybasedir`` = ``/usr/lib/python/site-packages/ironic/ironic`` + - (StrOpt) Directory where the ironic python module is installed. + * - ``rootwrap_config`` = ``/etc/ironic/rootwrap.conf`` + - (StrOpt) Path to the rootwrap configuration file to use for running commands as root. + * - ``state_path`` = ``$pybasedir`` + - (StrOpt) Top-level directory for maintaining ironic's state. + * - ``tempdir`` = ``/tmp`` + - (StrOpt) Temporary working directory, default is Python temp dir. diff --git a/doc/config-ref-rst/source/tables/ironic-conductor.rst b/doc/config-ref-rst/source/tables/ironic-conductor.rst new file mode 100644 index 0000000000..16f3623b71 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-conductor.rst @@ -0,0 +1,60 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of conductor configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[conductor]** + - + * - ``api_url`` = ``None`` + - (StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog. + * - ``check_provision_state_interval`` = ``60`` + - (IntOpt) Interval between checks of provision timeouts, in seconds. + * - ``clean_callback_timeout`` = ``1800`` + - (IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. + * - ``clean_nodes`` = ``True`` + - (BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a "managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. + * - ``configdrive_swift_container`` = ``ironic_configdrive_container`` + - (StrOpt) Name of the Swift container to store config drive data. Used when configdrive_use_swift is True. + * - ``configdrive_use_swift`` = ``False`` + - (BoolOpt) Whether to upload the config drive to Swift. + * - ``deploy_callback_timeout`` = ``1800`` + - (IntOpt) Timeout (seconds) to wait for a callback from a deploy ramdisk. Set to 0 to disable timeout. + * - ``force_power_state_during_sync`` = ``True`` + - (BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False). + * - ``heartbeat_interval`` = ``10`` + - (IntOpt) Seconds between conductor heart beats. + * - ``heartbeat_timeout`` = ``60`` + - (IntOpt) Maximum time (in seconds) since the last check-in of a conductor. A conductor is considered inactive when this time has been exceeded. + * - ``inspect_timeout`` = ``1800`` + - (IntOpt) Timeout (seconds) for waiting for node inspection. 0 - unlimited. + * - ``node_locked_retry_attempts`` = ``3`` + - (IntOpt) Number of attempts to grab a node lock. + * - ``node_locked_retry_interval`` = ``1`` + - (IntOpt) Seconds to sleep between node lock attempts. + * - ``periodic_max_workers`` = ``8`` + - (IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size. + * - ``power_state_sync_max_retries`` = ``3`` + - (IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB + * - ``send_sensor_data`` = ``False`` + - (BoolOpt) Enable sending sensor data message via the notification bus + * - ``send_sensor_data_interval`` = ``600`` + - (IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus. + * - ``send_sensor_data_types`` = ``ALL`` + - (ListOpt) List of comma separated meter types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data. + * - ``sync_local_state_interval`` = ``180`` + - (IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely. + * - ``sync_power_state_interval`` = ``60`` + - (IntOpt) Interval between syncing the node power state to the database, in seconds. + * - ``workers_pool_size`` = ``100`` + - (IntOpt) The size of the workers greenthread pool. diff --git a/doc/config-ref-rst/source/tables/ironic-console.rst b/doc/config-ref-rst/source/tables/ironic-console.rst new file mode 100644 index 0000000000..5420fa695e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-console.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of console configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[console]** + - + * - ``subprocess_checking_interval`` = ``1`` + - (IntOpt) Time interval (in seconds) for checking the status of console subprocess. + * - ``subprocess_timeout`` = ``10`` + - (IntOpt) Time (in seconds) to wait for the console subprocess to start. + * - ``terminal`` = ``shellinaboxd`` + - (StrOpt) Path to serial console terminal program + * - ``terminal_cert_dir`` = ``None`` + - (StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access + * - ``terminal_pid_dir`` = ``None`` + - (StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used. diff --git a/doc/config-ref-rst/source/tables/ironic-database.rst b/doc/config-ref-rst/source/tables/ironic-database.rst new file mode 100644 index 0000000000..8aa43190d7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-database.rst @@ -0,0 +1,60 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_engine`` = ``InnoDB`` + - (StrOpt) MySQL engine to use. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/ironic-debug.rst b/doc/config-ref-rst/source/tables/ironic-debug.rst new file mode 100644 index 0000000000..a6be4699c5 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-debug.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pecan_debug`` = ``False`` + - (BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in a production environment. diff --git a/doc/config-ref-rst/source/tables/ironic-deploy.rst b/doc/config-ref-rst/source/tables/ironic-deploy.rst new file mode 100644 index 0000000000..cf1de0d303 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-deploy.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of deploy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[deploy]** + - + * - ``dd_block_size`` = ``1M`` + - (StrOpt) Block size to use when writing to the nodes disk. + * - ``efi_system_partition_size`` = ``200`` + - (IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot. + * - ``erase_devices_iterations`` = ``1`` + - (IntOpt) Number of iterations to be run for erasing devices. + * - ``erase_devices_priority`` = ``None`` + - (IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. + * - ``http_root`` = ``/httpboot`` + - (StrOpt) ironic-conductor node's HTTP root path. + * - ``http_url`` = ``None`` + - (StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 + * - ``iscsi_verify_attempts`` = ``3`` + - (IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. diff --git a/doc/config-ref-rst/source/tables/ironic-dhcp.rst b/doc/config-ref-rst/source/tables/ironic-dhcp.rst new file mode 100644 index 0000000000..856627ce5c --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-dhcp.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of DHCP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[dhcp]** + - + * - ``dhcp_provider`` = ``neutron`` + - (StrOpt) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider. diff --git a/doc/config-ref-rst/source/tables/ironic-disk_partitioner.rst b/doc/config-ref-rst/source/tables/ironic-disk_partitioner.rst new file mode 100644 index 0000000000..a00a476540 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-disk_partitioner.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of disk partitioner configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[disk_partitioner]** + - + * - ``check_device_interval`` = ``1`` + - (IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds + * - ``check_device_max_retries`` = ``20`` + - (IntOpt) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. diff --git a/doc/config-ref-rst/source/tables/ironic-drac.rst b/doc/config-ref-rst/source/tables/ironic-drac.rst new file mode 100644 index 0000000000..40a755e245 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-drac.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of DRAC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[drac]** + - + * - ``client_retry_count`` = ``5`` + - (IntOpt) In case there is a communication failure, the DRAC client resends the request as many times as defined in this setting. + * - ``client_retry_delay`` = ``5`` + - (IntOpt) In case there is a communication failure, the DRAC client waits for as many seconds as defined in this setting before resending the request. diff --git a/doc/config-ref-rst/source/tables/ironic-glance.rst b/doc/config-ref-rst/source/tables/ironic-glance.rst new file mode 100644 index 0000000000..fbea91dd21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-glance.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of glance configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[glance]** + - + * - ``allowed_direct_url_schemes`` = ```` + - (ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) Authentication strategy to use when connecting to glance. Only "keystone" and "noauth" are currently supported by ironic. + * - ``glance_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL (https) requests to glance. + * - ``glance_api_servers`` = ``None`` + - (ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port. + * - ``glance_host`` = ``$my_ip`` + - (StrOpt) Default glance hostname or IP address. + * - ``glance_num_retries`` = ``0`` + - (IntOpt) Number of retries when downloading an image from glance. + * - ``glance_port`` = ``9292`` + - (PortOpt) Default glance port. + * - ``glance_protocol`` = ``http`` + - (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. + * - ``swift_account`` = ``None`` + - (StrOpt) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs when Glance backend is Swift. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + * - ``swift_api_version`` = ``v1`` + - (StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + * - ``swift_container`` = ``glance`` + - (StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" + * - ``swift_endpoint_url`` = ``None`` + - (StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/[account/]container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". If using RADOS Gateway, endpoint may also contain /swift path; if it does not, it will be appended. Required for temporary URLs. + * - ``swift_store_multiple_containers_seed`` = ``0`` + - (IntOpt) This should match a config by the same name in the Glance configuration file. When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created. + * - ``swift_temp_url_duration`` = ``1200`` + - (IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration. + * - ``swift_temp_url_key`` = ``None`` + - (StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. + * - ``temp_url_endpoint_type`` = ``swift`` + - (StrOpt) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw". diff --git a/doc/config-ref-rst/source/tables/ironic-iboot.rst b/doc/config-ref-rst/source/tables/ironic-iboot.rst new file mode 100644 index 0000000000..8c4d47b72e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-iboot.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of iBoot Web Power Switch configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[iboot]** + - + * - ``max_retry`` = ``3`` + - (IntOpt) Maximum retries for iBoot operations + * - ``reboot_delay`` = ``5`` + - (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again). + * - ``retry_interval`` = ``1`` + - (IntOpt) Time (in seconds) between retry attempts for iBoot operations diff --git a/doc/config-ref-rst/source/tables/ironic-ilo.rst b/doc/config-ref-rst/source/tables/ironic-ilo.rst new file mode 100644 index 0000000000..5a425f5040 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-ilo.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of iLO configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ilo]** + - + * - ``clean_priority_clear_secure_boot_keys`` = ``0`` + - (IntOpt) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to to clear all secure boot keys enrolled with iLO. + * - ``clean_priority_erase_devices`` = ``None`` + - (IntOpt) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. + * - ``clean_priority_reset_bios_to_default`` = ``10`` + - (IntOpt) Priority for reset_bios_to_default clean step. + * - ``clean_priority_reset_ilo`` = ``1`` + - (IntOpt) Priority for reset_ilo clean step. + * - ``clean_priority_reset_ilo_credential`` = ``30`` + - (IntOpt) Priority for reset_ilo_credential clean step. This step requires "ilo_change_password" parameter to be updated in nodes's driver_info with the new password. + * - ``clean_priority_reset_secure_boot_keys_to_default`` = ``20`` + - (IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults. + * - ``client_port`` = ``443`` + - (PortOpt) Port to be used for iLO operations + * - ``client_timeout`` = ``60`` + - (IntOpt) Timeout (in seconds) for iLO operations + * - ``power_retry`` = ``6`` + - (IntOpt) Number of times a power operation needs to be retried + * - ``power_wait`` = ``2`` + - (IntOpt) Amount of time in seconds to wait in between power operations + * - ``swift_ilo_container`` = ``ironic_ilo_container`` + - (StrOpt) The Swift iLO container to store data. + * - ``swift_object_expiry_timeout`` = ``900`` + - (IntOpt) Amount of time in seconds for Swift objects to auto-expire. + * - ``use_web_server_for_images`` = ``False`` + - (BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. diff --git a/doc/config-ref-rst/source/tables/ironic-inspector.rst b/doc/config-ref-rst/source/tables/ironic-inspector.rst new file mode 100644 index 0000000000..23f684f96b --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-inspector.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of inspector configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[inspector]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) whether to enable inspection using ironic-inspector + * - ``service_url`` = ``None`` + - (StrOpt) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. + * - ``status_check_period`` = ``60`` + - (IntOpt) period (in seconds) to check status of nodes on inspection diff --git a/doc/config-ref-rst/source/tables/ironic-ipmi.rst b/doc/config-ref-rst/source/tables/ironic-ipmi.rst new file mode 100644 index 0000000000..c8e96c7056 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-ipmi.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IPMI configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ipmi]** + - + * - ``min_command_interval`` = ``5`` + - (IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. + * - ``retry_timeout`` = ``60`` + - (IntOpt) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. diff --git a/doc/config-ref-rst/source/tables/ironic-irmc.rst b/doc/config-ref-rst/source/tables/ironic-irmc.rst new file mode 100644 index 0000000000..477cd9840e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-irmc.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of iRMC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[irmc]** + - + * - ``auth_method`` = ``basic`` + - (StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest" + * - ``client_timeout`` = ``60`` + - (IntOpt) Timeout (in seconds) for iRMC operations + * - ``port`` = ``443`` + - (PortOpt) Port to be used for iRMC operations, either 80 or 443 + * - ``remote_image_server`` = ``None`` + - (StrOpt) IP of remote image server + * - ``remote_image_share_name`` = ``share`` + - (StrOpt) share name of remote_image_server + * - ``remote_image_share_root`` = ``/remote_image_share_root`` + - (StrOpt) Ironic conductor node's "NFS" or "CIFS" root path + * - ``remote_image_share_type`` = ``CIFS`` + - (StrOpt) Share type of virtual media, either "NFS" or "CIFS" + * - ``remote_image_user_domain`` = ```` + - (StrOpt) Domain name of remote_image_user_name + * - ``remote_image_user_name`` = ``None`` + - (StrOpt) User name of remote_image_server + * - ``remote_image_user_password`` = ``None`` + - (StrOpt) Password of remote_image_user_name + * - ``sensor_method`` = ``ipmitool`` + - (StrOpt) Sensor data retrieval method, either "ipmitool" or "scci" diff --git a/doc/config-ref-rst/source/tables/ironic-keystone.rst b/doc/config-ref-rst/source/tables/ironic-keystone.rst new file mode 100644 index 0000000000..aadb6f1c2f --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-keystone.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of keystone configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone]** + - + * - ``region_name`` = ``None`` + - (StrOpt) The region used for getting endpoints of OpenStack services. diff --git a/doc/config-ref-rst/source/tables/ironic-logging.rst b/doc/config-ref-rst/source/tables/ironic-logging.rst new file mode 100644 index 0000000000..0ef7dd239a --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/ironic-neutron.rst b/doc/config-ref-rst/source/tables/ironic-neutron.rst new file mode 100644 index 0000000000..d6bc5342c4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-neutron.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of neutron configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[neutron]** + - + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) Default authentication strategy to use when connecting to neutron. Can be either "keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. + * - ``cleaning_network_uuid`` = ``None`` + - (StrOpt) UUID of the network to create Neutron ports on when booting to a ramdisk for cleaning/zapping using Neutron DHCP + * - ``retries`` = ``3`` + - (IntOpt) Client retries in the case of a failed request. + * - ``url`` = ``http://$my_ip:9696`` + - (StrOpt) URL for connecting to neutron. + * - ``url_timeout`` = ``30`` + - (IntOpt) Timeout value for connecting to neutron in seconds. diff --git a/doc/config-ref-rst/source/tables/ironic-oneview.rst b/doc/config-ref-rst/source/tables/ironic-oneview.rst new file mode 100644 index 0000000000..883c8370b2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-oneview.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of OneView configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oneview]** + - + * - ``allow_insecure_connections`` = ``False`` + - (BoolOpt) Option to allow insecure connection with OneView + * - ``manager_url`` = ``None`` + - (StrOpt) URL where OneView is available + * - ``max_polling_attempts`` = ``12`` + - (IntOpt) Max connection retries to check changes on OneView + * - ``password`` = ``None`` + - (StrOpt) OneView password to be used + * - ``tls_cacert_file`` = ``None`` + - (StrOpt) Path to CA certificate + * - ``username`` = ``None`` + - (StrOpt) OneView username to be used diff --git a/doc/config-ref-rst/source/tables/ironic-policy.rst b/doc/config-ref-rst/source/tables/ironic-policy.rst new file mode 100644 index 0000000000..3839d589e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-policy.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/ironic-pxe.rst b/doc/config-ref-rst/source/tables/ironic-pxe.rst new file mode 100644 index 0000000000..ece28629b1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-pxe.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of PXE configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[pxe]** + - + * - ``default_ephemeral_format`` = ``ext4`` + - (StrOpt) Default file system format for ephemeral partition, if one is created. + * - ``disk_devices`` = ``cciss/c0d0,sda,hda,vda`` + - (StrOpt) The disk devices to scan while doing the deploy. + * - ``image_cache_size`` = ``20480`` + - (IntOpt) Maximum size (in MiB) of cache for master images, including those in use. + * - ``image_cache_ttl`` = ``10080`` + - (IntOpt) Maximum TTL (in minutes) for old master images in cache. + * - ``images_path`` = ``/var/lib/ironic/images/`` + - (StrOpt) On the ironic-conductor node, directory where images are stored on disk. + * - ``instance_master_path`` = ``/var/lib/ironic/master_images`` + - (StrOpt) On the ironic-conductor node, directory where master instance images are stored on disk. + * - ``ip_version`` = ``4`` + - (StrOpt) The IP version that will be used for PXE booting. Can be either 4 or 6. Defaults to 4. EXPERIMENTAL + * - ``ipxe_boot_script`` = ``$pybasedir/drivers/modules/boot.ipxe`` + - (StrOpt) On ironic-conductor node, the path to the main iPXE script file. + * - ``ipxe_enabled`` = ``False`` + - (BoolOpt) Enable iPXE boot. + * - ``pxe_append_params`` = ``nofb nomodeset vga=normal`` + - (StrOpt) Additional append parameters for baremetal PXE boot. + * - ``pxe_bootfile_name`` = ``pxelinux.0`` + - (StrOpt) Bootfile DHCP parameter. + * - ``pxe_config_template`` = ``$pybasedir/drivers/modules/pxe_config.template`` + - (StrOpt) On ironic-conductor node, template file for PXE configuration. + * - ``tftp_master_path`` = ``/tftpboot/master_images`` + - (StrOpt) On ironic-conductor node, directory where master TFTP images are stored on disk. + * - ``tftp_root`` = ``/tftpboot`` + - (StrOpt) ironic-conductor node's TFTP root path. The ironic-conductor must have read/write access to this path. + * - ``tftp_server`` = ``$my_ip`` + - (StrOpt) IP address of ironic-conductor node's TFTP server. + * - ``uefi_pxe_bootfile_name`` = ``elilo.efi`` + - (StrOpt) Bootfile DHCP parameter for UEFI boot mode. + * - ``uefi_pxe_config_template`` = ``$pybasedir/drivers/modules/elilo_efi_pxe_config.template`` + - (StrOpt) On ironic-conductor node, template file for PXE configuration for UEFI boot loader. diff --git a/doc/config-ref-rst/source/tables/ironic-qpid.rst b/doc/config-ref-rst/source/tables/ironic-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/ironic-rabbitmq.rst b/doc/config-ref-rst/source/tables/ironic-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/ironic-redis.rst b/doc/config-ref-rst/source/tables/ironic-redis.rst new file mode 100644 index 0000000000..75a290f1d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-redis.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/ironic-rpc.rst b/doc/config-ref-rst/source/tables/ironic-rpc.rst new file mode 100644 index 0000000000..cbdd71c8fc --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-rpc.rst @@ -0,0 +1,68 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/ironic-seamicro.rst b/doc/config-ref-rst/source/tables/ironic-seamicro.rst new file mode 100644 index 0000000000..0240fe727d --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-seamicro.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SeaMicro configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[seamicro]** + - + * - ``action_timeout`` = ``10`` + - (IntOpt) Seconds to wait for power action to be completed + * - ``max_retry`` = ``3`` + - (IntOpt) Maximum retries for SeaMicro operations diff --git a/doc/config-ref-rst/source/tables/ironic-snmp.rst b/doc/config-ref-rst/source/tables/ironic-snmp.rst new file mode 100644 index 0000000000..54595cb55e --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-snmp.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SNMP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[snmp]** + - + * - ``power_timeout`` = ``10`` + - (IntOpt) Seconds to wait for power action to be completed + * - ``reboot_delay`` = ``0`` + - (IntOpt) Time (in seconds) to sleep between when rebooting (powering off and on again) diff --git a/doc/config-ref-rst/source/tables/ironic-ssh.rst b/doc/config-ref-rst/source/tables/ironic-ssh.rst new file mode 100644 index 0000000000..588f804ee5 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-ssh.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SSH configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ssh]** + - + * - ``get_vm_name_attempts`` = ``3`` + - (IntOpt) Number of attempts to try to get VM name used by the host that corresponds to a node's MAC address. + * - ``get_vm_name_retry_interval`` = ``3`` + - (IntOpt) Number of seconds to wait between attempts to get VM name used by the host that corresponds to a node's MAC address. + * - ``libvirt_uri`` = ``qemu:///system`` + - (StrOpt) libvirt URI. diff --git a/doc/config-ref-rst/source/tables/ironic-swift.rst b/doc/config-ref-rst/source/tables/ironic-swift.rst new file mode 100644 index 0000000000..57a159ee3d --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-swift.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[swift]** + - + * - ``swift_max_retries`` = ``2`` + - (IntOpt) Maximum number of times to retry a Swift request, before failing. diff --git a/doc/config-ref-rst/source/tables/ironic-virtualbox.rst b/doc/config-ref-rst/source/tables/ironic-virtualbox.rst new file mode 100644 index 0000000000..126e4fc380 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-virtualbox.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VirtualBox configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[virtualbox]** + - + * - ``port`` = ``18083`` + - (PortOpt) Port on which VirtualBox web service is listening. diff --git a/doc/config-ref-rst/source/tables/ironic-zeromq.rst b/doc/config-ref-rst/source/tables/ironic-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/ironic-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/keystone-amqp.rst b/doc/config-ref-rst/source/tables/keystone-amqp.rst new file mode 100644 index 0000000000..52f0b4887e --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-amqp.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``keystone`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``default_publisher_id`` = ``None`` + - (StrOpt) Default publisher_id for outgoing notifications + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_format`` = ``basic`` + - (StrOpt) Define the notification format for Identity Service events. A "basic" notification has information about the resource being operated on. A "cadf" notification has the same information, as well as information about the initiator of the event. + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/keystone-api.rst b/doc/config-ref-rst/source/tables/keystone-api.rst new file mode 100644 index 0000000000..2c9b96c049 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-api.rst @@ -0,0 +1,96 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``admin_endpoint`` = ``None`` + - (StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. + * - ``admin_token`` = ``ADMIN`` + - (StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). + * - ``domain_id_immutable`` = ``True`` + - (BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). + * - ``list_limit`` = ``None`` + - (IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). + * - ``max_param_size`` = ``64`` + - (IntOpt) Limit the sizes of user & project ID/names. + * - ``max_project_tree_depth`` = ``5`` + - (IntOpt) Maximum depth of the project hierarchy. WARNING: setting it to a large value may adversely impact performance. + * - ``max_token_size`` = ``8192`` + - (IntOpt) Similar to max_param_size, but provides an exception for token values. + * - ``member_role_id`` = ``9fe2ff9ee4384b1894a90878d3e92bab`` + - (StrOpt) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2 API. This will be used as the explicit role where one is not specified by the v2 API. + * - ``member_role_name`` = ``_member_`` + - (StrOpt) This is the role name used in combination with the member_role_id option; see that option for more detail. + * - ``public_endpoint`` = ``None`` + - (StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. + * - ``secure_proxy_ssl_header`` = ``None`` + - (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". + * - ``strict_password_check`` = ``False`` + - (BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. + * - **[endpoint_filter]** + - + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the endpoint filter backend driver in the keystone.endpoint_filter namespace. + * - ``return_all_endpoints_if_no_filter`` = ``True`` + - (BoolOpt) Toggle to return all active endpoints if no filter exists. + * - **[endpoint_policy]** + - + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the endpoint policy backend driver in the keystone.endpoint_policy namespace. + * - ``enabled`` = ``True`` + - (BoolOpt) Enable endpoint_policy functionality. + * - **[eventlet_server]** + - + * - ``admin_bind_host`` = ``0.0.0.0`` + - (StrOpt) The IP address of the network interface for the admin service to listen on. + * - ``admin_port`` = ``35357`` + - (IntOpt) The port number which the admin service listens on. + * - ``admin_workers`` = ``None`` + - (IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2). + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for socket operations on a client connection. If an incoming connection is idle for this number of seconds it will be closed. A value of "0" means wait forever. + * - ``public_bind_host`` = ``0.0.0.0`` + - (StrOpt) The IP address of the network interface for the public service to listen on. + * - ``public_port`` = ``5000`` + - (IntOpt) The port number which the public service listens on. + * - ``public_workers`` = ``None`` + - (IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2). + * - ``tcp_keepalive`` = ``False`` + - (BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. + * - ``wsgi_keep_alive`` = ``True`` + - (BoolOpt) If set to false, disables keepalives on the server; all connections will be closed after serving one request. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[paste_deploy]** + - + * - ``config_file`` = ``keystone-paste.ini`` + - (StrOpt) Name of the paste configuration file that defines the available pipelines. + * - **[resource]** + - + * - ``cache_time`` = ``None`` + - (IntOpt) TTL (in seconds) to cache resource data. This has no effect unless global caching is enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``None`` + - (StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. Supplied drivers are ldap and sql. If a resource driver is not specified, the assignment driver will choose the resource driver. + * - ``list_limit`` = ``None`` + - (IntOpt) Maximum number of entities that will be returned in a resource collection. diff --git a/doc/config-ref-rst/source/tables/keystone-assignment.rst b/doc/config-ref-rst/source/tables/keystone-assignment.rst new file mode 100644 index 0000000000..3036458dce --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-assignment.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of assignment configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[assignment]** + - + * - ``driver`` = ``None`` + - (StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Supplied drivers are ldap and sql. If an assignment driver is not specified, the identity driver will choose the assignment driver. diff --git a/doc/config-ref-rst/source/tables/keystone-auth.rst b/doc/config-ref-rst/source/tables/keystone-auth.rst new file mode 100644 index 0000000000..ebb4d07d6f --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-auth.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[auth]** + - + * - ``external`` = ``None`` + - (StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain. + * - ``methods`` = ``external, password, token, oauth1`` + - (ListOpt) Allowed authentication methods. + * - ``oauth1`` = ``None`` + - (StrOpt) Entrypoint for the oAuth1.0 auth plugin module in the keystone.auth.oauth1 namespace. + * - ``password`` = ``None`` + - (StrOpt) Entrypoint for the password auth plugin module in the keystone.auth.password namespace. + * - ``token`` = ``None`` + - (StrOpt) Entrypoint for the token auth plugin module in the keystone.auth.token namespace. diff --git a/doc/config-ref-rst/source/tables/keystone-auth_token.rst b/doc/config-ref-rst/source/tables/keystone-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/keystone-ca.rst b/doc/config-ref-rst/source/tables/keystone-ca.rst new file mode 100644 index 0000000000..0792e153dc --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-ca.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CA and SSL configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[eventlet_server_ssl]** + - + * - ``ca_certs`` = ``/etc/keystone/ssl/certs/ca.pem`` + - (StrOpt) Path of the CA cert file for SSL. + * - ``cert_required`` = ``False`` + - (BoolOpt) Require client certificate. + * - ``certfile`` = ``/etc/keystone/ssl/certs/keystone.pem`` + - (StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. + * - ``enable`` = ``False`` + - (BoolOpt) Toggle for SSL support on the Keystone eventlet servers. + * - ``keyfile`` = ``/etc/keystone/ssl/private/keystonekey.pem`` + - (StrOpt) Path of the keyfile for SSL. + * - **[signing]** + - + * - ``ca_certs`` = ``/etc/keystone/ssl/certs/ca.pem`` + - (StrOpt) Path of the CA for token signing. + * - ``ca_key`` = ``/etc/keystone/ssl/private/cakey.pem`` + - (StrOpt) Path of the CA key for token signing. + * - ``cert_subject`` = ``/C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com`` + - (StrOpt) Certificate subject (auto generated certificate) for token signing. + * - ``certfile`` = ``/etc/keystone/ssl/certs/signing_cert.pem`` + - (StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. + * - ``key_size`` = ``2048`` + - (IntOpt) Key size (in bits) for token signing cert (auto generated certificate). + * - ``keyfile`` = ``/etc/keystone/ssl/private/signing_key.pem`` + - (StrOpt) Path of the keyfile for token signing. + * - ``valid_days`` = ``3650`` + - (IntOpt) Days the token signing cert is valid for (auto generated certificate). + * - **[ssl]** + - + * - ``ca_key`` = ``/etc/keystone/ssl/private/cakey.pem`` + - (StrOpt) Path of the CA key file for SSL. + * - ``cert_subject`` = ``/C=US/ST=Unset/L=Unset/O=Unset/CN=localhost`` + - (StrOpt) SSL certificate subject (auto generated certificate). + * - ``key_size`` = ``1024`` + - (IntOpt) SSL key length (in bits) (auto generated certificate). + * - ``valid_days`` = ``3650`` + - (IntOpt) Days the certificate is valid for once signed (auto generated certificate). diff --git a/doc/config-ref-rst/source/tables/keystone-cache.rst b/doc/config-ref-rst/source/tables/keystone-cache.rst new file mode 100644 index 0000000000..261e038804 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-cache.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cache configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cache]** + - + * - ``backend`` = ``dogpile.cache.null`` + - (StrOpt) Dogpile.cache backend module. It is recommended that Memcache with pooling (oslo_cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend. + * - ``backend_argument`` = ``[]`` + - (MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":". + * - ``config_prefix`` = ``cache.oslo`` + - (StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + * - ``debug_cache_backend`` = ``False`` + - (BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. + * - ``enabled`` = ``False`` + - (BoolOpt) Global toggle for caching. + * - ``expiration_time`` = ``600`` + - (IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. + * - ``memcache_dead_retry`` = ``300`` + - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``memcache_pool_connection_get_timeout`` = ``10`` + - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). + * - ``memcache_servers`` = ``localhost:11211`` + - (ListOpt) Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``memcache_socket_timeout`` = ``3`` + - (IntOpt) Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). + * - ``proxies`` = ```` + - (ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. + * - **[memcache]** + - + * - ``dead_retry`` = ``300`` + - (IntOpt) Number of seconds memcached server is considered dead before it is tried again. This is used by the key value store system (e.g. token pooled memcached persistence backend). + * - ``pool_connection_get_timeout`` = ``10`` + - (IntOpt) Number of seconds that an operation will wait to get a memcache client connection. This is used by the key value store system (e.g. token pooled memcached persistence backend). + * - ``pool_maxsize`` = ``10`` + - (IntOpt) Max total number of open connections to every memcached server. This is used by the key value store system (e.g. token pooled memcached persistence backend). + * - ``pool_unused_timeout`` = ``60`` + - (IntOpt) Number of seconds a connection to memcached is held unused in the pool before it is closed. This is used by the key value store system (e.g. token pooled memcached persistence backend). diff --git a/doc/config-ref-rst/source/tables/keystone-catalog.rst b/doc/config-ref-rst/source/tables/keystone-catalog.rst new file mode 100644 index 0000000000..3b02ed9103 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-catalog.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of catalog configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[catalog]** + - + * - ``cache_time`` = ``None`` + - (IntOpt) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql + * - ``list_limit`` = ``None`` + - (IntOpt) Maximum number of entities that will be returned in a catalog collection. + * - ``template_file`` = ``default_catalog.templates`` + - (StrOpt) Catalog template file name for use with the template catalog backend. diff --git a/doc/config-ref-rst/source/tables/keystone-common.rst b/doc/config-ref-rst/source/tables/keystone-common.rst new file mode 100644 index 0000000000..c8f2713ed2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-common.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. diff --git a/doc/config-ref-rst/source/tables/keystone-cors.rst b/doc/config-ref-rst/source/tables/keystone-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/keystone-credential.rst b/doc/config-ref-rst/source/tables/keystone-credential.rst new file mode 100644 index 0000000000..318dcda456 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-credential.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of credential configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[credential]** + - + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the credential backend driver in the keystone.credential namespace. diff --git a/doc/config-ref-rst/source/tables/keystone-database.rst b/doc/config-ref-rst/source/tables/keystone-database.rst new file mode 100644 index 0000000000..fe0826d256 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-database.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/keystone-debug.rst b/doc/config-ref-rst/source/tables/keystone-debug.rst new file mode 100644 index 0000000000..a351aec076 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-debug.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pydev_debug_host`` = ``None`` + - (StrOpt) Host to connect to for remote debugger. + * - ``pydev_debug_port`` = ``None`` + - (IntOpt) Port to connect to for remote debugger. + * - ``standard_threads`` = ``False`` + - (BoolOpt) Do not monkey-patch threading system modules. + * - **[audit]** + - + * - ``namespace`` = ``openstack`` + - (StrOpt) namespace prefix for generated id diff --git a/doc/config-ref-rst/source/tables/keystone-domain.rst b/doc/config-ref-rst/source/tables/keystone-domain.rst new file mode 100644 index 0000000000..f2eebf5e8a --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-domain.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of domain configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[domain_config]** + - + * - ``cache_time`` = ``300`` + - (IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the domain config backend driver in the keystone.resource.domain_config namespace. diff --git a/doc/config-ref-rst/source/tables/keystone-federation.rst b/doc/config-ref-rst/source/tables/keystone-federation.rst new file mode 100644 index 0000000000..c299f78531 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-federation.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of federation configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[federation]** + - + * - ``assertion_prefix`` = ```` + - (StrOpt) Value to be used when filtering assertion parameters from the environment. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the federation backend driver in the keystone.federation namespace. + * - ``federated_domain_name`` = ``Federated`` + - (StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. + * - ``remote_id_attribute`` = ``None`` + - (StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-Identity-Provider`). + * - ``sso_callback_template`` = ``/etc/keystone/sso_callback_template.html`` + - (StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host. + * - ``trusted_dashboard`` = ``[]`` + - (MultiStrOpt) A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com/auth/websso trusted_dashboard=http://beta.com/auth/websso diff --git a/doc/config-ref-rst/source/tables/keystone-fernet_tokens.rst b/doc/config-ref-rst/source/tables/keystone-fernet_tokens.rst new file mode 100644 index 0000000000..4c9d44f5ea --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-fernet_tokens.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Fernet tokens configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[fernet_tokens]** + - + * - ``key_repository`` = ``/etc/keystone/fernet-keys/`` + - (StrOpt) Directory containing Fernet token keys. + * - ``max_active_keys`` = ``3`` + - (IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation. diff --git a/doc/config-ref-rst/source/tables/keystone-identity.rst b/doc/config-ref-rst/source/tables/keystone-identity.rst new file mode 100644 index 0000000000..b524bd1a4a --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-identity.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of identity configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[identity]** + - + * - ``cache_time`` = ``600`` + - (IntOpt) Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled. + * - ``default_domain_id`` = ``default`` + - (StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. + * - ``domain_config_dir`` = ``/etc/keystone/domains`` + - (StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. + * - ``domain_configurations_from_database`` = ``False`` + - (BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable. + * - ``domain_specific_drivers_enabled`` = ``False`` + - (BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql. + * - ``list_limit`` = ``None`` + - (IntOpt) Maximum number of entities that will be returned in an identity collection. + * - ``max_password_length`` = ``4096`` + - (IntOpt) Maximum supported length for user passwords; decrease to improve performance. diff --git a/doc/config-ref-rst/source/tables/keystone-kvs.rst b/doc/config-ref-rst/source/tables/keystone-kvs.rst new file mode 100644 index 0000000000..83f88f9d9f --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-kvs.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of KVS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[kvs]** + - + * - ``backends`` = ```` + - (ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. + * - ``config_prefix`` = ``keystone.kvs`` + - (StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. + * - ``default_lock_timeout`` = ``5`` + - (IntOpt) Default lock timeout (in seconds) for distributed locking. + * - ``enable_key_mangler`` = ``True`` + - (BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. diff --git a/doc/config-ref-rst/source/tables/keystone-ldap.rst b/doc/config-ref-rst/source/tables/keystone-ldap.rst new file mode 100644 index 0000000000..880c116894 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-ldap.rst @@ -0,0 +1,188 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of LDAP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ldap]** + - + * - ``alias_dereferencing`` = ``default`` + - (StrOpt) The LDAP dereferencing option for queries. The "default" option falls back to using default dereferencing configured by your ldap.conf. + * - ``allow_subtree_delete`` = ``False`` + - (BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. + * - ``auth_pool_connection_lifetime`` = ``60`` + - (IntOpt) End user auth connection lifetime in seconds. + * - ``auth_pool_size`` = ``100`` + - (IntOpt) End user auth connection pool size. + * - ``chase_referrals`` = ``None`` + - (BoolOpt) Override the system's default referral chasing behavior for queries. + * - ``debug_level`` = ``None`` + - (IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. + * - ``dumb_member`` = ``cn=dumb,dc=nonexistent`` + - (StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. + * - ``group_additional_attribute_mapping`` = ```` + - (ListOpt) Additional attribute mappings for groups. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + * - ``group_allow_create`` = ``True`` + - (BoolOpt) Allow group creation in LDAP backend. + * - ``group_allow_delete`` = ``True`` + - (BoolOpt) Allow group deletion in LDAP backend. + * - ``group_allow_update`` = ``True`` + - (BoolOpt) Allow group update in LDAP backend. + * - ``group_attribute_ignore`` = ```` + - (ListOpt) List of attributes stripped off the group on update. + * - ``group_desc_attribute`` = ``description`` + - (StrOpt) LDAP attribute mapped to group description. + * - ``group_filter`` = ``None`` + - (StrOpt) LDAP search filter for groups. + * - ``group_id_attribute`` = ``cn`` + - (StrOpt) LDAP attribute mapped to group id. + * - ``group_member_attribute`` = ``member`` + - (StrOpt) LDAP attribute mapped to show group membership. + * - ``group_name_attribute`` = ``ou`` + - (StrOpt) LDAP attribute mapped to group name. + * - ``group_objectclass`` = ``groupOfNames`` + - (StrOpt) LDAP objectclass for groups. + * - ``group_tree_dn`` = ``None`` + - (StrOpt) Search base for groups. Defaults to the suffix value. + * - ``page_size`` = ``0`` + - (IntOpt) Maximum results per page; a value of zero ("0") disables paging. + * - ``password`` = ``None`` + - (StrOpt) Password for the BindDN to query the LDAP server. + * - ``pool_connection_lifetime`` = ``600`` + - (IntOpt) Connection lifetime in seconds. + * - ``pool_connection_timeout`` = ``-1`` + - (IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response. + * - ``pool_retry_delay`` = ``0.1`` + - (FloatOpt) Time span in seconds to wait between two reconnect trials. + * - ``pool_retry_max`` = ``3`` + - (IntOpt) Maximum count of reconnect trials. + * - ``pool_size`` = ``10`` + - (IntOpt) Connection pool size. + * - ``project_additional_attribute_mapping`` = ```` + - (ListOpt) Additional attribute mappings for projects. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + * - ``project_allow_create`` = ``True`` + - (BoolOpt) Allow project creation in LDAP backend. + * - ``project_allow_delete`` = ``True`` + - (BoolOpt) Allow project deletion in LDAP backend. + * - ``project_allow_update`` = ``True`` + - (BoolOpt) Allow project update in LDAP backend. + * - ``project_attribute_ignore`` = ```` + - (ListOpt) List of attributes stripped off the project on update. + * - ``project_desc_attribute`` = ``description`` + - (StrOpt) LDAP attribute mapped to project description. + * - ``project_domain_id_attribute`` = ``businessCategory`` + - (StrOpt) LDAP attribute mapped to project domain_id. + * - ``project_enabled_attribute`` = ``enabled`` + - (StrOpt) LDAP attribute mapped to project enabled. + * - ``project_enabled_emulation`` = ``False`` + - (BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group. + * - ``project_enabled_emulation_dn`` = ``None`` + - (StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. + * - ``project_enabled_emulation_use_group_config`` = ``False`` + - (BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group. + * - ``project_filter`` = ``None`` + - (StrOpt) LDAP search filter for projects. + * - ``project_id_attribute`` = ``cn`` + - (StrOpt) LDAP attribute mapped to project id. + * - ``project_member_attribute`` = ``member`` + - (StrOpt) LDAP attribute mapped to project membership for user. + * - ``project_name_attribute`` = ``ou`` + - (StrOpt) LDAP attribute mapped to project name. + * - ``project_objectclass`` = ``groupOfNames`` + - (StrOpt) LDAP objectclass for projects. + * - ``project_tree_dn`` = ``None`` + - (StrOpt) Search base for projects. Defaults to the suffix value. + * - ``query_scope`` = ``one`` + - (StrOpt) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options. + * - ``role_additional_attribute_mapping`` = ```` + - (ListOpt) Additional attribute mappings for roles. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + * - ``role_allow_create`` = ``True`` + - (BoolOpt) Allow role creation in LDAP backend. + * - ``role_allow_delete`` = ``True`` + - (BoolOpt) Allow role deletion in LDAP backend. + * - ``role_allow_update`` = ``True`` + - (BoolOpt) Allow role update in LDAP backend. + * - ``role_attribute_ignore`` = ```` + - (ListOpt) List of attributes stripped off the role on update. + * - ``role_filter`` = ``None`` + - (StrOpt) LDAP search filter for roles. + * - ``role_id_attribute`` = ``cn`` + - (StrOpt) LDAP attribute mapped to role id. + * - ``role_member_attribute`` = ``roleOccupant`` + - (StrOpt) LDAP attribute mapped to role membership. + * - ``role_name_attribute`` = ``ou`` + - (StrOpt) LDAP attribute mapped to role name. + * - ``role_objectclass`` = ``organizationalRole`` + - (StrOpt) LDAP objectclass for roles. + * - ``role_tree_dn`` = ``None`` + - (StrOpt) Search base for roles. Defaults to the suffix value. + * - ``suffix`` = ``cn=example,cn=com`` + - (StrOpt) LDAP server suffix + * - ``tls_cacertdir`` = ``None`` + - (StrOpt) CA certificate directory path for communicating with LDAP servers. + * - ``tls_cacertfile`` = ``None`` + - (StrOpt) CA certificate file path for communicating with LDAP servers. + * - ``tls_req_cert`` = ``demand`` + - (StrOpt) Specifies what checks to perform on client certificates in an incoming TLS session. + * - ``url`` = ``ldap://localhost`` + - (StrOpt) URL for connecting to the LDAP server. + * - ``use_auth_pool`` = ``False`` + - (BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all. + * - ``use_dumb_member`` = ``False`` + - (BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. + * - ``use_pool`` = ``False`` + - (BoolOpt) Enable LDAP connection pooling. + * - ``use_tls`` = ``False`` + - (BoolOpt) Enable TLS for communicating with LDAP servers. + * - ``user`` = ``None`` + - (StrOpt) User BindDN to query the LDAP server. + * - ``user_additional_attribute_mapping`` = ```` + - (ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is :, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. + * - ``user_allow_create`` = ``True`` + - (BoolOpt) Allow user creation in LDAP backend. + * - ``user_allow_delete`` = ``True`` + - (BoolOpt) Allow user deletion in LDAP backend. + * - ``user_allow_update`` = ``True`` + - (BoolOpt) Allow user updates in LDAP backend. + * - ``user_attribute_ignore`` = ``default_project_id`` + - (ListOpt) List of attributes stripped off the user on update. + * - ``user_default_project_id_attribute`` = ``None`` + - (StrOpt) LDAP attribute mapped to default_project_id for users. + * - ``user_enabled_attribute`` = ``enabled`` + - (StrOpt) LDAP attribute mapped to user enabled flag. + * - ``user_enabled_default`` = ``True`` + - (StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". + * - ``user_enabled_emulation`` = ``False`` + - (BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. + * - ``user_enabled_emulation_dn`` = ``None`` + - (StrOpt) DN of the group entry to hold enabled users when using enabled emulation. + * - ``user_enabled_emulation_use_group_config`` = ``False`` + - (BoolOpt) Use the "group_member_attribute" and "group_objectclass" settings to determine membership in the emulated enabled group. + * - ``user_enabled_invert`` = ``False`` + - (BoolOpt) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert = true" will allow these lock attributes to be used. This setting will have no effect if "user_enabled_mask" or "user_enabled_emulation" settings are in use. + * - ``user_enabled_mask`` = ``0`` + - (IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". + * - ``user_filter`` = ``None`` + - (StrOpt) LDAP search filter for users. + * - ``user_id_attribute`` = ``cn`` + - (StrOpt) LDAP attribute mapped to user id. WARNING: must not be a multivalued attribute. + * - ``user_mail_attribute`` = ``mail`` + - (StrOpt) LDAP attribute mapped to user email. + * - ``user_name_attribute`` = ``sn`` + - (StrOpt) LDAP attribute mapped to user name. + * - ``user_objectclass`` = ``inetOrgPerson`` + - (StrOpt) LDAP objectclass for users. + * - ``user_pass_attribute`` = ``userPassword`` + - (StrOpt) LDAP attribute mapped to password. + * - ``user_tree_dn`` = ``None`` + - (StrOpt) Search base for users. Defaults to the suffix value. diff --git a/doc/config-ref-rst/source/tables/keystone-logging.rst b/doc/config-ref-rst/source/tables/keystone-logging.rst new file mode 100644 index 0000000000..bbe00ece82 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/keystone-mapping.rst b/doc/config-ref-rst/source/tables/keystone-mapping.rst new file mode 100644 index 0000000000..21259e8705 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-mapping.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of mapping configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[identity_mapping]** + - + * - ``backward_compatible_ids`` = ``True`` + - (BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the identity mapping backend driver in the keystone.identity.id_mapping namespace. + * - ``generator`` = ``sha256`` + - (StrOpt) Entrypoint for the public ID generator for user and group entities in the keystone.identity.id_generator namespace. The Keystone identity mapper only supports generators that produce no more than 64 characters. diff --git a/doc/config-ref-rst/source/tables/keystone-memcache.rst b/doc/config-ref-rst/source/tables/keystone-memcache.rst new file mode 100644 index 0000000000..bf1bbb76f4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-memcache.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of memcache configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[memcache]** + - + * - ``servers`` = ``localhost:11211`` + - (ListOpt) Memcache servers in the format of "host:port". + * - ``socket_timeout`` = ``3`` + - (IntOpt) Timeout in seconds for every call to a server. This is used by the key value store system (e.g. token pooled memcached persistence backend). diff --git a/doc/config-ref-rst/source/tables/keystone-oauth.rst b/doc/config-ref-rst/source/tables/keystone-oauth.rst new file mode 100644 index 0000000000..14af3bcfc3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-oauth.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of OAuth configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oauth1]** + - + * - ``access_token_duration`` = ``86400`` + - (IntOpt) Duration (in seconds) for the OAuth Access Token. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the OAuth backend driver in the keystone.oauth1 namespace. + * - ``request_token_duration`` = ``28800`` + - (IntOpt) Duration (in seconds) for the OAuth Request Token. diff --git a/doc/config-ref-rst/source/tables/keystone-os_inherit.rst b/doc/config-ref-rst/source/tables/keystone-os_inherit.rst new file mode 100644 index 0000000000..ed23689ea4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-os_inherit.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of os_inherit configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[os_inherit]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled. diff --git a/doc/config-ref-rst/source/tables/keystone-policy.rst b/doc/config-ref-rst/source/tables/keystone-policy.rst new file mode 100644 index 0000000000..de8b81be56 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-policy.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. + * - **[policy]** + - + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql. + * - ``list_limit`` = ``None`` + - (IntOpt) Maximum number of entities that will be returned in a policy collection. diff --git a/doc/config-ref-rst/source/tables/keystone-qpid.rst b/doc/config-ref-rst/source/tables/keystone-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/keystone-rabbitmq.rst b/doc/config-ref-rst/source/tables/keystone-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/keystone-redis.rst b/doc/config-ref-rst/source/tables/keystone-redis.rst new file mode 100644 index 0000000000..ac62f687cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-redis.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/keystone-revoke.rst b/doc/config-ref-rst/source/tables/keystone-revoke.rst new file mode 100644 index 0000000000..f045cac860 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-revoke.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of revoke configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[revoke]** + - + * - ``cache_time`` = ``3600`` + - (IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for revocation event caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql. + * - ``expiration_buffer`` = ``1800`` + - (IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. diff --git a/doc/config-ref-rst/source/tables/keystone-role.rst b/doc/config-ref-rst/source/tables/keystone-role.rst new file mode 100644 index 0000000000..b6b07ecb92 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-role.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of role configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[role]** + - + * - ``cache_time`` = ``None`` + - (IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``None`` + - (StrOpt) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql. + * - ``list_limit`` = ``None`` + - (IntOpt) Maximum number of entities that will be returned in a role collection. diff --git a/doc/config-ref-rst/source/tables/keystone-rpc.rst b/doc/config-ref-rst/source/tables/keystone-rpc.rst new file mode 100644 index 0000000000..11879f71ea --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-rpc.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/keystone-saml.rst b/doc/config-ref-rst/source/tables/keystone-saml.rst new file mode 100644 index 0000000000..cc3e2f4f9d --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-saml.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SAML configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[saml]** + - + * - ``assertion_expiration_time`` = ``3600`` + - (IntOpt) Default TTL, in seconds, for any generated SAML assertion created by Keystone. + * - ``certfile`` = ``/etc/keystone/ssl/certs/signing_cert.pem`` + - (StrOpt) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma. + * - ``idp_contact_company`` = ``None`` + - (StrOpt) Company of contact person. + * - ``idp_contact_email`` = ``None`` + - (StrOpt) Email address of contact person. + * - ``idp_contact_name`` = ``None`` + - (StrOpt) Given name of contact person + * - ``idp_contact_surname`` = ``None`` + - (StrOpt) Surname of contact person. + * - ``idp_contact_telephone`` = ``None`` + - (StrOpt) Telephone number of contact person. + * - ``idp_contact_type`` = ``other`` + - (StrOpt) The contact type describing the main point of contact for the identity provider. + * - ``idp_entity_id`` = ``None`` + - (StrOpt) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/idp + * - ``idp_lang`` = ``en`` + - (StrOpt) Language used by the organization. + * - ``idp_metadata_path`` = ``/etc/keystone/saml2_idp_metadata.xml`` + - (StrOpt) Path to the Identity Provider Metadata file. This file should be generated with the keystone-manage saml_idp_metadata command. + * - ``idp_organization_display_name`` = ``None`` + - (StrOpt) Organization name to be displayed. + * - ``idp_organization_name`` = ``None`` + - (StrOpt) Organization name the installation belongs to. + * - ``idp_organization_url`` = ``None`` + - (StrOpt) URL of the organization. + * - ``idp_sso_endpoint`` = ``None`` + - (StrOpt) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso + * - ``keyfile`` = ``/etc/keystone/ssl/private/signing_key.pem`` + - (StrOpt) Path of the keyfile for SAML signing. Note, the path cannot contain a comma. + * - ``relay_state_prefix`` = ``ss:mem:`` + - (StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions. + * - ``xmlsec1_binary`` = ``xmlsec1`` + - (StrOpt) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found. diff --git a/doc/config-ref-rst/source/tables/keystone-security.rst b/doc/config-ref-rst/source/tables/keystone-security.rst new file mode 100644 index 0000000000..edbf07ee47 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-security.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of security configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``crypt_strength`` = ``10000`` + - (IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. diff --git a/doc/config-ref-rst/source/tables/keystone-token.rst b/doc/config-ref-rst/source/tables/keystone-token.rst new file mode 100644 index 0000000000..035214a369 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-token.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[token]** + - + * - ``allow_rescope_scoped_token`` = ``True`` + - (BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token. + * - ``bind`` = ```` + - (ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. + * - ``cache_time`` = ``None`` + - (IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. + * - ``caching`` = ``True`` + - (BoolOpt) Toggle for token system caching. This has no effect unless global caching is enabled. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. + * - ``expiration`` = ``3600`` + - (IntOpt) Amount of time a token should remain valid (in seconds). + * - ``hash_algorithm`` = ``md5`` + - (StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. + * - ``provider`` = ``uuid`` + - (StrOpt) Controls the token construction, validation, and revocation operations. Entrypoint in the keystone.token.provider namespace. Core providers are [fernet|pkiz|pki|uuid]. + * - ``revoke_by_id`` = ``True`` + - (BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. diff --git a/doc/config-ref-rst/source/tables/keystone-tokenless.rst b/doc/config-ref-rst/source/tables/keystone-tokenless.rst new file mode 100644 index 0000000000..a7a297afea --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-tokenless.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Tokenless Authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[tokenless_auth]** + - + * - ``issuer_attribute`` = ``SSL_CLIENT_I_DN`` + - (StrOpt) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. + * - ``protocol`` = ``x509`` + - (StrOpt) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. + * - ``trusted_issuer`` = ``[]`` + - (MultiStrOpt) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc diff --git a/doc/config-ref-rst/source/tables/keystone-trust.rst b/doc/config-ref-rst/source/tables/keystone-trust.rst new file mode 100644 index 0000000000..be26644ff6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-trust.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of trust configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[trust]** + - + * - ``allow_redelegation`` = ``False`` + - (BoolOpt) Enable redelegation feature. + * - ``driver`` = ``sql`` + - (StrOpt) Entrypoint for the trust backend driver in the keystone.trust namespace. + * - ``enabled`` = ``True`` + - (BoolOpt) Delegation and impersonation features can be optionally disabled. + * - ``max_redelegation_count`` = ``3`` + - (IntOpt) Maximum depth of trust redelegation. diff --git a/doc/config-ref-rst/source/tables/keystone-zeromq.rst b/doc/config-ref-rst/source/tables/keystone-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/keystone-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/manila-amqp.rst b/doc/config-ref-rst/source/tables/manila-amqp.rst new file mode 100644 index 0000000000..84ac08e209 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-amqp.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/manila-api.rst b/doc/config-ref-rst/source/tables/manila-api.rst new file mode 100644 index 0000000000..2da6505519 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-api.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``api_paste_config`` = ``api-paste.ini`` + - (StrOpt) File name for the paste.deploy config for manila-api. + * - ``api_rate_limit`` = ``True`` + - (BoolOpt) Whether to rate limit the API. + * - ``enable_v1_api`` = ``False`` + - (BoolOpt) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. + * - ``enable_v2_api`` = ``False`` + - (BoolOpt) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. Option max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``osapi_max_limit`` = ``1000`` + - (IntOpt) The maximum number of items returned in a single response from a collection resource. + * - ``osapi_share_base_URL`` = ``None`` + - (StrOpt) Base URL to be presented to users in links to the Share API + * - ``osapi_share_ext_list`` = ```` + - (ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions. + * - ``osapi_share_extension`` = ``['manila.api.contrib.standard_extensions']`` + - (MultiStrOpt) The osapi share extension to load. + * - ``osapi_share_listen`` = ``::`` + - (StrOpt) IP address for OpenStack Share API to listen on. + * - ``osapi_share_listen_port`` = ``8786`` + - (PortOpt) Port for OpenStack Share API to listen on. + * - ``osapi_share_workers`` = ``1`` + - (IntOpt) Number of workers for OpenStack Share API service. + * - ``share_api_class`` = ``manila.share.api.API`` + - (StrOpt) The full class name of the share API class to use. + * - ``volume_api_class`` = ``manila.volume.cinder.API`` + - (StrOpt) The full class name of the Volume API class to use. + * - ``volume_name_template`` = ``manila-share-%s`` + - (StrOpt) Volume name template. + * - ``volume_snapshot_name_template`` = ``manila-snapshot-%s`` + - (StrOpt) Volume snapshot name template. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/manila-auth.rst b/doc/config-ref-rst/source/tables/manila-auth.rst new file mode 100644 index 0000000000..5ee7be9583 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-auth.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Authorization configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated. diff --git a/doc/config-ref-rst/source/tables/manila-auth_token.rst b/doc/config-ref-rst/source/tables/manila-auth_token.rst new file mode 100644 index 0000000000..7c9ff8936d --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-auth_token.rst @@ -0,0 +1,94 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Authorization Token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/manila-ca.rst b/doc/config-ref-rst/source/tables/manila-ca.rst new file mode 100644 index 0000000000..288fec3754 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-ca.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Certificate Authority configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ssl_ca_file`` = ``None`` + - (StrOpt) CA certificate file to use to verify connecting clients. + * - ``ssl_cert_file`` = ``None`` + - (StrOpt) Certificate file to use when starting the server securely. + * - ``ssl_key_file`` = ``None`` + - (StrOpt) Private key file to use when starting the server securely. diff --git a/doc/config-ref-rst/source/tables/manila-common.rst b/doc/config-ref-rst/source/tables/manila-common.rst new file mode 100644 index 0000000000..cb38e0f9bc --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-common.rst @@ -0,0 +1,82 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + * - ``compute_api_class`` = ``manila.compute.nova.API`` + - (StrOpt) The full class name of the Compute API class to use. + * - ``enable_new_services`` = ``True`` + - (BoolOpt) Services to be added to the available pool on create. + * - ``host`` = ``localhost`` + - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. + * - ``max_over_subscription_ratio`` = ``20.0`` + - (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``monkey_patch`` = ``False`` + - (BoolOpt) Whether to log monkey patching. + * - ``monkey_patch_modules`` = ```` + - (ListOpt) List of modules or decorators to monkey patch. + * - ``my_ip`` = ``10.0.0.1`` + - (StrOpt) IP address of this host. + * - ``num_shell_tries`` = ``3`` + - (IntOpt) Number of times to attempt to run flakey shell commands. + * - ``periodic_fuzzy_delay`` = ``60`` + - (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + * - ``periodic_hooks_interval`` = ``300.0`` + - (FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300. + * - ``periodic_interval`` = ``60`` + - (IntOpt) Seconds between running periodic tasks. + * - ``report_interval`` = ``10`` + - (IntOpt) Seconds between nodes reporting state to datastore. + * - ``reserved_share_percentage`` = ``0`` + - (IntOpt) The percentage of backend capacity reserved. + * - ``rootwrap_config`` = ``None`` + - (StrOpt) Path to the rootwrap configuration file to use for running commands as root. + * - ``service_down_time`` = ``60`` + - (IntOpt) Maximum time since last check-in for up service. + * - ``sql_idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``sql_max_retries`` = ``10`` + - (IntOpt) Maximum database connection retries during startup. (setting -1 implies an infinite retry count). + * - ``sql_retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``sqlite_clean_db`` = ``clean.sqlite`` + - (StrOpt) File name of clean sqlite database. + * - ``sqlite_db`` = ``manila.sqlite`` + - (StrOpt) The filename to use with sqlite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If passed, use synchronous mode for sqlite. + * - ``state_path`` = ``/var/lib/manila`` + - (StrOpt) Top-level directory for maintaining manila's state. + * - ``storage_availability_zone`` = ``nova`` + - (StrOpt) Availability zone of this node. + * - ``tcp_keepalive`` = ``True`` + - (BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. + * - ``tcp_keepalive_count`` = ``None`` + - (IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. + * - ``tcp_keepalive_interval`` = ``None`` + - (IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + * - ``until_refresh`` = ``0`` + - (IntOpt) Count of reservations until usage is refreshed. + * - ``use_forwarded_for`` = ``False`` + - (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. + * - ``wsgi_keep_alive`` = ``True`` + - (BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. diff --git a/doc/config-ref-rst/source/tables/manila-compute.rst b/doc/config-ref-rst/source/tables/manila-compute.rst new file mode 100644 index 0000000000..6c5d6a492e --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-compute.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Compute configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nova_admin_auth_url`` = ``http://localhost:5000/v2.0`` + - (StrOpt) Identity service URL. + * - ``nova_admin_password`` = ``None`` + - (StrOpt) Nova admin password. + * - ``nova_admin_tenant_name`` = ``service`` + - (StrOpt) Nova admin tenant name. + * - ``nova_admin_username`` = ``nova`` + - (StrOpt) Nova admin username. + * - ``nova_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to nova. + * - ``nova_api_microversion`` = ``2.10`` + - (StrOpt) Version of Nova API to be used. + * - ``nova_ca_certificates_file`` = ``None`` + - (StrOpt) Location of CA certificates file to use for nova client requests. + * - ``nova_catalog_admin_info`` = ``compute:nova:adminURL`` + - (StrOpt) Same as nova_catalog_info, but for admin endpoint. + * - ``nova_catalog_info`` = ``compute:nova:publicURL`` + - (StrOpt) Info to match when looking for nova in the service catalog. Format is separated values of the form: :: + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name of this node. diff --git a/doc/config-ref-rst/source/tables/manila-cors.rst b/doc/config-ref-rst/source/tables/manila-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/manila-database.rst b/doc/config-ref-rst/source/tables/manila-database.rst new file mode 100644 index 0000000000..b8bf0c776b --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-database.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``db_backend`` = ``sqlalchemy`` + - (StrOpt) The backend to use for database. + * - ``db_driver`` = ``manila.db`` + - (StrOpt) Driver to use for database access. + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/manila-emc.rst b/doc/config-ref-rst/source/tables/manila-emc.rst new file mode 100644 index 0000000000..c11ae2d817 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-emc.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of EMC Share Drivers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``emc_nas_login`` = ``None`` + - (StrOpt) User name for the EMC server. + * - ``emc_nas_password`` = ``None`` + - (StrOpt) Password for the EMC server. + * - ``emc_nas_pool_name`` = ``None`` + - (StrOpt) EMC pool name. + * - ``emc_nas_root_dir`` = ``None`` + - (StrOpt) The root directory where shares will be located. + * - ``emc_nas_server`` = ``None`` + - (StrOpt) EMC server hostname or IP address. + * - ``emc_nas_server_container`` = ``server_2`` + - (StrOpt) Container of share servers. + * - ``emc_nas_server_port`` = ``8080`` + - (PortOpt) Port number for the EMC server. + * - ``emc_nas_server_secure`` = ``True`` + - (BoolOpt) Use secure connection to server. + * - ``emc_share_backend`` = ``None`` + - (StrOpt) Share backend. diff --git a/doc/config-ref-rst/source/tables/manila-ganesha.rst b/doc/config-ref-rst/source/tables/manila-ganesha.rst new file mode 100644 index 0000000000..5e38c1e7f6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-ganesha.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Ganesha configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ganesha_config_dir`` = ``/etc/ganesha`` + - (StrOpt) Directory where Ganesha config files are stored. + * - ``ganesha_config_path`` = ``$ganesha_config_dir/ganesha.conf`` + - (StrOpt) Path to main Ganesha config file. + * - ``ganesha_db_path`` = ``$state_path/manila-ganesha.db`` + - (StrOpt) Location of Ganesha database file. (Ganesha module only.) + * - ``ganesha_export_dir`` = ``$ganesha_config_dir/export.d`` + - (StrOpt) Path to directory containing Ganesha export configuration. (Ganesha module only.) + * - ``ganesha_export_template_dir`` = ``/etc/manila/ganesha-export-templ.d`` + - (StrOpt) Path to directory containing Ganesha export block templates. (Ganesha module only.) + * - ``ganesha_nfs_export_options`` = ``maxread = 65536, prefread = 65536`` + - (StrOpt) Options to use when exporting a share using ganesha NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. Also note the complete set of default ganesha export options is specified in ganesha_utils. (GPFS only.) + * - ``ganesha_service_name`` = ``ganesha.nfsd`` + - (StrOpt) Name of the ganesha nfs service. diff --git a/doc/config-ref-rst/source/tables/manila-glusterfs.rst b/doc/config-ref-rst/source/tables/manila-glusterfs.rst new file mode 100644 index 0000000000..afa720bbcf --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-glusterfs.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of GlusterFS Share Drivers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``glusterfs_ganesha_server_ip`` = ``None`` + - (StrOpt) Remote Ganesha server node's IP address. + * - ``glusterfs_ganesha_server_password`` = ``None`` + - (StrOpt) Remote Ganesha server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. + * - ``glusterfs_ganesha_server_username`` = ``root`` + - (StrOpt) Remote Ganesha server node's username. + * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base directory containing mount points for Gluster volumes. + * - ``glusterfs_nfs_server_type`` = ``Gluster`` + - (StrOpt) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha). + * - ``glusterfs_path_to_private_key`` = ``None`` + - (StrOpt) Path of Manila host's private SSH key file. + * - ``glusterfs_server_password`` = ``None`` + - (StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_path_to_private_key' is configured. + * - ``glusterfs_servers`` = ```` + - (ListOpt) List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@], and they are assumed to belong to distinct Gluster clusters. + * - ``glusterfs_share_layout`` = ``None`` + - (StrOpt) Specifies GlusterFS share layout, that is, the method of associating backing GlusterFS resources to shares. + * - ``glusterfs_target`` = ``None`` + - (StrOpt) Specifies the GlusterFS volume to be mounted on the Manila host. It is of the form [remoteuser@]:. + * - ``glusterfs_volume_pattern`` = ``None`` + - (StrOpt) Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be interpreted as size of the volume in GB. Examples: "manila-share-volume-\d+$", "manila-share-volume-#{size}G-\d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share-volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G. diff --git a/doc/config-ref-rst/source/tables/manila-gpfs.rst b/doc/config-ref-rst/source/tables/manila-gpfs.rst new file mode 100644 index 0000000000..34ce69f622 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-gpfs.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IBM GPFS Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``gpfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Base folder where exported shares are located. + * - ``gpfs_nfs_server_list`` = ``None`` + - (ListOpt) A list of the fully qualified NFS server names that make up the OpenStack Manila configuration. + * - ``gpfs_nfs_server_type`` = ``KNFS`` + - (StrOpt) NFS Server type. Valid choices are "KNFS" (kernel NFS) or "GNFS" (Ganesha NFS). + * - ``gpfs_share_export_ip`` = ``None`` + - (StrOpt) IP to be added to GPFS export string. + * - ``gpfs_share_helpers`` = ``KNFS=manila.share.drivers.ibm.gpfs.KNFSHelper, GNFS=manila.share.drivers.ibm.gpfs.GNFSHelper`` + - (ListOpt) Specify list of share export helpers. + * - ``gpfs_ssh_login`` = ``None`` + - (StrOpt) GPFS server SSH login name. + * - ``gpfs_ssh_password`` = ``None`` + - (StrOpt) GPFS server SSH login password. The password is not needed, if 'gpfs_ssh_private_key' is configured. + * - ``gpfs_ssh_port`` = ``22`` + - (PortOpt) GPFS server SSH port. + * - ``gpfs_ssh_private_key`` = ``None`` + - (StrOpt) Path to GPFS server SSH private key for login. + * - ``knfs_export_options`` = ``rw,sync,no_root_squash,insecure,no_wdelay,no_subtree_check`` + - (StrOpt) Options to use when exporting a share using kernel NFS server. Note that these defaults can be overridden when a share is created by passing metadata with key name export_options. diff --git a/doc/config-ref-rst/source/tables/manila-hdfs.rst b/doc/config-ref-rst/source/tables/manila-hdfs.rst new file mode 100644 index 0000000000..de8a9f459f --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-hdfs.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HDFS Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hdfs_namenode_ip`` = ``None`` + - (StrOpt) The IP of the HDFS namenode. + * - ``hdfs_namenode_port`` = ``9000`` + - (PortOpt) The port of HDFS namenode service. + * - ``hdfs_ssh_name`` = ``None`` + - (StrOpt) HDFS namenode ssh login name. + * - ``hdfs_ssh_port`` = ``22`` + - (PortOpt) HDFS namenode SSH port. + * - ``hdfs_ssh_private_key`` = ``None`` + - (StrOpt) Path to HDFS namenode SSH private key for login. + * - ``hdfs_ssh_pw`` = ``None`` + - (StrOpt) HDFS namenode SSH login password, This parameter is not necessary, if 'hdfs_ssh_private_key' is configured. diff --git a/doc/config-ref-rst/source/tables/manila-hds_hnas.rst b/doc/config-ref-rst/source/tables/manila-hds_hnas.rst new file mode 100644 index 0000000000..e2e9780f3e --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-hds_hnas.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HDS NAS Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hds_hnas_cluster_admin_ip0`` = ``None`` + - (StrOpt) The IP of the clusters admin node. Only set in HNAS multinode clusters. + * - ``hds_hnas_evs_id`` = ``None`` + - (StrOpt) Specify which EVS this backend is assigned to. + * - ``hds_hnas_evs_ip`` = ``None`` + - (StrOpt) Specify IP for mounting shares. + * - ``hds_hnas_file_system_name`` = ``None`` + - (StrOpt) Specify file-system name for creating shares. + * - ``hds_hnas_ip`` = ``None`` + - (StrOpt) HNAS management interface IP for communication between Manila controller and HNAS. + * - ``hds_hnas_password`` = ``None`` + - (StrOpt) HNAS user password. Required only if private key is not provided. + * - ``hds_hnas_ssh_private_key`` = ``None`` + - (StrOpt) RSA/DSA private key value used to connect into HNAS. Required only if password is not provided. + * - ``hds_hnas_stalled_job_timeout`` = ``30`` + - (IntOpt) The time (in seconds) to wait for stalled HNAS jobs before aborting. + * - ``hds_hnas_user`` = ``None`` + - (StrOpt) HNAS username Base64 String in order to perform tasks such as create file-systems and network interfaces. diff --git a/doc/config-ref-rst/source/tables/manila-hp3par.rst b/doc/config-ref-rst/source/tables/manila-hp3par.rst new file mode 100644 index 0000000000..f3d0508089 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-hp3par.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HP 3PAR Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``hp3par_api_url`` = ```` + - (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 + * - ``hp3par_debug`` = ``False`` + - (BoolOpt) Enable HTTP debugging to 3PAR + * - ``hp3par_fpg`` = ``OpenStack`` + - (StrOpt) The File Provisioning Group (FPG) to use + * - ``hp3par_fstore_per_share`` = ``False`` + - (BoolOpt) Use one filestore per share + * - ``hp3par_password`` = ```` + - (StrOpt) 3PAR password for the user specified in hp3par_username + * - ``hp3par_san_ip`` = ```` + - (StrOpt) IP address of SAN controller + * - ``hp3par_san_login`` = ```` + - (StrOpt) Username for SAN controller + * - ``hp3par_san_password`` = ```` + - (StrOpt) Password for SAN controller + * - ``hp3par_san_ssh_port`` = ``22`` + - (PortOpt) SSH port to use with SAN + * - ``hp3par_share_ip_address`` = ```` + - (StrOpt) The IP address for shares not using a share server + * - ``hp3par_username`` = ```` + - (StrOpt) 3PAR username with the 'edit' role diff --git a/doc/config-ref-rst/source/tables/manila-huawei.rst b/doc/config-ref-rst/source/tables/manila-huawei.rst new file mode 100644 index 0000000000..27d62aabe8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-huawei.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Huawei Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``manila_huawei_conf_file`` = ``/etc/manila/manila_huawei_conf.xml`` + - (StrOpt) The configuration file for the Manila Huawei driver. diff --git a/doc/config-ref-rst/source/tables/manila-logging.rst b/doc/config-ref-rst/source/tables/manila-logging.rst new file mode 100644 index 0000000000..f091c4bf5d --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-logging.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Whether to make exception message format errors fatal. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/manila-netapp.rst b/doc/config-ref-rst/source/tables/manila-netapp.rst new file mode 100644 index 0000000000..6b5a025a20 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-netapp.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of NetApp Share Drivers configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``netapp_aggregate_name_search_pattern`` = ``(.*)`` + - (StrOpt) Pattern for searching available aggregates for provisioning. + * - ``netapp_lif_name_template`` = ``os_%(net_allocation_id)s`` + - (StrOpt) Logical interface (LIF) name template + * - ``netapp_login`` = ``None`` + - (StrOpt) Administrative user account name used to access the storage system. + * - ``netapp_password`` = ``None`` + - (StrOpt) Password for the administrative user account specified in the netapp_login option. + * - ``netapp_port_name_search_pattern`` = ``(.*)`` + - (StrOpt) Pattern for overriding the selection of network ports on which to create Vserver LIFs. + * - ``netapp_root_volume`` = ``root`` + - (StrOpt) Root volume name. + * - ``netapp_root_volume_aggregate`` = ``None`` + - (StrOpt) Name of aggregate to create Vserver root volumes on. This option only applies when the option driver_handles_share_servers is set to True. + * - ``netapp_server_hostname`` = ``None`` + - (StrOpt) The hostname (or IP address) for the storage system. + * - ``netapp_server_port`` = ``None`` + - (PortOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. + * - ``netapp_storage_family`` = ``ontap_cluster`` + - (StrOpt) The storage family type used on the storage system; valid values include ontap_cluster for using clustered Data ONTAP. + * - ``netapp_trace_flags`` = ``None`` + - (StrOpt) Comma-separated list of options that control which trace info is written to the debug logs. Values include method and api. + * - ``netapp_transport_type`` = ``http`` + - (StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. + * - ``netapp_volume_name_template`` = ``share_%(share_id)s`` + - (StrOpt) NetApp volume name template. + * - ``netapp_vserver_name_template`` = ``os_%s`` + - (StrOpt) Name template to use for new Vserver. diff --git a/doc/config-ref-rst/source/tables/manila-qpid.rst b/doc/config-ref-rst/source/tables/manila-qpid.rst new file mode 100644 index 0000000000..2dc805624d --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of QPID configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/manila-quobyte.rst b/doc/config-ref-rst/source/tables/manila-quobyte.rst new file mode 100644 index 0000000000..f57e8d50cf --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-quobyte.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Quobyte Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``quobyte_api_ca`` = ``None`` + - (StrOpt) The X.509 CA file to verify the server cert. + * - ``quobyte_api_password`` = ``quobyte`` + - (StrOpt) Password for Quobyte API server + * - ``quobyte_api_url`` = ``None`` + - (StrOpt) URL of the Quobyte API server (http or https) + * - ``quobyte_api_username`` = ``admin`` + - (StrOpt) Username for Quobyte API server. + * - ``quobyte_default_volume_group`` = ``root`` + - (StrOpt) Default owning group for new volumes. + * - ``quobyte_default_volume_user`` = ``root`` + - (StrOpt) Default owning user for new volumes. + * - ``quobyte_delete_shares`` = ``False`` + - (BoolOpt) Actually deletes shares (vs. unexport) + * - ``quobyte_volume_configuration`` = ``BASE`` + - (StrOpt) Name of volume configuration used for new shares. diff --git a/doc/config-ref-rst/source/tables/manila-quota.rst b/doc/config-ref-rst/source/tables/manila-quota.rst new file mode 100644 index 0000000000..4895a2dcaf --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-quota.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Quota configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``max_age`` = ``0`` + - (IntOpt) Number of seconds between subsequent usage refreshes. + * - ``quota_driver`` = ``manila.quota.DbQuotaDriver`` + - (StrOpt) Default driver to use for quota checks. + * - ``quota_gigabytes`` = ``1000`` + - (IntOpt) Number of share gigabytes allowed per project. + * - ``quota_share_networks`` = ``10`` + - (IntOpt) Number of share-networks allowed per project. + * - ``quota_shares`` = ``50`` + - (IntOpt) Number of shares allowed per project. + * - ``quota_snapshot_gigabytes`` = ``1000`` + - (IntOpt) Number of snapshot gigabytes allowed per project. + * - ``quota_snapshots`` = ``50`` + - (IntOpt) Number of share snapshots allowed per project. + * - ``reservation_expire`` = ``86400`` + - (IntOpt) Number of seconds until a reservation expires. diff --git a/doc/config-ref-rst/source/tables/manila-rabbitmq.rst b/doc/config-ref-rst/source/tables/manila-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/manila-redis.rst b/doc/config-ref-rst/source/tables/manila-redis.rst new file mode 100644 index 0000000000..75a290f1d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-redis.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/manila-rpc.rst b/doc/config-ref-rst/source/tables/manila-rpc.rst new file mode 100644 index 0000000000..e38d0e228b --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-rpc.rst @@ -0,0 +1,70 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - ``share_topic`` = ``manila-share`` + - (StrOpt) The topic share nodes listen on. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/manila-san.rst b/doc/config-ref-rst/source/tables/manila-san.rst new file mode 100644 index 0000000000..69dd405776 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-san.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SAN configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ssh_conn_timeout`` = ``60`` + - (IntOpt) Backend server SSH connection timeout. + * - ``ssh_max_pool_conn`` = ``10`` + - (IntOpt) Maximum number of connections in the SSH pool. + * - ``ssh_min_pool_conn`` = ``1`` + - (IntOpt) Minimum number of connections in the SSH pool. diff --git a/doc/config-ref-rst/source/tables/manila-scheduler.rst b/doc/config-ref-rst/source/tables/manila-scheduler.rst new file mode 100644 index 0000000000..2af7aad8f2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-scheduler.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Scheduler configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``capacity_weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used for weighing share capacity. Negative numbers mean to stack vs spread. + * - ``pool_weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used for weighing pools which have existing share servers. Negative numbers mean to spread vs stack. + * - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter, ConsistencyGroupFilter`` + - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. + * - ``scheduler_default_weighers`` = ``CapacityWeigher`` + - (ListOpt) Which weigher class names to use for weighing hosts. + * - ``scheduler_driver`` = ``manila.scheduler.filter_scheduler.FilterScheduler`` + - (StrOpt) Default scheduler driver to use. + * - ``scheduler_host_manager`` = ``manila.scheduler.host_manager.HostManager`` + - (StrOpt) The scheduler host manager class to use. + * - ``scheduler_json_config_location`` = ```` + - (StrOpt) Absolute path to scheduler configuration JSON file. + * - ``scheduler_manager`` = ``manila.scheduler.manager.SchedulerManager`` + - (StrOpt) Full class name for the scheduler manager. + * - ``scheduler_max_attempts`` = ``3`` + - (IntOpt) Maximum number of attempts to schedule a share. + * - ``scheduler_topic`` = ``manila-scheduler`` + - (StrOpt) The topic scheduler nodes listen on. diff --git a/doc/config-ref-rst/source/tables/manila-share.rst b/doc/config-ref-rst/source/tables/manila-share.rst new file mode 100644 index 0000000000..ade3a6ce99 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-share.rst @@ -0,0 +1,140 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Share configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``automatic_share_server_cleanup`` = ``True`` + - (BoolOpt) If set to True, then Manila will delete all share servers which were unused more than specified time .If set to False - automatic deletion of share servers will be disabled. + * - ``backlog`` = ``4096`` + - (IntOpt) Number of backlog requests to configure the socket with. + * - ``connect_share_server_to_tenant_network`` = ``False`` + - (BoolOpt) Attach share server directly to share network. Used only with Neutron. + * - ``default_share_type`` = ``None`` + - (StrOpt) Default share type to use. + * - ``delete_share_server_with_last_share`` = ``False`` + - (BoolOpt) Whether share servers will be deleted on deletion of the last share. + * - ``driver_handles_share_servers`` = ``None`` + - (BoolOpt) There are two possible approaches for share drivers in Manila. First is when share driver is able to handle share-servers and second when not. Drivers can support either both or only one of these approaches. So, set this opt to True if share driver is able to handle share servers and it is desired mode else set False. It is set to None by default to make this choice intentional. + * - ``enable_periodic_hooks`` = ``False`` + - (BoolOpt) Whether to enable periodic hooks or not. + * - ``enable_post_hooks`` = ``False`` + - (BoolOpt) Whether to enable post hooks or not. + * - ``enable_pre_hooks`` = ``False`` + - (BoolOpt) Whether to enable pre hooks or not. + * - ``enabled_share_backends`` = ``None`` + - (ListOpt) A list of share backend names to use. These backend names should be backed by a unique [CONFIG] group with its options. + * - ``enabled_share_protocols`` = ``NFS, CIFS`` + - (ListOpt) Specify list of protocols to be allowed for share creation. Available values are '('NFS', 'CIFS', 'GLUSTERFS', 'HDFS')' + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``hook_drivers`` = ```` + - (ListOpt) Driver(s) to perform some additional actions before and after share driver actions and on a periodic basis. Default is []. + * - ``interface_driver`` = ``manila.network.linux.interface.OVSInterfaceDriver`` + - (StrOpt) Vif driver. Used only with Neutron. + * - ``manila_service_keypair_name`` = ``manila-service`` + - (StrOpt) Keypair name that will be created and used for service instances. + * - ``max_time_to_attach`` = ``120`` + - (IntOpt) Maximum time to wait for attaching cinder volume. + * - ``max_time_to_build_instance`` = ``300`` + - (IntOpt) Maximum time in seconds to wait for creating service instance. + * - ``max_time_to_create_volume`` = ``180`` + - (IntOpt) Maximum time to wait for creating cinder volume. + * - ``max_time_to_extend_volume`` = ``180`` + - (IntOpt) Maximum time to wait for extending cinder volume. + * - ``migration_create_delete_share_timeout`` = ``300`` + - (IntOpt) Timeout for creating and deleting share instances when performing share migration (seconds). + * - ``migration_data_copy_node_ip`` = ``None`` + - (StrOpt) The IP of the node responsible for copying data during migration, such as the data copy service node, reachable by the backend. + * - ``migration_ignore_files`` = ``lost+found`` + - (ListOpt) List of files and folders to be ignored when migrating shares. Items should be names (not including any path). + * - ``migration_mounting_backend_ip`` = ``None`` + - (StrOpt) Backend IP in admin network to use for mounting shares during migration. + * - ``migration_protocol_mount_command`` = ``None`` + - (StrOpt) The command for mounting shares for this backend. Must specifythe executable and all necessary parameters for the protocol supported. It is advisable to separate protocols per backend. + * - ``migration_readonly_support`` = ``True`` + - (BoolOpt) Specify whether read only access mode is supported in thisbackend. + * - ``migration_tmp_location`` = ``/tmp/`` + - (StrOpt) Temporary path to create and mount shares during migration. + * - ``migration_wait_access_rules_timeout`` = ``90`` + - (IntOpt) Time to wait for access rules to be allowed/denied on backends when migrating shares using generic approach (seconds). + * - ``network_config_group`` = ``None`` + - (StrOpt) Name of the configuration group in the Manila conf file to look for network config options.If not set, the share backend's config group will be used.If an option is not found within provided group, then'DEFAULT' group will be used for search of option. + * - ``ovs_integration_bridge`` = ``br-int`` + - (StrOpt) Name of Open vSwitch bridge to use. + * - ``path_to_private_key`` = ``~/.ssh/id_rsa`` + - (StrOpt) Path to host's private key. + * - ``path_to_public_key`` = ``~/.ssh/id_rsa.pub`` + - (StrOpt) Path to hosts public key. + * - ``root_helper`` = ``sudo`` + - (StrOpt) Deprecated: command to use for running commands as root. + * - ``service_image_name`` = ``manila-service-image`` + - (StrOpt) Name of image in Glance, that will be used for service instance creation. + * - ``service_instance_flavor_id`` = ``100`` + - (IntOpt) ID of flavor, that will be used for service instance creation. + * - ``service_instance_name_or_id`` = ``None`` + - (StrOpt) Name or ID of service instance in Nova to use for share exports. Used only when share servers handling is disabled. + * - ``service_instance_name_template`` = ``manila_service_instance_%s`` + - (StrOpt) Name of service instance. + * - ``service_instance_network_helper_type`` = ``neutron`` + - (StrOpt) Allowed values are ['nova', 'neutron']. + * - ``service_instance_password`` = ``None`` + - (StrOpt) Password for service instance user. + * - ``service_instance_security_group`` = ``manila-service`` + - (StrOpt) Security group name, that will be used for service instance creation. + * - ``service_instance_smb_config_path`` = ``$share_mount_path/smb.conf`` + - (StrOpt) Path to SMB config in service instance. + * - ``service_instance_user`` = ``None`` + - (StrOpt) User in service instance that will be used for authentication. + * - ``service_net_name_or_ip`` = ``None`` + - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for managing shares there. Used only when share servers handling is disabled. + * - ``service_network_cidr`` = ``10.254.0.0/16`` + - (StrOpt) CIDR of manila service network. Used only with Neutron. + * - ``service_network_division_mask`` = ``28`` + - (IntOpt) This mask is used for dividing service network into subnets, IP capacity of subnet with this mask directly defines possible amount of created service VMs per tenant's subnet. Used only with Neutron. + * - ``service_network_name`` = ``manila_service_network`` + - (StrOpt) Name of manila service network. Used only with Neutron. + * - ``share_backend_name`` = ``None`` + - (StrOpt) The backend name for a given driver implementation. + * - ``share_driver`` = ``manila.share.drivers.generic.GenericShareDriver`` + - (StrOpt) Driver to use for share creation. + * - ``share_helpers`` = ``CIFS=manila.share.drivers.generic.CIFSHelper, NFS=manila.share.drivers.generic.NFSHelper`` + - (ListOpt) Specify list of share export helpers. + * - ``share_manager`` = ``manila.share.manager.ShareManager`` + - (StrOpt) Full class name for the share manager. + * - ``share_mount_path`` = ``/shares`` + - (StrOpt) Parent path in service instance where shares will be mounted. + * - ``share_name_template`` = ``share-%s`` + - (StrOpt) Template string to be used to generate share names. + * - ``share_snapshot_name_template`` = ``share-snapshot-%s`` + - (StrOpt) Template string to be used to generate share snapshot names. + * - ``share_usage_audit_period`` = ``month`` + - (StrOpt) Time period to generate share usages for. Time period must be hour, day, month or year. + * - ``share_volume_fstype`` = ``ext4`` + - (StrOpt) Filesystem type of the share volume. + * - ``smb_template_config_path`` = ``$state_path/smb.conf`` + - (StrOpt) Path to smb config. + * - ``suppress_post_hooks_errors`` = ``False`` + - (BoolOpt) Whether to suppress post hook errors (allow driver's results to pass through) or not. + * - ``suppress_pre_hooks_errors`` = ``False`` + - (BoolOpt) Whether to suppress pre hook errors (allow driver perform actions) or not. + * - ``tenant_net_name_or_ip`` = ``None`` + - (StrOpt) Can be either name of network that is used by service instance within Nova to get IP address or IP address itself for exporting shares. Used only when share servers handling is disabled. + * - ``unmanage_remove_access_rules`` = ``False`` + - (BoolOpt) If set to True, then manila will deny access and remove all access rules on share unmanage.If set to False - nothing will be changed. + * - ``unused_share_server_cleanup_interval`` = ``10`` + - (IntOpt) Unallocated share servers reclamation time interval (minutes). Minimum value is 10 minutes, maximum is 60 minutes. The reclamation function is run every 10 minutes and delete share servers which were unused more than unused_share_server_cleanup_interval option defines. This value reflects the shortest time Manila will wait for a share server to go unutilized before deleting it. + * - ``use_scheduler_creating_share_from_snapshot`` = ``False`` + - (BoolOpt) If set to False, then share creation from snapshot will be performed on the same host. If set to True, then scheduling step will be used. diff --git a/doc/config-ref-rst/source/tables/manila-storage.rst b/doc/config-ref-rst/source/tables/manila-storage.rst new file mode 100644 index 0000000000..51c15e0978 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-storage.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Storage configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cinder_admin_auth_url`` = ``http://localhost:5000/v2.0`` + - (StrOpt) Identity service URL. + * - ``cinder_admin_password`` = ``None`` + - (StrOpt) Cinder admin password. + * - ``cinder_admin_tenant_name`` = ``service`` + - (StrOpt) Cinder admin tenant name. + * - ``cinder_admin_username`` = ``cinder`` + - (StrOpt) Cinder admin username. + * - ``cinder_api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to cinder. + * - ``cinder_ca_certificates_file`` = ``None`` + - (StrOpt) Location of CA certificates file to use for cinder client requests. + * - ``cinder_catalog_info`` = ``volume:cinder:publicURL`` + - (StrOpt) Info to match when looking for cinder in the service catalog. Format is separated values of the form: :: + * - ``cinder_cross_az_attach`` = ``True`` + - (BoolOpt) Allow attaching between instances and volumes in different availability zones. + * - ``cinder_http_retries`` = ``3`` + - (IntOpt) Number of cinderclient retries on failed HTTP calls. + * - ``cinder_volume_type`` = ``None`` + - (StrOpt) Name or id of cinder volume type which will be used for all volumes created by driver. + * - ``max_gigabytes`` = ``10000`` + - (IntOpt) Maximum number of volume gigabytes to allow per host. diff --git a/doc/config-ref-rst/source/tables/manila-winrm.rst b/doc/config-ref-rst/source/tables/manila-winrm.rst new file mode 100644 index 0000000000..337574397c --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-winrm.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of WinRM configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``winrm_cert_key_pem_path`` = ``~/.ssl/key.pem`` + - (StrOpt) Path to the x509 certificate key. + * - ``winrm_cert_pem_path`` = ``~/.ssl/cert.pem`` + - (StrOpt) Path to the x509 certificate used for accessing the serviceinstance. + * - ``winrm_conn_timeout`` = ``60`` + - (IntOpt) WinRM connection timeout. + * - ``winrm_operation_timeout`` = ``60`` + - (IntOpt) WinRM operation timeout. + * - ``winrm_retry_count`` = ``3`` + - (IntOpt) WinRM retry count. + * - ``winrm_retry_interval`` = ``5`` + - (IntOpt) WinRM retry interval in seconds + * - ``winrm_use_cert_based_auth`` = ``False`` + - (BoolOpt) Use x509 certificates in order to authenticate to theservice instance. diff --git a/doc/config-ref-rst/source/tables/manila-zeromq.rst b/doc/config-ref-rst/source/tables/manila-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/manila-zfssa.rst b/doc/config-ref-rst/source/tables/manila-zfssa.rst new file mode 100644 index 0000000000..03df63b1c9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/manila-zfssa.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZFSSA Share Driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zfssa_auth_password`` = ``None`` + - (StrOpt) ZFSSA management authorized userpassword. + * - ``zfssa_auth_user`` = ``None`` + - (StrOpt) ZFSSA management authorized username. + * - ``zfssa_data_ip`` = ``None`` + - (StrOpt) IP address for data. + * - ``zfssa_host`` = ``None`` + - (StrOpt) ZFSSA management IP address. + * - ``zfssa_nas_checksum`` = ``fletcher4`` + - (StrOpt) Controls checksum used for data blocks. + * - ``zfssa_nas_compression`` = ``off`` + - (StrOpt) Data compression-off, lzjb, gzip-2, gzip, gzip-9. + * - ``zfssa_nas_logbias`` = ``latency`` + - (StrOpt) Controls behavior when servicing synchronous writes. + * - ``zfssa_nas_mountpoint`` = ```` + - (StrOpt) Location of project in ZFS/SA. + * - ``zfssa_nas_quota_snap`` = ``true`` + - (StrOpt) Controls whether a share quota includes snapshot. + * - ``zfssa_nas_rstchown`` = ``true`` + - (StrOpt) Controls whether file ownership can be changed. + * - ``zfssa_nas_vscan`` = ``false`` + - (StrOpt) Controls whether the share is scanned for viruses. + * - ``zfssa_pool`` = ``None`` + - (StrOpt) ZFSSA storage pool name. + * - ``zfssa_project`` = ``None`` + - (StrOpt) ZFSSA project name. + * - ``zfssa_rest_timeout`` = ``None`` + - (StrOpt) REST connection timeout (in seconds). diff --git a/doc/config-ref-rst/source/tables/nova-amqp.rst b/doc/config-ref-rst/source/tables/nova-amqp.rst new file mode 100644 index 0000000000..fd92ae1e54 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-amqp.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``default_publisher_id`` = ``None`` + - (StrOpt) Default publisher_id for outgoing notifications + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/nova-api.rst b/doc/config-ref-rst/source/tables/nova-api.rst new file mode 100644 index 0000000000..f555f663e5 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-api.rst @@ -0,0 +1,80 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``api_paste_config`` = ``api-paste.ini`` + - (StrOpt) File name for the paste.deploy config for nova-api + * - ``api_rate_limit`` = ``False`` + - (BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v2.1 api. + * - ``client_socket_timeout`` = ``900`` + - (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. + * - ``enable_new_services`` = ``True`` + - (BoolOpt) Services to be added to the available pool on create + * - ``enabled_apis`` = ``ec2, osapi_compute, metadata`` + - (ListOpt) A list of APIs to enable by default + * - ``enabled_ssl_apis`` = ```` + - (ListOpt) A list of APIs with enabled SSL + * - ``instance_name_template`` = ``instance-%08x`` + - (StrOpt) Template string to be used to generate instance names + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``multi_instance_display_name_template`` = ``%(name)s-%(count)d`` + - (StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. + * - ``non_inheritable_image_properties`` = ``cache_in_nova, bittorrent`` + - (ListOpt) These are image properties which a snapshot should not inherit from an instance + * - ``null_kernel`` = ``nokernel`` + - (StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead + * - ``osapi_compute_ext_list`` = ```` + - (ListOpt) DEPRECATED: Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.legacy_v2.contrib.select_extensions This option will be removed in the near future. After that point you have to run all of the API. + * - ``osapi_compute_extension`` = ``['nova.api.openstack.compute.legacy_v2.contrib.standard_extensions']`` + - (MultiStrOpt) osapi compute extension to load. This option will be removed in the near future. After that point you have to run all of the API. + * - ``osapi_compute_link_prefix`` = ``None`` + - (StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API + * - ``osapi_compute_listen`` = ``0.0.0.0`` + - (StrOpt) The IP address on which the OpenStack API will listen. + * - ``osapi_compute_listen_port`` = ``8774`` + - (IntOpt) The port on which the OpenStack API will listen. + * - ``osapi_compute_workers`` = ``None`` + - (IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. + * - ``osapi_hide_server_address_states`` = ``building`` + - (ListOpt) List of instance states that should hide network info + * - ``secure_proxy_ssl_header`` = ``None`` + - (StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO". + * - ``servicegroup_driver`` = ``db`` + - (StrOpt) The driver for servicegroup service. + * - ``snapshot_name_template`` = ``snapshot-%s`` + - (StrOpt) Template string to be used to generate snapshot names + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + * - ``use_forwarded_for`` = ``False`` + - (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. + * - ``wsgi_default_pool_size`` = ``1000`` + - (IntOpt) Size of the pool of greenthreads used by wsgi + * - ``wsgi_keep_alive`` = ``True`` + - (BoolOpt) If False, closes the client socket connection explicitly. + * - ``wsgi_log_format`` = ``%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f`` + - (StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[oslo_versionedobjects]** + - + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal diff --git a/doc/config-ref-rst/source/tables/nova-apiv21.rst b/doc/config-ref-rst/source/tables/nova-apiv21.rst new file mode 100644 index 0000000000..330269d7a3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-apiv21.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API v2.1 configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[osapi_v21]** + - + * - ``enabled`` = ``True`` + - (BoolOpt) DEPRECATED: Whether the V2.1 API is enabled or not. This option will be removed in the near future. + * - ``extensions_blacklist`` = ```` + - (ListOpt) DEPRECATED: A list of v2.1 API extensions to never load. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. + * - ``extensions_whitelist`` = ```` + - (ListOpt) DEPRECATED: If the list is not empty then a v2.1 API extension will only be loaded if it exists in this list. Specify the extension aliases here. This option will be removed in the near future. After that point you have to run all of the API. diff --git a/doc/config-ref-rst/source/tables/nova-auth_token.rst b/doc/config-ref-rst/source/tables/nova-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/nova-authentication.rst b/doc/config-ref-rst/source/tables/nova-authentication.rst new file mode 100644 index 0000000000..f81d4c920f --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-authentication.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authentication configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) The strategy to use for auth: keystone or noauth2. noauth2 is designed for +testing only, as it does no actual credential checking. noauth2 provides +administrative credentials only if 'admin' is specified as the username. diff --git a/doc/config-ref-rst/source/tables/nova-availabilityzones.rst b/doc/config-ref-rst/source/tables/nova-availabilityzones.rst new file mode 100644 index 0000000000..3b63a42c7b --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-availabilityzones.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of availability zones configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``default_availability_zone`` = ``nova`` + - (StrOpt) Default compute node availability_zone + * - ``default_schedule_zone`` = ``None`` + - (StrOpt) Availability zone to use when user doesn't specify one + * - ``internal_service_availability_zone`` = ``internal`` + - (StrOpt) The availability_zone to show internal services under diff --git a/doc/config-ref-rst/source/tables/nova-barbican.rst b/doc/config-ref-rst/source/tables/nova-barbican.rst new file mode 100644 index 0000000000..5a90ed6593 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-barbican.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Barbican configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[barbican]** + - + * - ``cafile`` = ``None`` + - (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``catalog_info`` = ``key-manager:barbican:public`` + - (StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: :: + * - ``certfile`` = ``None`` + - (StrOpt) PEM encoded client certificate cert file + * - ``endpoint_template`` = ``None`` + - (StrOpt) Override service catalog lookup with template for barbican endpoint e.g. http://localhost:9311/v1/%(project_id)s + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) PEM encoded client certificate key file + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name of this node + * - ``timeout`` = ``None`` + - (IntOpt) Timeout value for http requests diff --git a/doc/config-ref-rst/source/tables/nova-ca.rst b/doc/config-ref-rst/source/tables/nova-ca.rst new file mode 100644 index 0000000000..125f1dc5e1 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ca.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CA and SSL configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ca_file`` = ``cacert.pem`` + - (StrOpt) Filename of root CA + * - ``ca_path`` = ``$state_path/CA`` + - (StrOpt) Where we keep our root CA + * - ``cert`` = ``self.pem`` + - (StrOpt) SSL certificate file + * - ``cert_manager`` = ``nova.cert.manager.CertManager`` + - (StrOpt) Full class name for the Manager for cert + * - ``cert_topic`` = ``cert`` + - (StrOpt) The topic cert nodes listen on + * - ``crl_file`` = ``crl.pem`` + - (StrOpt) Filename of root Certificate Revocation List + * - ``key_file`` = ``private/cakey.pem`` + - (StrOpt) Filename of private key + * - ``keys_path`` = ``$state_path/keys`` + - (StrOpt) Where we keep our keys + * - ``project_cert_subject`` = ``/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s`` + - (StrOpt) Subject for certificate for projects, %s for project, timestamp + * - ``ssl_ca_file`` = ``None`` + - (StrOpt) CA certificate file to use to verify connecting clients + * - ``ssl_cert_file`` = ``None`` + - (StrOpt) SSL certificate of API server + * - ``ssl_key_file`` = ``None`` + - (StrOpt) SSL private key of API server + * - ``use_project_ca`` = ``False`` + - (BoolOpt) Should we use a CA for each project? + * - ``user_cert_subject`` = ``/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s`` + - (StrOpt) Subject for certificate for users, %s for project, user, timestamp + * - **[ssl]** + - + * - ``ca_file`` = ``None`` + - (StrOpt) CA certificate file to use to verify connecting clients. + * - ``cert_file`` = ``None`` + - (StrOpt) Certificate file to use when starting the server securely. + * - ``ciphers`` = ``None`` + - (StrOpt) Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. + * - ``key_file`` = ``None`` + - (StrOpt) Private key file to use when starting the server securely. + * - ``version`` = ``None`` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. diff --git a/doc/config-ref-rst/source/tables/nova-cells.rst b/doc/config-ref-rst/source/tables/nova-cells.rst new file mode 100644 index 0000000000..3fdbc80990 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-cells.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cell configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cells]** + - + * - ``call_timeout`` = ``60`` + - (IntOpt) Seconds to wait for response from a call to a cell. + * - ``capabilities`` = ``hypervisor=xenserver;kvm, os=linux;windows`` + - (ListOpt) Key/Multi-value list with the capabilities of the cell + * - ``cell_type`` = ``compute`` + - (StrOpt) Type of cell + * - ``cells_config`` = ``None`` + - (StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database. + * - ``db_check_interval`` = ``60`` + - (IntOpt) Interval, in seconds, for getting fresh cell information from the database. + * - ``driver`` = ``nova.cells.rpc_driver.CellsRPCDriver`` + - (StrOpt) Cells communication driver to use + * - ``enable`` = ``False`` + - (BoolOpt) Enable cell functionality + * - ``instance_update_num_instances`` = ``1`` + - (IntOpt) Number of instances to update per periodic task run + * - ``instance_update_sync_database_limit`` = ``100`` + - (IntOpt) Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through + * - ``instance_updated_at_threshold`` = ``3600`` + - (IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells + * - ``manager`` = ``nova.cells.manager.CellsManager`` + - (StrOpt) Manager for cells + * - ``max_hop_count`` = ``10`` + - (IntOpt) Maximum number of hops for cells routing. + * - ``mute_child_interval`` = ``300`` + - (IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute. + * - ``mute_weight_multiplier`` = ``-10000.0`` + - (FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) + * - ``name`` = ``nova`` + - (StrOpt) Name of this cell + * - ``offset_weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used to weigh offset weigher. + * - ``reserve_percent`` = ``10.0`` + - (FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization + * - ``topic`` = ``cells`` + - (StrOpt) The topic cells nodes listen on diff --git a/doc/config-ref-rst/source/tables/nova-common.rst b/doc/config-ref-rst/source/tables/nova-common.rst new file mode 100644 index 0000000000..83f9b9a384 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-common.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``bindir`` = ``/usr/local/bin`` + - (StrOpt) Directory where nova binaries are installed + * - ``compute_topic`` = ``compute`` + - (StrOpt) The topic compute nodes listen on + * - ``console_topic`` = ``console`` + - (StrOpt) The topic console proxy nodes listen on + * - ``consoleauth_topic`` = ``consoleauth`` + - (StrOpt) The topic console auth proxy nodes listen on + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``host`` = ``localhost`` + - (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``my_ip`` = ``10.0.0.1`` + - (StrOpt) IP address of this host + * - ``notify_api_faults`` = ``False`` + - (BoolOpt) If set, send api.fault notifications on caught exceptions in the API service. + * - ``notify_on_state_change`` = ``None`` + - (StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. + * - ``pybasedir`` = ``/usr/lib/python/site-packages/nova`` + - (StrOpt) Directory where the nova python module is installed + * - ``report_interval`` = ``10`` + - (IntOpt) Seconds between nodes reporting state to datastore + * - ``rootwrap_config`` = ``/etc/nova/rootwrap.conf`` + - (StrOpt) Path to the rootwrap configuration file to use for running commands as root + * - ``service_down_time`` = ``60`` + - (IntOpt) Maximum time since last check-in for up service + * - ``state_path`` = ``$pybasedir`` + - (StrOpt) Top-level directory for maintaining nova's state + * - ``tempdir`` = ``None`` + - (StrOpt) Explicitly specify the temporary working directory + * - ``use_rootwrap_daemon`` = ``False`` + - (BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - **[workarounds]** + - + * - ``destroy_after_evacuate`` = ``True`` + - (BoolOpt) DEPRECATED: Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785 + * - ``disable_libvirt_livesnapshot`` = ``True`` + - (BoolOpt) When using libvirt 1.2.2 live snapshots fail intermittently under load. This config option provides a mechanism to enable live snapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398 + * - ``disable_rootwrap`` = ``False`` + - (BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106 + * - ``handle_virt_lifecycle_events`` = ``True`` + - (BoolOpt) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630 diff --git a/doc/config-ref-rst/source/tables/nova-compute.rst b/doc/config-ref-rst/source/tables/nova-compute.rst new file mode 100644 index 0000000000..755cc798ca --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-compute.rst @@ -0,0 +1,90 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Compute configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``compute_available_monitors`` = ``None`` + - (MultiStrOpt) Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins. + * - ``compute_driver`` = ``None`` + - (StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, ironic.IronicDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver + * - ``compute_manager`` = ``nova.compute.manager.ComputeManager`` + - (StrOpt) Full class name for the Manager for compute + * - ``compute_monitors`` = ```` + - (ListOpt) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. An example value that would enable both the CPU and NUMA memory bandwidth monitors that used the virt driver variant: ["cpu.virt_driver", "numa_mem_bw.virt_driver"] + * - ``compute_resources`` = ```` + - (ListOpt) DEPRECATED: The names of the extra resources to track. The Extensible Resource Tracker is deprecated and will be removed in the 14.0.0 release. If you use this functionality and have custom resources that are managed by the Extensible Resource Tracker, please contact the Nova development team by posting to the openstack-dev mailing list. There is no future planned support for the tracking of custom resources. + * - ``compute_stats_class`` = ``nova.compute.stats.Stats`` + - (StrOpt) Class that will manage stats for the local compute host + * - ``console_host`` = ``localhost`` + - (StrOpt) Console proxy host to use to connect to instances on this host. + * - ``console_manager`` = ``nova.console.manager.ConsoleProxyManager`` + - (StrOpt) Full class name for the Manager for console proxy + * - ``default_flavor`` = ``m1.small`` + - (StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. + * - ``default_notification_level`` = ``INFO`` + - (StrOpt) Default notification level for outgoing notifications + * - ``enable_instance_password`` = ``True`` + - (BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct + * - ``heal_instance_info_cache_interval`` = ``60`` + - (IntOpt) Number of seconds between instance network information cache updates + * - ``image_cache_manager_interval`` = ``2400`` + - (IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will run at the default rate. + * - ``image_cache_subdirectory_name`` = ``_base`` + - (StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip + * - ``instance_build_timeout`` = ``0`` + - (IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status. Set to 0 to disable. + * - ``instance_delete_interval`` = ``300`` + - (IntOpt) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate. + * - ``instance_usage_audit`` = ``False`` + - (BoolOpt) Generate periodic compute.instance.exists notifications + * - ``instance_usage_audit_period`` = ``month`` + - (StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year + * - ``instances_path`` = ``$state_path/instances`` + - (StrOpt) Where instances are stored on disk + * - ``max_concurrent_builds`` = ``10`` + - (IntOpt) Maximum number of instance builds to run concurrently + * - ``maximum_instance_delete_attempts`` = ``5`` + - (IntOpt) The number of times to attempt to reap an instance's files. + * - ``reboot_timeout`` = ``0`` + - (IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable. + * - ``reclaim_instance_interval`` = ``0`` + - (IntOpt) Interval in seconds for reclaiming deleted instances + * - ``rescue_timeout`` = ``0`` + - (IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable. + * - ``resize_confirm_window`` = ``0`` + - (IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable. + * - ``resume_guests_state_on_host_boot`` = ``False`` + - (BoolOpt) Whether to start guests that were running before the host rebooted + * - ``running_deleted_instance_action`` = ``reap`` + - (StrOpt) Action to take if a running deleted instance is detected.Set to 'noop' to take no action. + * - ``running_deleted_instance_poll_interval`` = ``1800`` + - (IntOpt) Number of seconds to wait between runs of the cleanup task. + * - ``running_deleted_instance_timeout`` = ``0`` + - (IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup. + * - ``shelved_offload_time`` = ``0`` + - (IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload immediately when shelved + * - ``shelved_poll_interval`` = ``3600`` + - (IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate. + * - ``shutdown_timeout`` = ``60`` + - (IntOpt) Total amount of time to wait in seconds for an instance to perform a clean shutdown. + * - ``sync_power_state_interval`` = ``600`` + - (IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate. + * - ``update_resources_interval`` = ``0`` + - (IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. + * - ``vif_plugging_is_fatal`` = ``True`` + - (BoolOpt) Fail instance boot if vif plugging fails + * - ``vif_plugging_timeout`` = ``300`` + - (IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all. diff --git a/doc/config-ref-rst/source/tables/nova-conductor.rst b/doc/config-ref-rst/source/tables/nova-conductor.rst new file mode 100644 index 0000000000..9d6fd32e36 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-conductor.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of conductor configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``migrate_max_retries`` = ``-1`` + - (IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries. + * - **[conductor]** + - + * - ``manager`` = ``nova.conductor.manager.ConductorManager`` + - (StrOpt) Full class name for the Manager for conductor + * - ``topic`` = ``conductor`` + - (StrOpt) The topic on which conductor nodes listen + * - ``use_local`` = ``False`` + - (BoolOpt) DEPRECATED: Perform nova-conductor operations locally. This legacy mode was introduced to bridge a gap during the transition to the conductor service. It no longer represents a reasonable alternative for deployers. Removal may be as early as 14.0 + * - ``workers`` = ``None`` + - (IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. diff --git a/doc/config-ref-rst/source/tables/nova-configdrive.rst b/doc/config-ref-rst/source/tables/nova-configdrive.rst new file mode 100644 index 0000000000..a1096757f9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-configdrive.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of config drive configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``config_drive_format`` = ``iso9660`` + - (StrOpt) Config drive format. + * - ``config_drive_skip_versions`` = ``1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01`` + - (StrOpt) List of metadata versions to skip placing into the config drive + * - ``force_config_drive`` = ``False`` + - (BoolOpt) Force injection to take place on a config drive + * - ``mkisofs_cmd`` = ``genisoimage`` + - (StrOpt) Name and optionally path of the tool used for ISO image creation + * - **[hyperv]** + - + * - ``config_drive_cdrom`` = ``False`` + - (BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive + * - ``config_drive_inject_password`` = ``False`` + - (BoolOpt) Sets the admin password in the config drive image diff --git a/doc/config-ref-rst/source/tables/nova-console.rst b/doc/config-ref-rst/source/tables/nova-console.rst new file mode 100644 index 0000000000..5c7b8bbb1d --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-console.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of console configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``console_allowed_origins`` = ```` + - (ListOpt) Allowed Origin header hostnames for access to console proxy servers + * - ``console_public_hostname`` = ``localhost`` + - (StrOpt) Publicly visible name for this console host + * - ``console_token_ttl`` = ``600`` + - (IntOpt) How many seconds before deleting tokens + * - ``consoleauth_manager`` = ``nova.consoleauth.manager.ConsoleAuthManager`` + - (StrOpt) Manager for console auth + * - **[mks]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) Enable MKS related features + * - ``mksproxy_base_url`` = ``http://127.0.0.1:6090/`` + - (StrOpt) Location of MKS web console proxy, in the form "http://127.0.0.1:6090/" diff --git a/doc/config-ref-rst/source/tables/nova-cors.rst b/doc/config-ref-rst/source/tables/nova-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/nova-database.rst b/doc/config-ref-rst/source/tables/nova-database.rst new file mode 100644 index 0000000000..a6e90b71b9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-database.rst @@ -0,0 +1,90 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``db_driver`` = ``nova.db`` + - (StrOpt) The driver to use for database access + * - **[api_database]** + - + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the Nova API database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. + * - ``use_tpool`` = ``False`` + - (BoolOpt) Enable the experimental use of thread pooling for all DB API calls diff --git a/doc/config-ref-rst/source/tables/nova-debug.rst b/doc/config-ref-rst/source/tables/nova-debug.rst new file mode 100644 index 0000000000..c13f8984f2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-debug.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[guestfs]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Enable guestfs debug diff --git a/doc/config-ref-rst/source/tables/nova-ec2.rst b/doc/config-ref-rst/source/tables/nova-ec2.rst new file mode 100644 index 0000000000..cffda80f65 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ec2.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of EC2 configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ec2_dmz_host`` = ``$my_ip`` + - (StrOpt) The internal IP address of the EC2 API server + * - ``ec2_host`` = ``$my_ip`` + - (StrOpt) The IP address of the EC2 API server + * - ``ec2_listen`` = ``0.0.0.0`` + - (StrOpt) The IP address on which the EC2 API will listen. + * - ``ec2_listen_port`` = ``8773`` + - (IntOpt) The port on which the EC2 API will listen. + * - ``ec2_path`` = ``/`` + - (StrOpt) The path prefix used to call the ec2 API server + * - ``ec2_port`` = ``8773`` + - (IntOpt) The port of the EC2 API server + * - ``ec2_private_dns_show_ip`` = ``False`` + - (BoolOpt) Return the IP address as private dns hostname in describe instances + * - ``ec2_scheme`` = ``http`` + - (StrOpt) The protocol to use when connecting to the EC2 API server + * - ``ec2_strict_validation`` = ``True`` + - (BoolOpt) Validate security group names according to EC2 specification + * - ``ec2_timestamp_expiry`` = ``300`` + - (IntOpt) Time in seconds before ec2 timestamp expires + * - ``ec2_workers`` = ``None`` + - (IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available. + * - ``keystone_ec2_insecure`` = ``False`` + - (BoolOpt) Disable SSL certificate verification. + * - ``keystone_ec2_url`` = ``http://localhost:5000/v2.0/ec2tokens`` + - (StrOpt) URL to get token from ec2 request. + * - ``lockout_attempts`` = ``5`` + - (IntOpt) Number of failed auths before lockout. + * - ``lockout_minutes`` = ``15`` + - (IntOpt) Number of minutes to lockout if triggered. + * - ``lockout_window`` = ``15`` + - (IntOpt) Number of minutes for lockout window. + * - ``region_list`` = ```` + - (ListOpt) List of region=fqdn pairs separated by commas diff --git a/doc/config-ref-rst/source/tables/nova-ephemeral_storage_encryption.rst b/doc/config-ref-rst/source/tables/nova-ephemeral_storage_encryption.rst new file mode 100644 index 0000000000..bbcce3b139 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ephemeral_storage_encryption.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ephemeral storage encryption configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ephemeral_storage_encryption]** + - + * - ``cipher`` = ``aes-xts-plain64`` + - (StrOpt) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See /proc/crypto for the list of available options. + * - ``enabled`` = ``False`` + - (BoolOpt) Whether to encrypt ephemeral storage + * - ``key_size`` = ``512`` + - (IntOpt) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key) diff --git a/doc/config-ref-rst/source/tables/nova-fping.rst b/doc/config-ref-rst/source/tables/nova-fping.rst new file mode 100644 index 0000000000..680455fa50 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-fping.rst @@ -0,0 +1,20 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of fping configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``fping_path`` = ``/usr/sbin/fping`` + - (StrOpt) Full path to fping. diff --git a/doc/config-ref-rst/source/tables/nova-glance.rst b/doc/config-ref-rst/source/tables/nova-glance.rst new file mode 100644 index 0000000000..163def9e00 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-glance.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of glance configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``osapi_glance_link_prefix`` = ``None`` + - (StrOpt) Base URL that will be presented to users in links to glance resources + * - **[glance]** + - + * - ``allowed_direct_url_schemes`` = ```` + - (ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL (https) requests to glance + * - ``api_servers`` = ``None`` + - (ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port) + * - ``host`` = ``$my_ip`` + - (StrOpt) Default glance hostname or IP address + * - ``num_retries`` = ``0`` + - (IntOpt) Number of retries when uploading / downloading an image to / from glance. + * - ``port`` = ``9292`` + - (IntOpt) Default glance port + * - ``protocol`` = ``http`` + - (StrOpt) Default protocol to use when connecting to glance. Set to https for SSL. + * - **[image_file_url]** + - + * - ``filesystems`` = ```` + - (ListOpt) List of file systems that are configured in this file in the image_file_url: sections diff --git a/doc/config-ref-rst/source/tables/nova-hyperv.rst b/doc/config-ref-rst/source/tables/nova-hyperv.rst new file mode 100644 index 0000000000..0a5b920a7a --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-hyperv.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of HyperV configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[hyperv]** + - + * - ``dynamic_memory_ratio`` = ``1.0`` + - (FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup + * - ``enable_instance_metrics_collection`` = ``False`` + - (BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above + * - ``force_hyperv_utils_v1`` = ``False`` + - (BoolOpt) Force V1 WMI utility classes + * - ``instances_path_share`` = ```` + - (StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally + * - ``limit_cpu_features`` = ``False`` + - (BoolOpt) Required for live migration among hosts with different CPU features + * - ``mounted_disk_query_retry_count`` = ``10`` + - (IntOpt) The number of times to retry checking for a disk mounted via iSCSI. + * - ``mounted_disk_query_retry_interval`` = ``5`` + - (IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. + * - ``power_state_check_timeframe`` = ``60`` + - (IntOpt) The timeframe to be checked for instance power state changes. + * - ``power_state_event_polling_interval`` = ``2`` + - (IntOpt) Instance power state change event polling frequency. + * - ``qemu_img_cmd`` = ``qemu-img.exe`` + - (StrOpt) Path of qemu-img command which is used to convert between different image types + * - ``vswitch_name`` = ``None`` + - (StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used + * - ``wait_soft_reboot_seconds`` = ``60`` + - (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. diff --git a/doc/config-ref-rst/source/tables/nova-hypervisor.rst b/doc/config-ref-rst/source/tables/nova-hypervisor.rst new file mode 100644 index 0000000000..a3e2e5c25b --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-hypervisor.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of hypervisor configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``default_ephemeral_format`` = ``None`` + - (StrOpt) The default format an ephemeral_volume will be formatted with on creation. + * - ``force_raw_images`` = ``True`` + - (BoolOpt) Force backing images to raw format + * - ``preallocate_images`` = ``none`` + - (StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start + * - ``timeout_nbd`` = ``10`` + - (IntOpt) Amount of time, in seconds, to wait for NBD device start up. + * - ``use_cow_images`` = ``True`` + - (BoolOpt) Whether to use cow images + * - ``vcpu_pin_set`` = ``None`` + - (StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15" + * - ``virt_mkfs`` = ``[]`` + - (MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is = diff --git a/doc/config-ref-rst/source/tables/nova-ipv6.rst b/doc/config-ref-rst/source/tables/nova-ipv6.rst new file mode 100644 index 0000000000..09b9c1cad3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ipv6.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of IPv6 configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``fixed_range_v6`` = ``fd00::/48`` + - (StrOpt) Fixed IPv6 address block + * - ``gateway_v6`` = ``None`` + - (StrOpt) Default IPv6 gateway + * - ``ipv6_backend`` = ``rfc2462`` + - (StrOpt) Backend to use for IPv6 generation + * - ``use_ipv6`` = ``False`` + - (BoolOpt) Use IPv6 diff --git a/doc/config-ref-rst/source/tables/nova-ironic.rst b/doc/config-ref-rst/source/tables/nova-ironic.rst new file mode 100644 index 0000000000..91f8f4c179 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ironic.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of bare metal configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[ironic]** + - + * - ``admin_auth_token`` = ``None`` + - (StrOpt) Ironic keystone auth token.DEPRECATED: use admin_username, admin_password, and admin_tenant_name instead + * - ``admin_password`` = ``None`` + - (StrOpt) Ironic keystone admin password. + * - ``admin_tenant_name`` = ``None`` + - (StrOpt) Ironic keystone tenant name. + * - ``admin_url`` = ``None`` + - (StrOpt) Keystone public API endpoint. + * - ``admin_username`` = ``None`` + - (StrOpt) Ironic keystone admin name + * - ``api_endpoint`` = ``None`` + - (StrOpt) URL for Ironic API endpoint. + * - ``api_max_retries`` = ``60`` + - (IntOpt) How many retries when a request does conflict. If <= 0, only try once, no retries. + * - ``api_retry_interval`` = ``2`` + - (IntOpt) How often to retry in seconds when a request does conflict + * - ``api_version`` = ``1`` + - (IntOpt) Version of Ironic API service endpoint. + * - ``client_log_level`` = ``None`` + - (StrOpt) Log level override for ironicclient. Set this in order to override the global "default_log_levels", "verbose", and "debug" settings. DEPRECATED: use standard logging configuration. diff --git a/doc/config-ref-rst/source/tables/nova-keymgr.rst b/doc/config-ref-rst/source/tables/nova-keymgr.rst new file mode 100644 index 0000000000..1d0024df57 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-keymgr.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of key manager configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keymgr]** + - + * - ``api_class`` = ``nova.keymgr.conf_key_mgr.ConfKeyManager`` + - (StrOpt) The full class name of the key manager API class + * - ``fixed_key`` = ``None`` + - (StrOpt) Fixed key returned by key manager, specified in hex diff --git a/doc/config-ref-rst/source/tables/nova-ldap.rst b/doc/config-ref-rst/source/tables/nova-ldap.rst new file mode 100644 index 0000000000..f66bd6989b --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-ldap.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of LDAP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ldap_dns_base_dn`` = ``ou=hosts,dc=example,dc=org`` + - (StrOpt) Base DN for DNS entries in LDAP + * - ``ldap_dns_password`` = ``password`` + - (StrOpt) Password for LDAP DNS + * - ``ldap_dns_servers`` = ``['dns.example.org']`` + - (MultiStrOpt) DNS Servers for LDAP DNS driver + * - ``ldap_dns_soa_expiry`` = ``86400`` + - (StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority + * - ``ldap_dns_soa_hostmaster`` = ``hostmaster@example.org`` + - (StrOpt) Hostmaster for LDAP DNS driver Statement of Authority + * - ``ldap_dns_soa_minimum`` = ``7200`` + - (StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority + * - ``ldap_dns_soa_refresh`` = ``1800`` + - (StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority + * - ``ldap_dns_soa_retry`` = ``3600`` + - (StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority + * - ``ldap_dns_url`` = ``ldap://ldap.example.com:389`` + - (StrOpt) URL for LDAP server which will store DNS entries + * - ``ldap_dns_user`` = ``uid=admin,ou=people,dc=example,dc=org`` + - (StrOpt) User for LDAP DNS diff --git a/doc/config-ref-rst/source/tables/nova-libvirt.rst b/doc/config-ref-rst/source/tables/nova-libvirt.rst new file mode 100644 index 0000000000..0ed682716e --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-libvirt.rst @@ -0,0 +1,106 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Libvirt configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``remove_unused_base_images`` = ``True`` + - (BoolOpt) Should unused base images be removed? + * - ``remove_unused_original_minimum_age_seconds`` = ``86400`` + - (IntOpt) Unused unresized base images younger than this will not be removed + * - **[libvirt]** + - + * - ``block_migration_flag`` = ``VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED, VIR_MIGRATE_NON_SHARED_INC`` + - (StrOpt) Migration flags to be set for block migration + * - ``checksum_base_images`` = ``False`` + - (BoolOpt) Write a checksum for files in _base to disk + * - ``checksum_interval_seconds`` = ``3600`` + - (IntOpt) How frequently to checksum base images + * - ``connection_uri`` = ```` + - (StrOpt) Override the default libvirt URI (which is dependent on virt_type) + * - ``cpu_mode`` = ``None`` + - (StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none" + * - ``cpu_model`` = ``None`` + - (StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu" + * - ``disk_cachemodes`` = ```` + - (ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none + * - ``disk_prefix`` = ``None`` + - (StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd) + * - ``gid_maps`` = ```` + - (ListOpt) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed. + * - ``hw_disk_discard`` = ``None`` + - (StrOpt) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format) + * - ``hw_machine_type`` = ``None`` + - (ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2 + * - ``image_info_filename_pattern`` = ``$instances_path/$image_cache_subdirectory_name/%(image)s.info`` + - (StrOpt) Allows image information files to be stored in non-standard locations + * - ``images_rbd_ceph_conf`` = ```` + - (StrOpt) Path to the ceph configuration file to use + * - ``images_rbd_pool`` = ``rbd`` + - (StrOpt) The RADOS pool in which rbd volumes are stored + * - ``images_type`` = ``default`` + - (StrOpt) VM Images format. If default is specified, then use_cow_images flag is used instead of this one. + * - ``images_volume_group`` = ``None`` + - (StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. + * - ``inject_key`` = ``False`` + - (BoolOpt) Inject the ssh public key at boot time + * - ``inject_partition`` = ``-2`` + - (IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number + * - ``inject_password`` = ``False`` + - (BoolOpt) Inject the admin password at boot time, without an agent. + * - ``iscsi_iface`` = ``None`` + - (StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form . where is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. + * - ``iscsi_use_multipath`` = ``False`` + - (BoolOpt) Use multipath connection of the iSCSI volume + * - ``iser_use_multipath`` = ``False`` + - (BoolOpt) Use multipath connection of the iSER volume + * - ``mem_stats_period_seconds`` = ``10`` + - (IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. + * - ``remove_unused_kernels`` = ``True`` + - (BoolOpt) DEPRECATED: Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option (running Grizzly or newer level compute). This will be the default behavior in the 13.0.0 release. + * - ``remove_unused_resized_minimum_age_seconds`` = ``3600`` + - (IntOpt) Unused resized base images younger than this will not be removed + * - ``rescue_image_id`` = ``None`` + - (StrOpt) Rescue ami image. This will not be used if an image id is provided by the user. + * - ``rescue_kernel_id`` = ``None`` + - (StrOpt) Rescue aki image + * - ``rescue_ramdisk_id`` = ``None`` + - (StrOpt) Rescue ari image + * - ``rng_dev_path`` = ``None`` + - (StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng + * - ``snapshot_compression`` = ``False`` + - (BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images + * - ``snapshot_image_format`` = ``None`` + - (StrOpt) Snapshot image format. Defaults to same as source image + * - ``snapshots_directory`` = ``$instances_path/snapshots`` + - (StrOpt) Location where libvirt driver will store snapshots before uploading them to image service + * - ``sparse_logical_volumes`` = ``False`` + - (BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True. + * - ``sysinfo_serial`` = ``auto`` + - (StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. + * - ``uid_maps`` = ```` + - (ListOpt) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed. + * - ``use_usb_tablet`` = ``True`` + - (BoolOpt) Sync virtual and real mouse cursors in Windows VMs + * - ``use_virtio_for_bridges`` = ``True`` + - (BoolOpt) Use virtio for bridge interfaces with KVM/QEMU + * - ``virt_type`` = ``kvm`` + - (StrOpt) Libvirt domain type + * - ``volume_clear`` = ``zero`` + - (StrOpt) Method used to wipe old volumes. + * - ``volume_clear_size`` = ``0`` + - (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + * - ``wait_soft_reboot_seconds`` = ``120`` + - (IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. diff --git a/doc/config-ref-rst/source/tables/nova-livemigration.rst b/doc/config-ref-rst/source/tables/nova-livemigration.rst new file mode 100644 index 0000000000..f9d5067473 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-livemigration.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of live migration configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``live_migration_retry_count`` = ``30`` + - (IntOpt) Number of 1 second retries needed in live_migration + * - ``max_concurrent_live_migrations`` = ``1`` + - (IntOpt) Maximum number of live migrations to run concurrently. This limit is enforced to avoid outbound live migrations overwhelming the host/network and causing failures. It is not recommended that you change this unless you are very sure that doing so is safe and stable in your environment. + * - **[libvirt]** + - + * - ``live_migration_bandwidth`` = ``0`` + - (IntOpt) Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details + * - ``live_migration_completion_timeout`` = ``800`` + - (IntOpt) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay * downtime steps. Set to 0 to disable timeouts. + * - ``live_migration_downtime`` = ``500`` + - (IntOpt) Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. Use a large value if guest liveness is unimportant. + * - ``live_migration_downtime_delay`` = ``75`` + - (IntOpt) Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device + * - ``live_migration_downtime_steps`` = ``10`` + - (IntOpt) Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps + * - ``live_migration_flag`` = ``VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED`` + - (StrOpt) Migration flags to be set for live migration + * - ``live_migration_progress_timeout`` = ``150`` + - (IntOpt) Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. + * - ``live_migration_uri`` = ``qemu+tcp://%s/system`` + - (StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname) diff --git a/doc/config-ref-rst/source/tables/nova-logging.rst b/doc/config-ref-rst/source/tables/nova-logging.rst new file mode 100644 index 0000000000..51be390135 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-logging.rst @@ -0,0 +1,64 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``fatal_exception_format_errors`` = ``False`` + - (BoolOpt) Make exception message format errors fatal + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/nova-metadata.rst b/doc/config-ref-rst/source/tables/nova-metadata.rst new file mode 100644 index 0000000000..b30349d68a --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-metadata.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of metadata configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``metadata_cache_expiration`` = ``15`` + - (IntOpt) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect. + * - ``metadata_host`` = ``$my_ip`` + - (StrOpt) The IP address for the metadata API server + * - ``metadata_listen`` = ``0.0.0.0`` + - (StrOpt) The IP address on which the metadata API will listen. + * - ``metadata_listen_port`` = ``8775`` + - (IntOpt) The port on which the metadata API will listen. + * - ``metadata_manager`` = ``nova.api.manager.MetadataManager`` + - (StrOpt) OpenStack metadata service manager + * - ``metadata_port`` = ``8775`` + - (IntOpt) The port for the metadata API port + * - ``metadata_workers`` = ``None`` + - (IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. + * - ``vendordata_driver`` = ``nova.api.metadata.vendordata_json.JsonFileVendorData`` + - (StrOpt) Driver to use for vendor data + * - ``vendordata_jsonfile_path`` = ``None`` + - (StrOpt) File to load JSON formatted vendor data from diff --git a/doc/config-ref-rst/source/tables/nova-network.rst b/doc/config-ref-rst/source/tables/nova-network.rst new file mode 100644 index 0000000000..47735d16c3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-network.rst @@ -0,0 +1,146 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of network configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allow_same_net_traffic`` = ``True`` + - (BoolOpt) Whether to allow network traffic from same network + * - ``auto_assign_floating_ip`` = ``False`` + - (BoolOpt) Autoassigning floating IP to VM + * - ``cnt_vpn_clients`` = ``0`` + - (IntOpt) Number of addresses reserved for vpn clients + * - ``create_unique_mac_address_attempts`` = ``5`` + - (IntOpt) Number of attempts to create unique mac address + * - ``default_access_ip_network_name`` = ``None`` + - (StrOpt) Name of network to use to set access IPs for instances + * - ``default_floating_pool`` = ``nova`` + - (StrOpt) Default pool for floating IPs + * - ``defer_iptables_apply`` = ``False`` + - (BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase + * - ``dhcp_domain`` = ``novalocal`` + - (StrOpt) Domain to use for building the hostnames + * - ``dhcp_lease_time`` = ``86400`` + - (IntOpt) Lifetime of a DHCP lease in seconds + * - ``dhcpbridge`` = ``$bindir/nova-dhcpbridge`` + - (StrOpt) Location of nova-dhcpbridge + * - ``dhcpbridge_flagfile`` = ``['/etc/nova/nova-dhcpbridge.conf']`` + - (MultiStrOpt) Location of flagfiles for dhcpbridge + * - ``dns_server`` = ``[]`` + - (MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. + * - ``dns_update_periodic_interval`` = ``-1`` + - (IntOpt) Number of seconds to wait between runs of updates to DNS entries. + * - ``dnsmasq_config_file`` = ```` + - (StrOpt) Override the default dnsmasq settings with this file + * - ``ebtables_exec_attempts`` = ``3`` + - (IntOpt) Number of times to retry ebtables commands on failure. + * - ``ebtables_retry_interval`` = ``1.0`` + - (FloatOpt) Number of seconds to wait between ebtables retries. + * - ``firewall_driver`` = ``None`` + - (StrOpt) Firewall driver (defaults to hypervisor specific iptables driver) + * - ``fixed_ip_disassociate_timeout`` = ``600`` + - (IntOpt) Seconds after which a deallocated IP is disassociated + * - ``flat_injected`` = ``False`` + - (BoolOpt) Whether to attempt to inject network setup into guest + * - ``flat_interface`` = ``None`` + - (StrOpt) FlatDhcp will bridge into this interface if set + * - ``flat_network_bridge`` = ``None`` + - (StrOpt) Bridge for simple network instances + * - ``flat_network_dns`` = ``8.8.4.4`` + - (StrOpt) DNS server for simple network + * - ``floating_ip_dns_manager`` = ``nova.network.noop_dns_driver.NoopDNSDriver`` + - (StrOpt) Full class name for the DNS Manager for floating IPs + * - ``force_dhcp_release`` = ``True`` + - (BoolOpt) If True, send a dhcp release on instance termination + * - ``force_snat_range`` = ``[]`` + - (MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times. + * - ``forward_bridge_interface`` = ``['all']`` + - (MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times. + * - ``gateway`` = ``None`` + - (StrOpt) Default IPv4 gateway + * - ``injected_network_template`` = ``$pybasedir/nova/virt/interfaces.template`` + - (StrOpt) Template file for injected network + * - ``instance_dns_domain`` = ```` + - (StrOpt) Full class name for the DNS Zone for instance IPs + * - ``instance_dns_manager`` = ``nova.network.noop_dns_driver.NoopDNSDriver`` + - (StrOpt) Full class name for the DNS Manager for instance IPs + * - ``iptables_bottom_regex`` = ```` + - (StrOpt) Regular expression to match the iptables rule that should always be on the bottom. + * - ``iptables_drop_action`` = ``DROP`` + - (StrOpt) The table that iptables to jump to when a packet is to be dropped. + * - ``iptables_top_regex`` = ```` + - (StrOpt) Regular expression to match the iptables rule that should always be on the top. + * - ``l3_lib`` = ``nova.network.l3.LinuxNetL3`` + - (StrOpt) Indicates underlying L3 management library + * - ``linuxnet_interface_driver`` = ``nova.network.linux_net.LinuxBridgeInterfaceDriver`` + - (StrOpt) Driver used to create ethernet devices. + * - ``linuxnet_ovs_integration_bridge`` = ``br-int`` + - (StrOpt) Name of Open vSwitch bridge used with linuxnet + * - ``multi_host`` = ``False`` + - (BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host. + * - ``network_allocate_retries`` = ``0`` + - (IntOpt) Number of times to retry network allocation on failures + * - ``network_api_class`` = ``nova.network.api.API`` + - (StrOpt) The full class name of the network API class to use + * - ``network_device_mtu`` = ``None`` + - (IntOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. MTU setting for network interface. + * - ``network_driver`` = ``nova.network.linux_net`` + - (StrOpt) Driver to use for network creation + * - ``network_manager`` = ``nova.network.manager.VlanManager`` + - (StrOpt) Full class name for the Manager for network + * - ``network_size`` = ``256`` + - (IntOpt) Number of addresses in each private subnet + * - ``network_topic`` = ``network`` + - (StrOpt) The topic network nodes listen on + * - ``networks_path`` = ``$state_path/networks`` + - (StrOpt) Location to keep network config files + * - ``num_networks`` = ``1`` + - (IntOpt) Number of networks to support + * - ``ovs_vsctl_timeout`` = ``120`` + - (IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever. + * - ``public_interface`` = ``eth0`` + - (StrOpt) Interface for public IP addresses + * - ``routing_source_ip`` = ``$my_ip`` + - (StrOpt) Public IP of network host + * - ``security_group_api`` = ``nova`` + - (StrOpt) The full class name of the security API class + * - ``send_arp_for_ha`` = ``False`` + - (BoolOpt) Send gratuitous ARPs for HA setup + * - ``send_arp_for_ha_count`` = ``3`` + - (IntOpt) Send this many gratuitous ARPs for HA setup + * - ``share_dhcp_address`` = ``False`` + - (BoolOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host. + * - ``teardown_unused_network_gateway`` = ``False`` + - (BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks + * - ``update_dns_entries`` = ``False`` + - (BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode + * - ``use_network_dns_servers`` = ``False`` + - (BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. + * - ``use_neutron_default_nets`` = ``False`` + - (StrOpt) Control for checking for default networks + * - ``use_single_default_gateway`` = ``False`` + - (BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server + * - ``vlan_interface`` = ``None`` + - (StrOpt) VLANs will bridge into this interface if set + * - ``vlan_start`` = ``100`` + - (IntOpt) First VLAN for private networks + * - **[libvirt]** + - + * - ``remote_filesystem_transport`` = ``ssh`` + - (StrOpt) Use ssh or rsync transport for creating, copying, removing files on the remote host. + * - **[vmware]** + - + * - ``vlan_interface`` = ``vmnic0`` + - (StrOpt) Physical ethernet adapter name for vlan networking diff --git a/doc/config-ref-rst/source/tables/nova-neutron.rst b/doc/config-ref-rst/source/tables/nova-neutron.rst new file mode 100644 index 0000000000..e1b919f0d3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-neutron.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of neutron configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``neutron_default_tenant_id`` = ``default`` + - (StrOpt) Default tenant id when creating neutron networks + * - **[neutron]** + - + * - ``admin_auth_url`` = ``http://localhost:5000/v2.0`` + - (StrOpt) Authorization URL for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``admin_password`` = ``None`` + - (StrOpt) Password for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``admin_tenant_id`` = ``None`` + - (StrOpt) Tenant id for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``admin_tenant_name`` = ``None`` + - (StrOpt) Tenant name for connecting to neutron in admin context. This option will be ignored if neutron_admin_tenant_id is set. Note that with Keystone V3 tenant names are only unique within a domain. DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``admin_user_id`` = ``None`` + - (StrOpt) User id for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``admin_username`` = ``None`` + - (StrOpt) Username for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_strategy`` = ``keystone`` + - (StrOpt) Authorization strategy for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead. If an auth_plugin is specified strategy will be ignored. + * - ``cafile`` = ``None`` + - (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (StrOpt) PEM encoded client certificate cert file + * - ``extension_sync_interval`` = ``600`` + - (IntOpt) Number of seconds before querying neutron for extensions + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) PEM encoded client certificate key file + * - ``metadata_proxy_shared_secret`` = ```` + - (StrOpt) Shared secret to validate proxies Neutron metadata requests + * - ``ovs_bridge`` = ``br-int`` + - (StrOpt) Name of Integration Bridge used by Open vSwitch + * - ``region_name`` = ``None`` + - (StrOpt) Region name for connecting to neutron in admin context + * - ``service_metadata_proxy`` = ``False`` + - (BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids. + * - ``timeout`` = ``None`` + - (IntOpt) Timeout value for http requests + * - ``url`` = ``http://127.0.0.1:9696`` + - (StrOpt) URL for connecting to neutron diff --git a/doc/config-ref-rst/source/tables/nova-pci.rst b/doc/config-ref-rst/source/tables/nova-pci.rst new file mode 100644 index 0000000000..d698c06fa3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-pci.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of PCI configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pci_alias`` = ``[]`` + - (MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued) + * - ``pci_passthrough_whitelist`` = ``[]`` + - (MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}] diff --git a/doc/config-ref-rst/source/tables/nova-periodic.rst b/doc/config-ref-rst/source/tables/nova-periodic.rst new file mode 100644 index 0000000000..8325f5f01c --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-periodic.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of periodic configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``periodic_enable`` = ``True`` + - (BoolOpt) Enable periodic tasks + * - ``periodic_fuzzy_delay`` = ``60`` + - (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) diff --git a/doc/config-ref-rst/source/tables/nova-policy.rst b/doc/config-ref-rst/source/tables/nova-policy.rst new file mode 100644 index 0000000000..774358314d --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-policy.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allow_instance_snapshots`` = ``True`` + - (BoolOpt) Permit instance snapshot operations. + * - ``allow_resize_to_same_host`` = ``False`` + - (BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments. + * - ``max_age`` = ``0`` + - (IntOpt) Number of seconds between subsequent usage refreshes. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation + * - ``max_local_block_devices`` = ``3`` + - (IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. A negative number means unlimited. Setting max_local_block_devices to 0 means that any request that attempts to create a local disk will fail. This option is meant to limit the number of local discs (so root local disc that is the result of --image being used, and any other ephemeral and swap disks). 0 does not mean that images will be automatically converted to volumes and boot instances from volumes - it just means that all requests that attempt to create a local disk will fail. + * - ``osapi_compute_unique_server_name_scope`` = ```` + - (StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global". + * - ``osapi_max_limit`` = ``1000`` + - (IntOpt) The maximum number of items returned in a single response from a collection resource + * - ``password_length`` = ``12`` + - (IntOpt) Length of generated instance admin passwords + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. + * - ``reservation_expire`` = ``86400`` + - (IntOpt) Number of seconds until a reservation expires + * - ``resize_fs_using_block_device`` = ``False`` + - (BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). + * - ``until_refresh`` = ``0`` + - (IntOpt) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. diff --git a/doc/config-ref-rst/source/tables/nova-qpid.rst b/doc/config-ref-rst/source/tables/nova-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/nova-quobyte.rst b/doc/config-ref-rst/source/tables/nova-quobyte.rst new file mode 100644 index 0000000000..6c885fe7bc --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-quobyte.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Quobyte USP volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[libvirt]** + - + * - ``quobyte_client_cfg`` = ``None`` + - (StrOpt) Path to a Quobyte Client configuration file. + * - ``quobyte_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Directory where the Quobyte volume is mounted on the compute node diff --git a/doc/config-ref-rst/source/tables/nova-quota.rst b/doc/config-ref-rst/source/tables/nova-quota.rst new file mode 100644 index 0000000000..6f89c85f0c --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-quota.rst @@ -0,0 +1,58 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of quota configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``bandwidth_poll_interval`` = ``600`` + - (IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will run at the default rate. + * - ``enable_network_quota`` = ``False`` + - (BoolOpt) Enables or disables quota checking for tenant networks + * - ``quota_cores`` = ``20`` + - (IntOpt) Number of instance cores allowed per project + * - ``quota_driver`` = ``nova.quota.DbQuotaDriver`` + - (StrOpt) Default driver to use for quota checks + * - ``quota_fixed_ips`` = ``-1`` + - (IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) + * - ``quota_floating_ips`` = ``10`` + - (IntOpt) Number of floating IPs allowed per project + * - ``quota_injected_file_content_bytes`` = ``10240`` + - (IntOpt) Number of bytes allowed per injected file + * - ``quota_injected_file_path_length`` = ``255`` + - (IntOpt) Length of injected file path + * - ``quota_injected_files`` = ``5`` + - (IntOpt) Number of injected files allowed + * - ``quota_instances`` = ``10`` + - (IntOpt) Number of instances allowed per project + * - ``quota_key_pairs`` = ``100`` + - (IntOpt) Number of key pairs per user + * - ``quota_metadata_items`` = ``128`` + - (IntOpt) Number of metadata items allowed per instance + * - ``quota_networks`` = ``3`` + - (IntOpt) Number of private networks allowed per project + * - ``quota_ram`` = ``51200`` + - (IntOpt) Megabytes of instance RAM allowed per project + * - ``quota_security_group_rules`` = ``20`` + - (IntOpt) Number of security rules per security group + * - ``quota_security_groups`` = ``10`` + - (IntOpt) Number of security groups per project + * - ``quota_server_group_members`` = ``10`` + - (IntOpt) Number of servers per server group + * - ``quota_server_groups`` = ``10`` + - (IntOpt) Number of server groups per project + * - **[cells]** + - + * - ``bandwidth_update_interval`` = ``600`` + - (IntOpt) Seconds between bandwidth updates for cells. diff --git a/doc/config-ref-rst/source/tables/nova-rabbitmq.rst b/doc/config-ref-rst/source/tables/nova-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/nova-rdp.rst b/doc/config-ref-rst/source/tables/nova-rdp.rst new file mode 100644 index 0000000000..e40e5db6dd --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-rdp.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RDP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[rdp]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) Enable RDP related features + * - ``html5_proxy_base_url`` = ``http://127.0.0.1:6083/`` + - (StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/" diff --git a/doc/config-ref-rst/source/tables/nova-redis.rst b/doc/config-ref-rst/source/tables/nova-redis.rst new file mode 100644 index 0000000000..75a290f1d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-redis.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/nova-rpc.rst b/doc/config-ref-rst/source/tables/nova-rpc.rst new file mode 100644 index 0000000000..7a738c5fd3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-rpc.rst @@ -0,0 +1,76 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[cells]** + - + * - ``rpc_driver_queue_base`` = ``cells.intercell`` + - (StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication + * - **[upgrade_levels]** + - + * - ``baseapi`` = ``None`` + - (StrOpt) Set a version cap for messages sent to the base api in any service diff --git a/doc/config-ref-rst/source/tables/nova-s3.rst b/doc/config-ref-rst/source/tables/nova-s3.rst new file mode 100644 index 0000000000..854561b652 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-s3.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of S3 configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``buckets_path`` = ``$state_path/buckets`` + - (StrOpt) Path to S3 buckets + * - ``image_decryption_dir`` = ``/tmp`` + - (StrOpt) Parent directory for tempdir used for image decryption + * - ``s3_access_key`` = ``notchecked`` + - (StrOpt) Access key to use for S3 server for images + * - ``s3_affix_tenant`` = ``False`` + - (BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 + * - ``s3_host`` = ``$my_ip`` + - (StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api + * - ``s3_listen`` = ``0.0.0.0`` + - (StrOpt) IP address for S3 API to listen + * - ``s3_listen_port`` = ``3333`` + - (IntOpt) Port for S3 API to listen + * - ``s3_port`` = ``3333`` + - (IntOpt) Port used when accessing the S3 api + * - ``s3_secret_key`` = ``notchecked`` + - (StrOpt) Secret key to use for S3 server for images + * - ``s3_use_ssl`` = ``False`` + - (BoolOpt) Whether to use SSL when talking to S3 diff --git a/doc/config-ref-rst/source/tables/nova-scheduler.rst b/doc/config-ref-rst/source/tables/nova-scheduler.rst new file mode 100644 index 0000000000..a73bad8b0d --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-scheduler.rst @@ -0,0 +1,98 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of scheduler configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``aggregate_image_properties_isolation_namespace`` = ``None`` + - (StrOpt) Force the filter to consider only keys matching the given namespace. + * - ``aggregate_image_properties_isolation_separator`` = ``.`` + - (StrOpt) The separator used between the namespace and keys + * - ``baremetal_scheduler_default_filters`` = ``RetryFilter, AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ExactRamFilter, ExactDiskFilter, ExactCoreFilter`` + - (ListOpt) Which filter class names to use for filtering baremetal hosts when not specified in the request. + * - ``cpu_allocation_ratio`` = ``0.0`` + - (FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 16.0 + * - ``disk_allocation_ratio`` = ``1.0`` + - (FloatOpt) Virtual disk to physical disk allocation ratio + * - ``io_ops_weight_multiplier`` = ``-1.0`` + - (FloatOpt) Multiplier used for weighing host io ops. Negative numbers mean a preference to choose light workload compute hosts. + * - ``isolated_hosts`` = ```` + - (ListOpt) Host reserved for specific images + * - ``isolated_images`` = ```` + - (ListOpt) Images to run on isolated host + * - ``max_instances_per_host`` = ``50`` + - (IntOpt) Ignore hosts that have too many instances + * - ``max_io_ops_per_host`` = ``8`` + - (IntOpt) Tells filters to ignore hosts that have this many or more instances currently in build, resize, snapshot, migrate, rescue or unshelve task states + * - ``ram_allocation_ratio`` = ``0.0`` + - (FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) will be used and defaulted to 1.5 + * - ``ram_weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. + * - ``reserved_host_disk_mb`` = ``0`` + - (IntOpt) Amount of disk in MB to reserve for the host + * - ``reserved_host_memory_mb`` = ``512`` + - (IntOpt) Amount of memory in MB to reserve for the host + * - ``restrict_isolated_hosts_to_isolated_images`` = ``True`` + - (BoolOpt) Whether to force isolated hosts to run only isolated images + * - ``scheduler_available_filters`` = ``['nova.scheduler.filters.all_filters']`` + - (MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova. + * - ``scheduler_default_filters`` = ``RetryFilter, AvailabilityZoneFilter, RamFilter, DiskFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter`` + - (ListOpt) Which filter class names to use for filtering hosts when not specified in the request. + * - ``scheduler_driver`` = ``nova.scheduler.filter_scheduler.FilterScheduler`` + - (StrOpt) Default driver to use for the scheduler + * - ``scheduler_driver_task_period`` = ``60`` + - (IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver. + * - ``scheduler_host_manager`` = ``nova.scheduler.host_manager.HostManager`` + - (StrOpt) The scheduler host manager class to use + * - ``scheduler_host_subset_size`` = ``1`` + - (IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead + * - ``scheduler_instance_sync_interval`` = ``120`` + - (IntOpt) Waiting time interval (seconds) between sending the scheduler a list of current instance UUIDs to verify that its view of instances is in sync with nova. If the CONF option `scheduler_tracks_instance_changes` is False, changing this option will have no effect. + * - ``scheduler_json_config_location`` = ```` + - (StrOpt) Absolute path to scheduler configuration JSON file. + * - ``scheduler_manager`` = ``nova.scheduler.manager.SchedulerManager`` + - (StrOpt) Full class name for the Manager for scheduler + * - ``scheduler_max_attempts`` = ``3`` + - (IntOpt) Maximum number of attempts to schedule an instance + * - ``scheduler_topic`` = ``scheduler`` + - (StrOpt) The topic scheduler nodes listen on + * - ``scheduler_tracks_instance_changes`` = ``True`` + - (BoolOpt) Determines if the Scheduler tracks changes to instances to help with its filtering decisions. + * - ``scheduler_use_baremetal_filters`` = ``False`` + - (BoolOpt) Flag to decide whether to use baremetal_scheduler_default_filters or not. + * - ``scheduler_weight_classes`` = ``nova.scheduler.weights.all_weighers`` + - (ListOpt) Which weight class names to use for weighing hosts + * - **[cells]** + - + * - ``ram_weight_multiplier`` = ``10.0`` + - (FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread. + * - ``scheduler_filter_classes`` = ``nova.cells.filters.all_filters`` + - (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. + * - ``scheduler_retries`` = ``10`` + - (IntOpt) How many retries when no cells are available. + * - ``scheduler_retry_delay`` = ``2`` + - (IntOpt) How often to retry in seconds when no cells are available. + * - ``scheduler_weight_classes`` = ``nova.cells.weights.all_weighers`` + - (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. + * - **[metrics]** + - + * - ``required`` = ``True`` + - (BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable. + * - ``weight_multiplier`` = ``1.0`` + - (FloatOpt) Multiplier used for weighing metrics. + * - ``weight_of_unavailable`` = ``-10000.0`` + - (FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable. + * - ``weight_setting`` = ```` + - (ListOpt) How the metrics are going to be weighed. This should be in the form of "=, =, ...", where is one of the metrics to be weighed, and is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. diff --git a/doc/config-ref-rst/source/tables/nova-serial_console.rst b/doc/config-ref-rst/source/tables/nova-serial_console.rst new file mode 100644 index 0000000000..31dc95ba86 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-serial_console.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of serial console configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[serial_console]** + - + * - ``base_url`` = ``ws://127.0.0.1:6083/`` + - (StrOpt) Location of serial console proxy. + * - ``enabled`` = ``False`` + - (BoolOpt) Enable serial console related features + * - ``listen`` = ``127.0.0.1`` + - (StrOpt) IP address on which instance serial console should listen + * - ``port_range`` = ``10000:20000`` + - (StrOpt) Range of TCP ports to use for serial ports on compute hosts + * - ``proxyclient_address`` = ``127.0.0.1`` + - (StrOpt) The address to which proxy clients (like nova-serialproxy) should connect + * - ``serialproxy_host`` = ``0.0.0.0`` + - (StrOpt) Host on which to listen for incoming requests + * - ``serialproxy_port`` = ``6083`` + - (IntOpt) Port on which to listen for incoming requests diff --git a/doc/config-ref-rst/source/tables/nova-spice.rst b/doc/config-ref-rst/source/tables/nova-spice.rst new file mode 100644 index 0000000000..1c122fc801 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-spice.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SPICE configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[spice]** + - + * - ``agent_enabled`` = ``True`` + - (BoolOpt) Enable spice guest agent support + * - ``enabled`` = ``False`` + - (BoolOpt) Enable spice related features + * - ``html5proxy_base_url`` = ``http://127.0.0.1:6082/spice_auto.html`` + - (StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" + * - ``html5proxy_host`` = ``0.0.0.0`` + - (StrOpt) Host on which to listen for incoming requests + * - ``html5proxy_port`` = ``6082`` + - (IntOpt) Port on which to listen for incoming requests + * - ``keymap`` = ``en-us`` + - (StrOpt) Keymap for spice + * - ``server_listen`` = ``127.0.0.1`` + - (StrOpt) IP address on which instance spice server should listen + * - ``server_proxyclient_address`` = ``127.0.0.1`` + - (StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect diff --git a/doc/config-ref-rst/source/tables/nova-testing.rst b/doc/config-ref-rst/source/tables/nova-testing.rst new file mode 100644 index 0000000000..cb496d91e8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-testing.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of testing configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``fake_call`` = ``False`` + - (BoolOpt) If True, skip using the queue and make local calls + * - ``fake_network`` = ``False`` + - (BoolOpt) If passed, use fake network devices and addresses + * - ``monkey_patch`` = ``False`` + - (BoolOpt) Whether to apply monkey patching + * - ``monkey_patch_modules`` = ``nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator`` + - (ListOpt) List of modules/decorators to monkey patch diff --git a/doc/config-ref-rst/source/tables/nova-trustedcomputing.rst b/doc/config-ref-rst/source/tables/nova-trustedcomputing.rst new file mode 100644 index 0000000000..2d8aa8a768 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-trustedcomputing.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of trusted computing configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[trusted_computing]** + - + * - ``attestation_api_url`` = ``/OpenAttestationWebServices/V1.0`` + - (StrOpt) Attestation web API URL + * - ``attestation_auth_blob`` = ``None`` + - (StrOpt) Attestation authorization blob - must change + * - ``attestation_auth_timeout`` = ``60`` + - (IntOpt) Attestation status cache valid period length + * - ``attestation_insecure_ssl`` = ``False`` + - (BoolOpt) Disable SSL cert verification for Attestation service + * - ``attestation_port`` = ``8443`` + - (StrOpt) Attestation server port + * - ``attestation_server`` = ``None`` + - (StrOpt) Attestation server HTTP + * - ``attestation_server_ca_file`` = ``None`` + - (StrOpt) Attestation server Cert file for Identity verification diff --git a/doc/config-ref-rst/source/tables/nova-upgrade_levels.rst b/doc/config-ref-rst/source/tables/nova-upgrade_levels.rst new file mode 100644 index 0000000000..3c9b4adeac --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-upgrade_levels.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of upgrade levels configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cells]** + - + * - ``scheduler`` = ``nova.cells.scheduler.CellsScheduler`` + - (StrOpt) Cells scheduler to use + * - **[upgrade_levels]** + - + * - ``cells`` = ``None`` + - (StrOpt) Set a version cap for messages sent to local cells services + * - ``cert`` = ``None`` + - (StrOpt) Set a version cap for messages sent to cert services + * - ``compute`` = ``None`` + - (StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from an old version to a newer version, you should set this option to the old version before beginning the live upgrade procedure. Only upgrading to the next version is supported, so you cannot skip a release for the live upgrade procedure. + * - ``conductor`` = ``None`` + - (StrOpt) Set a version cap for messages sent to conductor services + * - ``console`` = ``None`` + - (StrOpt) Set a version cap for messages sent to console services + * - ``consoleauth`` = ``None`` + - (StrOpt) Set a version cap for messages sent to consoleauth services + * - ``intercell`` = ``None`` + - (StrOpt) Set a version cap for messages sent between cells services + * - ``network`` = ``None`` + - (StrOpt) Set a version cap for messages sent to network services + * - ``scheduler`` = ``None`` + - (StrOpt) Set a version cap for messages sent to scheduler services diff --git a/doc/config-ref-rst/source/tables/nova-vmware.rst b/doc/config-ref-rst/source/tables/nova-vmware.rst new file mode 100644 index 0000000000..60f6e9f560 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-vmware.rst @@ -0,0 +1,60 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VMware configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vmware]** + - + * - ``api_retry_count`` = ``10`` + - (IntOpt) The number of times we retry on failures, e.g., socket error, etc. + * - ``ca_file`` = ``None`` + - (StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate. + * - ``cache_prefix`` = ``None`` + - (StrOpt) The prefix for where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system. + * - ``cluster_name`` = ``None`` + - (StrOpt) Name of a VMware Cluster ComputeResource. + * - ``console_delay_seconds`` = ``None`` + - (IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. + * - ``datastore_regex`` = ``None`` + - (StrOpt) Regex to match the name of a datastore. + * - ``host_ip`` = ``None`` + - (StrOpt) Hostname or IP address for connection to VMware vCenter host. + * - ``host_password`` = ``None`` + - (StrOpt) Password for connection to VMware vCenter host. + * - ``host_port`` = ``443`` + - (PortOpt) Port for connection to VMware vCenter host. + * - ``host_username`` = ``None`` + - (StrOpt) Username for connection to VMware vCenter host. + * - ``insecure`` = ``False`` + - (BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set. + * - ``integration_bridge`` = ``None`` + - (StrOpt) This option should be configured only when using the NSX-MH Neutron plugin. This is the name of the integration bridge on the ESXi. This should not be set for any other Neutron plugin. Hence the default value is not set. + * - ``maximum_objects`` = ``100`` + - (IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. + * - ``pbm_default_policy`` = ``None`` + - (StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used. + * - ``pbm_enabled`` = ``False`` + - (BoolOpt) The PBM status. + * - ``pbm_wsdl_location`` = ``None`` + - (StrOpt) PBM service WSDL file location URL. e.g. file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances. + * - ``serial_port_proxy_uri`` = ``None`` + - (StrOpt) Identifies a proxy service that provides network access to the serial_port_service_uri. This option is ignored if serial_port_service_uri is not specified. + * - ``serial_port_service_uri`` = ``None`` + - (StrOpt) Identifies the remote system that serial port traffic will be sent to. If this is not set, no serial ports will be added to the created VMs. + * - ``task_poll_interval`` = ``0.5`` + - (FloatOpt) The interval used for polling of remote tasks. + * - ``use_linked_clone`` = ``True`` + - (BoolOpt) Whether to use linked clone + * - ``wsdl_location`` = ``None`` + - (StrOpt) Optional VIM Service WSDL Location e.g http:///vimService.wsdl. Optional over-ride to default location for bug work-arounds diff --git a/doc/config-ref-rst/source/tables/nova-vnc.rst b/doc/config-ref-rst/source/tables/nova-vnc.rst new file mode 100644 index 0000000000..aa36d3f181 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-vnc.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VNC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``daemon`` = ``False`` + - (BoolOpt) Become a daemon (background process) + * - ``key`` = ``None`` + - (StrOpt) SSL key file (if separate from cert) + * - ``novncproxy_host`` = ``0.0.0.0`` + - (StrOpt) Host on which to listen for incoming requests + * - ``novncproxy_port`` = ``6080`` + - (IntOpt) Port on which to listen for incoming requests + * - ``record`` = ``False`` + - (BoolOpt) Record sessions to FILE.[session_number] + * - ``source_is_ipv6`` = ``False`` + - (BoolOpt) Source is ipv6 + * - ``ssl_only`` = ``False`` + - (BoolOpt) Disallow non-encrypted connections + * - ``web`` = ``/usr/share/spice-html5`` + - (StrOpt) Run webserver on same port. Serve files from DIR. + * - **[vmware]** + - + * - ``vnc_port`` = ``5900`` + - (PortOpt) VNC starting port + * - ``vnc_port_total`` = ``10000`` + - (IntOpt) Total number of VNC ports + * - **[vnc]** + - + * - ``enabled`` = ``True`` + - (BoolOpt) Enable VNC related features + * - ``keymap`` = ``en-us`` + - (StrOpt) Keymap for VNC + * - ``novncproxy_base_url`` = ``http://127.0.0.1:6080/vnc_auto.html`` + - (StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" + * - ``vncserver_listen`` = ``127.0.0.1`` + - (StrOpt) IP address on which instance vncservers should listen + * - ``vncserver_proxyclient_address`` = ``127.0.0.1`` + - (StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect + * - ``xvpvncproxy_base_url`` = ``http://127.0.0.1:6081/console`` + - (StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" diff --git a/doc/config-ref-rst/source/tables/nova-volumes.rst b/doc/config-ref-rst/source/tables/nova-volumes.rst new file mode 100644 index 0000000000..c6dfe50591 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-volumes.rst @@ -0,0 +1,90 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of volumes configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``block_device_allocate_retries`` = ``60`` + - (IntOpt) Number of times to retry block device allocation on failures + * - ``block_device_allocate_retries_interval`` = ``3`` + - (IntOpt) Waiting time interval (seconds) between block device allocation retries on failures + * - ``my_block_storage_ip`` = ``$my_ip`` + - (StrOpt) Block storage IP address of this host + * - ``volume_api_class`` = ``nova.volume.cinder.API`` + - (StrOpt) The full class name of the volume API class to use + * - ``volume_usage_poll_interval`` = ``0`` + - (IntOpt) Interval in seconds for gathering volume usages + * - **[cinder]** + - + * - ``cafile`` = ``None`` + - (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``catalog_info`` = ``volumev2:cinderv2:publicURL`` + - (StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: :: + * - ``certfile`` = ``None`` + - (StrOpt) PEM encoded client certificate cert file + * - ``cross_az_attach`` = ``True`` + - (BoolOpt) Allow attach between instance and volume in different availability zones. If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. + * - ``endpoint_template`` = ``None`` + - (StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s + * - ``http_retries`` = ``3`` + - (IntOpt) Number of cinderclient retries on failed http calls + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) PEM encoded client certificate key file + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name of this node + * - ``timeout`` = ``None`` + - (IntOpt) Timeout value for http requests + * - **[hyperv]** + - + * - ``force_volumeutils_v1`` = ``False`` + - (BoolOpt) Force V1 volume utility class + * - ``volume_attach_retry_count`` = ``10`` + - (IntOpt) The number of times to retry to attach a volume + * - ``volume_attach_retry_interval`` = ``5`` + - (IntOpt) Interval between volume attachment attempts, in seconds + * - **[libvirt]** + - + * - ``glusterfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Directory where the glusterfs volume is mounted on the compute node + * - ``nfs_mount_options`` = ``None`` + - (StrOpt) Mount options passed to the NFS client. See section of the nfs man page for details + * - ``nfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Directory where the NFS volume is mounted on the compute node + * - ``num_aoe_discover_tries`` = ``3`` + - (IntOpt) Number of times to rediscover AoE target to find volume + * - ``num_iscsi_scan_tries`` = ``5`` + - (IntOpt) Number of times to rescan iSCSI target to find volume + * - ``num_iser_scan_tries`` = ``5`` + - (IntOpt) Number of times to rescan iSER target to find volume + * - ``qemu_allowed_storage_drivers`` = ```` + - (ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster] + * - ``rbd_secret_uuid`` = ``None`` + - (StrOpt) The libvirt UUID of the secret for the rbd_uservolumes + * - ``rbd_user`` = ``None`` + - (StrOpt) The RADOS client name for accessing rbd volumes + * - ``scality_sofs_config`` = ``None`` + - (StrOpt) Path or URL to Scality SOFS configuration file + * - ``scality_sofs_mount_point`` = ``$state_path/scality`` + - (StrOpt) Base dir where Scality SOFS shall be mounted + * - ``smbfs_mount_options`` = ```` + - (StrOpt) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified. + * - ``smbfs_mount_point_base`` = ``$state_path/mnt`` + - (StrOpt) Directory where the SMBFS shares are mounted on the compute node + * - **[xenserver]** + - + * - ``block_device_creation_timeout`` = ``10`` + - (IntOpt) Time to wait for a block device to be created diff --git a/doc/config-ref-rst/source/tables/nova-vpn.rst b/doc/config-ref-rst/source/tables/nova-vpn.rst new file mode 100644 index 0000000000..a3192be6d7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-vpn.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of VPN configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``boot_script_template`` = ``$pybasedir/nova/cloudpipe/bootscript.template`` + - (StrOpt) Template for cloudpipe instance boot script + * - ``dmz_cidr`` = ```` + - (ListOpt) A list of dmz ranges that should be accepted + * - ``dmz_mask`` = ``255.255.255.0`` + - (StrOpt) Netmask to push into openvpn config + * - ``dmz_net`` = ``10.0.0.0`` + - (StrOpt) Network to push into openvpn config + * - ``vpn_flavor`` = ``m1.tiny`` + - (StrOpt) Flavor for vpn instances + * - ``vpn_image_id`` = ``0`` + - (StrOpt) Image ID used when starting up a cloudpipe vpn server + * - ``vpn_ip`` = ``$my_ip`` + - (StrOpt) Public IP for the cloudpipe VPN servers + * - ``vpn_key_suffix`` = ``-vpn`` + - (StrOpt) Suffix to add to project name for vpn key and secgroups + * - ``vpn_start`` = ``1000`` + - (IntOpt) First Vpn port for private networks diff --git a/doc/config-ref-rst/source/tables/nova-xen.rst b/doc/config-ref-rst/source/tables/nova-xen.rst new file mode 100644 index 0000000000..dc9425ba1b --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-xen.rst @@ -0,0 +1,128 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Xen configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``console_driver`` = ``nova.console.xvp.XVPConsoleProxy`` + - (StrOpt) Driver to use for the console proxy + * - ``console_xvp_conf`` = ``/etc/xvp.conf`` + - (StrOpt) Generated XVP conf file + * - ``console_xvp_conf_template`` = ``$pybasedir/nova/console/xvp.conf.template`` + - (StrOpt) XVP conf template + * - ``console_xvp_log`` = ``/var/log/xvp.log`` + - (StrOpt) XVP log file + * - ``console_xvp_multiplex_port`` = ``5900`` + - (IntOpt) Port for XVP to multiplex VNC connections on + * - ``console_xvp_pid`` = ``/var/run/xvp.pid`` + - (StrOpt) XVP master process pid file + * - ``stub_compute`` = ``False`` + - (BoolOpt) Stub calls to compute worker for tests + * - **[libvirt]** + - + * - ``xen_hvmloader_path`` = ``/usr/lib/xen/boot/hvmloader`` + - (StrOpt) Location where the Xen hvmloader is kept + * - **[xenserver]** + - + * - ``agent_path`` = ``usr/sbin/xe-update-networking`` + - (StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True + * - ``agent_resetnetwork_timeout`` = ``60`` + - (IntOpt) Number of seconds to wait for agent reply to resetnetwork request + * - ``agent_timeout`` = ``30`` + - (IntOpt) Number of seconds to wait for agent reply + * - ``agent_version_timeout`` = ``300`` + - (IntOpt) Number of seconds to wait for agent to be fully operational + * - ``cache_images`` = ``all`` + - (StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely + * - ``check_host`` = ``True`` + - (BoolOpt) Ensure compute service is running on host XenAPI connects to. + * - ``connection_concurrent`` = ``5`` + - (IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver + * - ``connection_password`` = ``None`` + - (StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver + * - ``connection_url`` = ``None`` + - (StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver + * - ``connection_username`` = ``root`` + - (StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver + * - ``default_os_type`` = ``linux`` + - (StrOpt) Default OS type + * - ``disable_agent`` = ``False`` + - (BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. + * - ``image_compression_level`` = ``None`` + - (IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0. + * - ``image_upload_handler`` = ``nova.virt.xenapi.image.glance.GlanceStore`` + - (StrOpt) Dom0 plugin driver used to handle image uploads. + * - ``introduce_vdi_retry_wait`` = ``20`` + - (IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced + * - ``ipxe_boot_menu_url`` = ``None`` + - (StrOpt) URL to the iPXE boot menu + * - ``ipxe_mkisofs_cmd`` = ``mkisofs`` + - (StrOpt) Name and optionally path of the tool used for ISO image creation + * - ``ipxe_network_name`` = ``None`` + - (StrOpt) Name of network to use for booting iPXE ISOs + * - ``iqn_prefix`` = ``iqn.2010-10.org.openstack`` + - (StrOpt) IQN Prefix + * - ``login_timeout`` = ``10`` + - (IntOpt) Timeout in seconds for XenAPI login. + * - ``max_kernel_ramdisk_size`` = ``16777216`` + - (IntOpt) Maximum size in bytes of kernel or ramdisk images + * - ``num_vbd_unplug_retries`` = ``10`` + - (IntOpt) Maximum number of retries to unplug VBD. if <=0, should try once and no retry + * - ``ovs_integration_bridge`` = ``xapi1`` + - (StrOpt) Name of Integration Bridge used by Open vSwitch + * - ``remap_vbd_dev`` = ``False`` + - (BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick) + * - ``remap_vbd_dev_prefix`` = ``sd`` + - (StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb) + * - ``running_timeout`` = ``60`` + - (IntOpt) Number of seconds to wait for instance to go to running state + * - ``sparse_copy`` = ``True`` + - (BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced + * - ``sr_base_path`` = ``/var/run/sr-mount`` + - (StrOpt) Base path to the storage repository + * - ``sr_matching_filter`` = ``default-sr:true`` + - (StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true + * - ``target_host`` = ``None`` + - (StrOpt) The iSCSI Target Host + * - ``target_port`` = ``3260`` + - (StrOpt) The iSCSI Target Port, default is port 3260 + * - ``torrent_base_url`` = ``None`` + - (StrOpt) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6) + * - ``torrent_download_stall_cutoff`` = ``600`` + - (IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall + * - ``torrent_images`` = ``none`` + - (StrOpt) Whether or not to download images via Bit Torrent. + * - ``torrent_listen_port_end`` = ``6891`` + - (IntOpt) End of port range to listen on + * - ``torrent_listen_port_start`` = ``6881`` + - (IntOpt) Beginning of port range to listen on + * - ``torrent_max_last_accessed`` = ``86400`` + - (IntOpt) Cached torrent files not accessed within this number of seconds can be reaped + * - ``torrent_max_seeder_processes_per_host`` = ``1`` + - (IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit) + * - ``torrent_seed_chance`` = ``1.0`` + - (FloatOpt) Probability that peer will become a seeder. (1.0 = 100%) + * - ``torrent_seed_duration`` = ``3600`` + - (IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers. + * - ``use_agent_default`` = ``False`` + - (BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. + * - ``use_join_force`` = ``True`` + - (BoolOpt) To use for hosts with different CPUs + * - ``vhd_coalesce_max_attempts`` = ``20`` + - (IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver + * - ``vhd_coalesce_poll_interval`` = ``5.0`` + - (FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver + * - ``vif_driver`` = ``nova.virt.xenapi.vif.XenAPIBridgeDriver`` + - (StrOpt) The XenAPI VIF driver using XenServer Network APIs. diff --git a/doc/config-ref-rst/source/tables/nova-xvpvncproxy.rst b/doc/config-ref-rst/source/tables/nova-xvpvncproxy.rst new file mode 100644 index 0000000000..49b8096901 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-xvpvncproxy.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of XCP VNC proxy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``xvpvncproxy_host`` = ``0.0.0.0`` + - (StrOpt) Address that the XCP VNC proxy should bind to + * - ``xvpvncproxy_port`` = ``6081`` + - (IntOpt) Port that the XCP VNC proxy should bind to diff --git a/doc/config-ref-rst/source/tables/nova-zeromq.rst b/doc/config-ref-rst/source/tables/nova-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/nova-zookeeper.rst b/doc/config-ref-rst/source/tables/nova-zookeeper.rst new file mode 100644 index 0000000000..a4ab8fca3b --- /dev/null +++ b/doc/config-ref-rst/source/tables/nova-zookeeper.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Zookeeper configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[zookeeper]** + - + * - ``address`` = ``None`` + - (StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port + * - ``recv_timeout`` = ``4000`` + - (IntOpt) The recv_timeout parameter for the zk session + * - ``sg_prefix`` = ``/servicegroups`` + - (StrOpt) The prefix used in ZooKeeper to store ephemeral nodes + * - ``sg_retry_interval`` = ``5`` + - (IntOpt) Number of seconds to wait until retrying to join the session diff --git a/doc/config-ref-rst/source/tables/sahara-amqp.rst b/doc/config-ref-rst/source/tables/sahara-amqp.rst new file mode 100644 index 0000000000..0f5574fa83 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-amqp.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_level`` = ``INFO`` + - (StrOpt) Notification level for outgoing notifications + * - ``notification_publisher_id`` = ``None`` + - (StrOpt) Notification publisher_id for outgoing notifications + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/sahara-api.rst b/doc/config-ref-rst/source/tables/sahara-api.rst new file mode 100644 index 0000000000..69f4cbd725 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-api.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + * - **[retries]** + - + * - ``retries_number`` = ``5`` + - (IntOpt) Number of times to retry the request to client before failing + * - ``retry_after`` = ``10`` + - (IntOpt) Time between the retries to client (in seconds). diff --git a/doc/config-ref-rst/source/tables/sahara-auth_token.rst b/doc/config-ref-rst/source/tables/sahara-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/sahara-clients.rst b/doc/config-ref-rst/source/tables/sahara-clients.rst new file mode 100644 index 0000000000..32e6d76016 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-clients.rst @@ -0,0 +1,74 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cinder]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to cinder. + * - ``api_version`` = ``2`` + - (IntOpt) Version of the Cinder API to use. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for cinder client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for cinder client requests + * - **[heat]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to heat. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for heat client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for heat client requests + * - **[keystone]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to keystone. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for keystone client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for keystone client requests + * - **[manila]** + - + * - ``api_insecure`` = ``True`` + - (BoolOpt) Allow to perform insecure SSL requests to manila. + * - ``api_version`` = ``1`` + - (IntOpt) Version of the manila API to use. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for manila client requests. + * - **[neutron]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to neutron. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for neutron client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for neutron client requests + * - **[nova]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to nova. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for nova client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for nova client requests + * - **[swift]** + - + * - ``api_insecure`` = ``False`` + - (BoolOpt) Allow to perform insecure SSL requests to swift. + * - ``ca_file`` = ``None`` + - (StrOpt) Location of ca certificates file to use for swift client requests. + * - ``endpoint_type`` = ``internalURL`` + - (StrOpt) Endpoint type for swift client requests diff --git a/doc/config-ref-rst/source/tables/sahara-common.rst b/doc/config-ref-rst/source/tables/sahara-common.rst new file mode 100644 index 0000000000..b0681665e2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-common.rst @@ -0,0 +1,100 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``admin_project_domain_name`` = ``default`` + - (StrOpt) The name of the domain for the service project(ex. tenant). + * - ``admin_user_domain_name`` = ``default`` + - (StrOpt) The name of the domain to which the admin user belongs. + * - ``api_workers`` = ``1`` + - (IntOpt) Number of workers for Sahara API service (0 means all-in-one-thread configuration). + * - ``cleanup_time_for_incomplete_clusters`` = ``0`` + - (IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active", "Deleting" or "Error". If a cluster is not in "Active", "Deleting" or "Error" state and last update of it was longer than "cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled). + * - ``cluster_operation_trust_expiration_hours`` = ``24`` + - (IntOpt) Defines the period of time (in hours) after which trusts created to allow sahara to create or scale a cluster will expire. Note that this value should be significantly larger than the value of the cleanup_time_for_incomplete_clusters configuration key if use of the cluster cleanup feature is desired (the trust must last at least as long as a cluster could validly take to stall in its creation, plus the timeout value set in that key, plus one hour for the period of the cleanup job). + * - ``cluster_remote_threshold`` = ``70`` + - (IntOpt) The same as global_remote_threshold, but for a single cluster. + * - ``compute_topology_file`` = ``etc/sahara/compute.topology`` + - (StrOpt) File with nova compute topology. It should contain mapping between nova computes and racks. + * - ``default_ntp_server`` = ``pool.ntp.org`` + - (StrOpt) Default ntp server for time sync + * - ``disable_event_log`` = ``False`` + - (BoolOpt) Disables event log feature. + * - ``enable_data_locality`` = ``False`` + - (BoolOpt) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly. + * - ``enable_hypervisor_awareness`` = ``True`` + - (BoolOpt) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode. + * - ``enable_notifications`` = ``False`` + - (BoolOpt) Enables sending notifications to Ceilometer + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``global_remote_threshold`` = ``100`` + - (IntOpt) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run. + * - ``heat_stack_tags`` = ``data-processing-cluster`` + - (ListOpt) List of tags to be used during operating with stack. + * - ``infrastructure_engine`` = ``heat`` + - (StrOpt) An engine which will be used to provision infrastructure for Hadoop cluster. + * - ``job_binary_max_KB`` = ``5120`` + - (IntOpt) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation. + * - ``job_canceling_timeout`` = ``300`` + - (IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time. + * - ``job_workflow_postfix`` = ```` + - (StrOpt) Postfix for storing jobs in hdfs. Will be added to '/user//' path. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``min_transient_cluster_active_time`` = ``30`` + - (IntOpt) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period. + * - ``node_domain`` = ``novalocal`` + - (StrOpt) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter. + * - ``os_region_name`` = ``None`` + - (StrOpt) Region name used to get services endpoints. + * - ``periodic_enable`` = ``True`` + - (BoolOpt) Enable periodic tasks. + * - ``periodic_fuzzy_delay`` = ``60`` + - (IntOpt) Range in seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0). + * - ``periodic_interval_max`` = ``60`` + - (IntOpt) Max interval size between periodic tasks execution in seconds. + * - ``plugins`` = ``vanilla, hdp, spark, cdh`` + - (ListOpt) List of plugins to be loaded. Sahara preserves the order of the list when returning it. + * - ``proxy_command`` = ```` + - (StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}. + * - ``remote`` = ``ssh`` + - (StrOpt) A method for Sahara to execute commands on VMs. + * - ``rootwrap_command`` = ``sudo sahara-rootwrap /etc/sahara/rootwrap.conf`` + - (StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True + * - ``swift_topology_file`` = ``etc/sahara/swift.topology`` + - (StrOpt) File with Swift topology.It should contain mapping between Swift nodes and racks. + * - ``use_external_key_manager`` = ``False`` + - (BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service. + * - ``use_floating_ips`` = ``True`` + - (BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined. + * - ``use_identity_api_v3`` = ``True`` + - (BoolOpt) Enables Sahara to use Keystone API v3. If that flag is disabled, per-job clusters will not be terminated automatically. + * - ``use_namespaces`` = ``False`` + - (BoolOpt) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True). + * - ``use_neutron`` = ``False`` + - (BoolOpt) Use Neutron Networking (False indicates the use of Nova networking). + * - ``use_rootwrap`` = ``False`` + - (BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True) + * - **[conductor]** + - + * - ``use_local`` = ``True`` + - (BoolOpt) Perform sahara-conductor operations locally. + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. diff --git a/doc/config-ref-rst/source/tables/sahara-cors.rst b/doc/config-ref-rst/source/tables/sahara-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/sahara-database.rst b/doc/config-ref-rst/source/tables/sahara-database.rst new file mode 100644 index 0000000000..71a8154135 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-database.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``db_driver`` = ``sahara.db`` + - (StrOpt) Driver to use for database access. + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (StrOpt) The back end to use for the database. + * - ``connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (BoolOpt) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (IntOpt) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``None`` + - (IntOpt) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (IntOpt) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (IntOpt) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= + * - ``pool_timeout`` = ``None`` + - (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (IntOpt) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (StrOpt) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (BoolOpt) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (BoolOpt) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-ref-rst/source/tables/sahara-domain.rst b/doc/config-ref-rst/source/tables/sahara-domain.rst new file mode 100644 index 0000000000..8de810a216 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-domain.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of domain configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``proxy_user_domain_name`` = ``None`` + - (StrOpt) The domain Sahara will use to create new proxy users for Swift object access. + * - ``proxy_user_role_names`` = ``Member`` + - (ListOpt) A list of the role names that the proxy user should assume through trust for Swift object access. + * - ``use_domain_for_proxy_users`` = ``False`` + - (BoolOpt) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for Sahara to use. diff --git a/doc/config-ref-rst/source/tables/sahara-logging.rst b/doc/config-ref-rst/source/tables/sahara-logging.rst new file mode 100644 index 0000000000..025a24ebde --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO, neutronclient=INFO`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/sahara-object_store_access.rst b/doc/config-ref-rst/source/tables/sahara-object_store_access.rst new file mode 100644 index 0000000000..7072f27eb4 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-object_store_access.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Auth options for Swift access for VM configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[object_store_access]** + - + * - ``public_identity_ca_file`` = ``None`` + - (StrOpt) Location of ca certificate file to use for identity client requests via public endpoint + * - ``public_object_store_ca_file`` = ``None`` + - (StrOpt) Location of ca certificate file to use for object-store client requests via public endpoint diff --git a/doc/config-ref-rst/source/tables/sahara-policy.rst b/doc/config-ref-rst/source/tables/sahara-policy.rst new file mode 100644 index 0000000000..3839d589e6 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-policy.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of policy configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_policy]** + - + * - ``policy_default_rule`` = ``default`` + - (StrOpt) Default rule. Enforced when a requested rule is not found. + * - ``policy_dirs`` = ``['policy.d']`` + - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. + * - ``policy_file`` = ``policy.json`` + - (StrOpt) The JSON file that defines policies. diff --git a/doc/config-ref-rst/source/tables/sahara-qpid.rst b/doc/config-ref-rst/source/tables/sahara-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/sahara-rabbitmq.rst b/doc/config-ref-rst/source/tables/sahara-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/sahara-redis.rst b/doc/config-ref-rst/source/tables/sahara-redis.rst new file mode 100644 index 0000000000..ac62f687cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-redis.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/sahara-rpc.rst b/doc/config-ref-rst/source/tables/sahara-rpc.rst new file mode 100644 index 0000000000..cbdd71c8fc --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-rpc.rst @@ -0,0 +1,68 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/sahara-ssh.rst b/doc/config-ref-rst/source/tables/sahara-ssh.rst new file mode 100644 index 0000000000..e76d3944b9 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-ssh.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of SSH configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ssh_timeout_common`` = ``300`` + - (IntOpt) Overrides timeout for common ssh operations, in seconds + * - ``ssh_timeout_files`` = ``120`` + - (IntOpt) Overrides timeout for ssh operations with files, in seconds + * - ``ssh_timeout_interactive`` = ``1800`` + - (IntOpt) Overrides timeout for interactive ssh operations, in seconds diff --git a/doc/config-ref-rst/source/tables/sahara-timeouts.rst b/doc/config-ref-rst/source/tables/sahara-timeouts.rst new file mode 100644 index 0000000000..2780cef334 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-timeouts.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of timeouts configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[timeouts]** + - + * - ``await_attach_volumes`` = ``10`` + - (IntOpt) Wait for attaching volumes to instances, in seconds + * - ``await_for_instances_active`` = ``10800`` + - (IntOpt) Wait for instances to become active, in seconds + * - ``delete_instances_timeout`` = ``10800`` + - (IntOpt) Wait for instances to be deleted, in seconds + * - ``detach_volume_timeout`` = ``300`` + - (IntOpt) Timeout for detaching volumes from instance, in seconds + * - ``ips_assign_timeout`` = ``10800`` + - (IntOpt) Assign IPs timeout, in seconds + * - ``volume_available_timeout`` = ``10800`` + - (IntOpt) Wait for volumes to become available, in seconds + * - ``wait_until_accessible`` = ``10800`` + - (IntOpt) Wait for instance accessibility, in seconds diff --git a/doc/config-ref-rst/source/tables/sahara-zeromq.rst b/doc/config-ref-rst/source/tables/sahara-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/sahara-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/doc/config-ref-rst/source/tables/trove-amqp.rst b/doc/config-ref-rst/source/tables/trove-amqp.rst new file mode 100644 index 0000000000..0e069d631a --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-amqp.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of AMQP configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``conductor_manager`` = ``trove.conductor.manager.Manager`` + - (StrOpt) Qualified class name to use for conductor manager. + * - ``conductor_queue`` = ``trove-conductor`` + - (StrOpt) Message queue name the Conductor will listen on. + * - ``control_exchange`` = ``openstack`` + - (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``notification_driver`` = ``[]`` + - (MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``notification_service_id`` = ``{'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae'}`` + - (DictOpt) Unique ID to tag notification events. + * - ``notification_topics`` = ``notifications`` + - (ListOpt) AMQP topic used for OpenStack notifications. + * - ``notification_transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. + * - ``transport_url`` = ``None`` + - (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. diff --git a/doc/config-ref-rst/source/tables/trove-api.rst b/doc/config-ref-rst/source/tables/trove-api.rst new file mode 100644 index 0000000000..266add8dec --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-api.rst @@ -0,0 +1,74 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``admin_roles`` = ``admin`` + - (ListOpt) Roles to add to an admin user. + * - ``api_paste_config`` = ``api-paste.ini`` + - (StrOpt) File name for the paste.deploy config for trove-api. + * - ``bind_host`` = ``0.0.0.0`` + - (IPOpt) IP address the API server will listen on. + * - ``bind_port`` = ``8779`` + - (IntOpt) Port the API server will listen on. + * - ``black_list_regex`` = ``None`` + - (StrOpt) Exclude IP addresses that match this regular expression. + * - ``db_api_implementation`` = ``trove.db.sqlalchemy.api`` + - (StrOpt) API Implementation for Trove database access. + * - ``hostname_require_valid_ip`` = ``True`` + - (BoolOpt) Require user hostnames to be valid IP addresses. + * - ``http_delete_rate`` = ``200`` + - (IntOpt) Maximum number of HTTP 'DELETE' requests (per minute). + * - ``http_get_rate`` = ``200`` + - (IntOpt) Maximum number of HTTP 'GET' requests (per minute). + * - ``http_mgmt_post_rate`` = ``200`` + - (IntOpt) Maximum number of management HTTP 'POST' requests (per minute). + * - ``http_post_rate`` = ``200`` + - (IntOpt) Maximum number of HTTP 'POST' requests (per minute). + * - ``http_put_rate`` = ``200`` + - (IntOpt) Maximum number of HTTP 'PUT' requests (per minute). + * - ``injected_config_location`` = ``/etc/trove/conf.d`` + - (StrOpt) Path to folder on the Guest where config files will be injected during instance creation. + * - ``instances_page_size`` = ``20`` + - (IntOpt) Page size for listing instances. + * - ``max_header_line`` = ``16384`` + - (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + * - ``os_region_name`` = ``RegionOne`` + - (StrOpt) Region name of this node. Used when searching catalog. + * - ``region`` = ``LOCAL_DEV`` + - (StrOpt) The region this service is located. + * - ``tcp_keepidle`` = ``600`` + - (IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. + * - ``trove_api_workers`` = ``None`` + - (IntOpt) Number of workers for the API service. The default will be the number of CPUs available. + * - ``trove_auth_url`` = ``http://0.0.0.0:5000/v2.0`` + - (StrOpt) Trove authentication URL. + * - ``trove_conductor_workers`` = ``None`` + - (IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available. + * - ``trove_security_group_name_prefix`` = ``SecGroup`` + - (StrOpt) Prefix to use when creating Security Groups. + * - ``trove_security_group_rule_cidr`` = ``0.0.0.0/0`` + - (StrOpt) CIDR to use when creating Security Group Rules. + * - ``trove_security_groups_support`` = ``True`` + - (BoolOpt) Whether Trove should add Security Groups on create. + * - ``users_page_size`` = ``20`` + - (IntOpt) Page size for listing users. + * - **[oslo_middleware]** + - + * - ``max_request_body_size`` = ``114688`` + - (IntOpt) The maximum body size for each request, in bytes. + * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` + - (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. diff --git a/doc/config-ref-rst/source/tables/trove-auth_token.rst b/doc/config-ref-rst/source/tables/trove-auth_token.rst new file mode 100644 index 0000000000..f7c51e484d --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-auth_token.rst @@ -0,0 +1,92 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (StrOpt) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (StrOpt) Service tenant name. + * - ``admin_token`` = ``None`` + - (StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. + * - ``admin_user`` = ``None`` + - (StrOpt) Service username. + * - ``auth_admin_prefix`` = ```` + - (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_plugin`` = ``None`` + - (StrOpt) Name of the plugin to load + * - ``auth_port`` = ``35357`` + - (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (StrOpt) Config Section from which to load plugin specific options + * - ``auth_uri`` = ``None`` + - (StrOpt) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (StrOpt) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (StrOpt) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. + * - ``hash_algorithms`` = ``md5`` + - (ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. + * - ``http_connect_timeout`` = ``None`` + - (IntOpt) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. + * - ``insecure`` = ``False`` + - (BoolOpt) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (StrOpt) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + * - ``memcache_use_advanced_pool`` = ``False`` + - (BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``region_name`` = ``None`` + - (StrOpt) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. + * - ``signing_dir`` = ``None`` + - (StrOpt) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. diff --git a/doc/config-ref-rst/source/tables/trove-backup.rst b/doc/config-ref-rst/source/tables/trove-backup.rst new file mode 100644 index 0000000000..650afa8716 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-backup.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of backup configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backup_aes_cbc_key`` = ``default_aes_cbc_key`` + - (StrOpt) Default OpenSSL aes_cbc key. + * - ``backup_chunk_size`` = ``65536`` + - (IntOpt) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/ + * - ``backup_runner`` = ``trove.guestagent.backup.backup_types.InnoBackupEx`` + - (StrOpt) Runner to use for backups. + * - ``backup_runner_options`` = ``{}`` + - (DictOpt) Additional options to be passed to the backup runner. + * - ``backup_segment_max_size`` = ``2147483648`` + - (IntOpt) Maximum size (in bytes) of each segment of the backup file. + * - ``backup_swift_container`` = ``database_backups`` + - (StrOpt) Swift container to put backups in. + * - ``backup_use_gzip_compression`` = ``True`` + - (BoolOpt) Compress backups using gzip. + * - ``backup_use_openssl_encryption`` = ``True`` + - (BoolOpt) Encrypt backups using OpenSSL. + * - ``backup_use_snet`` = ``False`` + - (BoolOpt) Send backup files over snet. + * - ``backups_page_size`` = ``20`` + - (IntOpt) Page size for listing backups. diff --git a/doc/config-ref-rst/source/tables/trove-clients.rst b/doc/config-ref-rst/source/tables/trove-clients.rst new file mode 100644 index 0000000000..1022e53d0f --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-clients.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of clients configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``remote_cinder_client`` = ``trove.common.remote.cinder_client`` + - (StrOpt) Client to send Cinder calls to. + * - ``remote_dns_client`` = ``trove.common.remote.dns_client`` + - (StrOpt) Client to send DNS calls to. + * - ``remote_guest_client`` = ``trove.common.remote.guest_client`` + - (StrOpt) Client to send Guest Agent calls to. + * - ``remote_heat_client`` = ``trove.common.remote.heat_client`` + - (StrOpt) Client to send Heat calls to. + * - ``remote_neutron_client`` = ``trove.common.remote.neutron_client`` + - (StrOpt) Client to send Neutron calls to. + * - ``remote_nova_client`` = ``trove.common.remote.nova_client`` + - (StrOpt) Client to send Nova calls to. + * - ``remote_swift_client`` = ``trove.common.remote.swift_client`` + - (StrOpt) Client to send Swift calls to. diff --git a/doc/config-ref-rst/source/tables/trove-cluster.rst b/doc/config-ref-rst/source/tables/trove-cluster.rst new file mode 100644 index 0000000000..6fe0427b7c --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-cluster.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of cluster configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cluster_delete_time_out`` = ``180`` + - (IntOpt) Maximum time (in seconds) to wait for a cluster delete. + * - ``cluster_usage_timeout`` = ``36000`` + - (IntOpt) Maximum time (in seconds) to wait for a cluster to become active. + * - ``clusters_page_size`` = ``20`` + - (IntOpt) Page size for listing clusters. diff --git a/doc/config-ref-rst/source/tables/trove-common.rst b/doc/config-ref-rst/source/tables/trove-common.rst new file mode 100644 index 0000000000..5a6d6536f2 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-common.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``configurations_page_size`` = ``20`` + - (IntOpt) Page size for listing configurations. + * - ``databases_page_size`` = ``20`` + - (IntOpt) Page size for listing databases. + * - ``default_datastore`` = ``None`` + - (StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request. + * - ``default_neutron_networks`` = ```` + - (ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. + * - ``default_password_length`` = ``36`` + - (IntOpt) Character length of generated passwords. + * - ``executor_thread_pool_size`` = ``64`` + - (IntOpt) Size of executor thread pool. + * - ``expected_filetype_suffixes`` = ``json`` + - (ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req. + * - ``host`` = ``0.0.0.0`` + - (IPOpt) Host to listen for RPC messages. + * - ``memcached_servers`` = ``None`` + - (ListOpt) Memcached servers or None for in process cache. + * - ``pybasedir`` = ``/usr/lib/python/site-packages/trove/trove`` + - (StrOpt) Directory where the Trove python module is installed. + * - ``pydev_path`` = ``None`` + - (StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path. + * - ``taskmanager_queue`` = ``taskmanager`` + - (StrOpt) Message queue name the Taskmanager will listen to. + * - ``template_path`` = ``/etc/trove/templates/`` + - (StrOpt) Path which leads to datastore templates. + * - ``timeout_wait_for_service`` = ``120`` + - (IntOpt) Maximum time (in seconds) to wait for a service to become alive. + * - ``usage_timeout`` = ``900`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + * - **[keystone_authtoken]** + - + * - ``memcached_servers`` = ``None`` + - (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. diff --git a/doc/config-ref-rst/source/tables/trove-compute.rst b/doc/config-ref-rst/source/tables/trove-compute.rst new file mode 100644 index 0000000000..144d4c2683 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-compute.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Compute configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``ip_regex`` = ``None`` + - (StrOpt) List IP addresses that match this regular expression. + * - ``nova_client_version`` = ``2`` + - (IntOpt) The version of of the compute service client. + * - ``nova_compute_endpoint_type`` = ``publicURL`` + - (StrOpt) Service endpoint type to use when searching catalog. + * - ``nova_compute_service_type`` = ``compute`` + - (StrOpt) Service type to use when searching catalog. + * - ``nova_compute_url`` = ``None`` + - (StrOpt) URL without the tenant segment. + * - ``root_grant`` = ``ALL`` + - (ListOpt) Permissions to grant to the 'root' user. + * - ``root_grant_option`` = ``True`` + - (BoolOpt) Assign the 'root' user GRANT permissions. diff --git a/doc/config-ref-rst/source/tables/trove-cors.rst b/doc/config-ref-rst/source/tables/trove-cors.rst new file mode 100644 index 0000000000..1442fbe280 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-cors.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (BoolOpt) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (ListOpt) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (IntOpt) Maximum cache age of CORS preflight requests. diff --git a/doc/config-ref-rst/source/tables/trove-database.rst b/doc/config-ref-rst/source/tables/trove-database.rst new file mode 100644 index 0000000000..82859d74a8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-database.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``sql_query_logging`` = ``False`` + - (BoolOpt) Allow insecure logging while executing queries through SQLAlchemy. + * - **[database]** + - + * - ``connection`` = ``sqlite:///trove_test.sqlite`` + - (StrOpt) SQL Connection. + * - ``idle_timeout`` = ``3600`` + - (IntOpt) No help text available for this option. + * - ``query_log`` = ``False`` + - (BoolOpt) No help text available for this option. diff --git a/doc/config-ref-rst/source/tables/trove-db_cassandra.rst b/doc/config-ref-rst/source/tables/trove-db_cassandra.rst new file mode 100644 index 0000000000..2fa82da2a3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_cassandra.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Cassandra database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cassandra]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``None`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``None`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``mount_point`` = ``/var/lib/cassandra`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``None`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for cassandra. + * - ``tcp_ports`` = ``7000, 7001, 9042, 9160`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_couchbase.rst b/doc/config-ref-rst/source/tables/trove-db_couchbase.rst new file mode 100644 index 0000000000..ce20cc0eef --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_couchbase.rst @@ -0,0 +1,68 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Couchbase database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[couchbase]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.couchbase_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``CbBackup`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``mount_point`` = ``/var/lib/couchbase`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.couchbase_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for couchbase. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``8091, 8092, 4369, 11209-11211, 21100-21199`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. + * - **[couchdb]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``None`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``None`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``mount_point`` = ``/var/lib/couchdb`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``None`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for couchdb. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the "password" field. + * - ``tcp_ports`` = ``5984`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_db2.rst b/doc/config-ref-rst/source/tables/trove-db_db2.rst new file mode 100644 index 0000000000..1b995d0fae --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_db2.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of DB2 database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[db2]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``None`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``None`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``ignore_users`` = ``PUBLIC, DB2INST1`` + - (ListOpt) No help text available for this option. + * - ``mount_point`` = ``/home/db2inst1/db2inst1`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``None`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for db2. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``50000`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_mariadb.rst b/doc/config-ref-rst/source/tables/trove-db_mariadb.rst new file mode 100644 index 0000000000..8bd32cf0bd --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_mariadb.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of MariaDB database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[mariadb]** + - + * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``InnoBackupEx`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` + - (ListOpt) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin, root`` + - (ListOpt) Users to exclude when listing users. + * - ``mount_point`` = ``/var/lib/mysql`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_binlog`` + - (StrOpt) Namespace to load replication strategies from. + * - ``replication_strategy`` = ``MysqlBinlogReplication`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for mysql. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``3306`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``usage_timeout`` = ``400`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_mongodb.rst b/doc/config-ref-rst/source/tables/trove-db_mongodb.rst new file mode 100644 index 0000000000..3c2d9be763 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_mongodb.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of MongoDB database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[mongodb]** + - + * - ``add_members_timeout`` = ``300`` + - (IntOpt) Maximum time to wait (in seconds) for a replica set initialization process to complete. + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.api.MongoDbAPIStrategy`` + - (StrOpt) Class that implements datastore-specific API logic. + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.mongo_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``MongoDump`` + - (StrOpt) Default strategy to perform backups. + * - ``cluster_support`` = ``True`` + - (BoolOpt) Enable clusters to be created and managed. + * - ``configsvr_port`` = ``27019`` + - (IntOpt) Port for instances running as config servers. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.guestagent.MongoDbGuestAgentStrategy`` + - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + * - ``ignore_dbs`` = ``admin, local, config`` + - (ListOpt) Databases to exclude when listing databases. + * - ``ignore_users`` = ``admin.os_admin, admin.root`` + - (ListOpt) Users to exclude when listing users. + * - ``mongodb_port`` = ``27017`` + - (IntOpt) Port for mongod and mongos instances. + * - ``mount_point`` = ``/var/lib/mongodb`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``num_config_servers_per_cluster`` = ``3`` + - (IntOpt) The number of config servers to create per cluster. + * - ``num_query_routers_per_cluster`` = ``1`` + - (IntOpt) The number of query routers (mongos) to create per cluster. + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.mongo_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for mongodb. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.taskmanager.MongoDbTaskManagerStrategy`` + - (StrOpt) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``2500, 27017`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_mysql.rst b/doc/config-ref-rst/source/tables/trove-db_mysql.rst new file mode 100644 index 0000000000..c18fb6e20a --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_mysql.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of MySQL database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[mysql]** + - + * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``InnoBackupEx`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` + - (ListOpt) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin, root`` + - (ListOpt) Users to exclude when listing users. + * - ``mount_point`` = ``/var/lib/mysql`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` + - (StrOpt) Namespace to load replication strategies from. + * - ``replication_strategy`` = ``MysqlGTIDReplication`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for mysql. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``3306`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``usage_timeout`` = ``400`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_percona.rst b/doc/config-ref-rst/source/tables/trove-db_percona.rst new file mode 100644 index 0000000000..9a6610b21d --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_percona.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Percona database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[percona]** + - + * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``InnoBackupEx`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` + - (ListOpt) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin, root`` + - (ListOpt) Users to exclude when listing users. + * - ``mount_point`` = ``/var/lib/mysql`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` + - (StrOpt) Namespace to load replication strategies from. + * - ``replication_password`` = ``NETOU7897NNLOU`` + - (StrOpt) Password for replication slave user. + * - ``replication_strategy`` = ``MysqlGTIDReplication`` + - (StrOpt) Default strategy for replication. + * - ``replication_user`` = ``slave_user`` + - (StrOpt) Userid for replication slave. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for percona. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``3306`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``usage_timeout`` = ``450`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_postgresql.rst b/doc/config-ref-rst/source/tables/trove-db_postgresql.rst new file mode 100644 index 0000000000..11f745eaa0 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_postgresql.rst @@ -0,0 +1,44 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of PostgreSQL database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[postgresql]** + - + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.postgresql_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``PgDump`` + - (StrOpt) Default strategy to perform backups. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) No help text available for this option. + * - ``ignore_dbs`` = ``postgres`` + - (ListOpt) No help text available for this option. + * - ``ignore_users`` = ``os_admin, postgres, root`` + - (ListOpt) No help text available for this option. + * - ``mount_point`` = ``/var/lib/postgresql`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.postgresql_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for postgresql. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``tcp_ports`` = ``5432`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_pxc.rst b/doc/config-ref-rst/source/tables/trove-db_pxc.rst new file mode 100644 index 0000000000..60ee08316f --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_pxc.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Percona XtraDB Cluster database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[pxc]** + - + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.api.PXCAPIStrategy`` + - (StrOpt) Class that implements datastore-specific API logic. + * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``InnoBackupEx`` + - (StrOpt) Default strategy to perform backups. + * - ``cluster_support`` = ``True`` + - (BoolOpt) Enable clusters to be created and managed. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.guestagent.PXCGuestAgentStrategy`` + - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` + - (ListOpt) Databases to exclude when listing databases. + * - ``ignore_users`` = ``os_admin, root, clusterrepuser`` + - (ListOpt) Users to exclude when listing users. + * - ``min_cluster_member_count`` = ``3`` + - (IntOpt) Minimum number of members in PXC cluster. + * - ``mount_point`` = ``/var/lib/mysql`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.mysql_gtid`` + - (StrOpt) Namespace to load replication strategies from. + * - ``replication_strategy`` = ``MysqlGTIDReplication`` + - (StrOpt) Default strategy for replication. + * - ``replication_user`` = ``slave_user`` + - (StrOpt) Userid for replication slave. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for pxc. + * - ``root_on_create`` = ``False`` + - (BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.pxc.taskmanager.PXCTaskManagerStrategy`` + - (StrOpt) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``3306, 4444, 4567, 4568`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``usage_timeout`` = ``450`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest to become active. + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_redis.rst b/doc/config-ref-rst/source/tables/trove-db_redis.rst new file mode 100644 index 0000000000..16cabefc19 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_redis.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[redis]** + - + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.redis.api.RedisAPIStrategy`` + - (StrOpt) Class that implements datastore-specific API logic. + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.redis_impl`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``RedisBackup`` + - (StrOpt) Default strategy to perform backups. + * - ``cluster_support`` = ``True`` + - (BoolOpt) Enable clusters to be created and managed. + * - ``device_path`` = ``None`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.redis.guestagent.RedisGuestAgentStrategy`` + - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + * - ``mount_point`` = ``/var/lib/redis`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.experimental.redis_sync`` + - (StrOpt) Namespace to load replication strategies from. + * - ``replication_strategy`` = ``RedisSyncReplication`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.redis_impl`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + - (StrOpt) Root controller implementation for redis. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.redis.taskmanager.RedisTaskManagerStrategy`` + - (StrOpt) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``6379, 16379`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ```` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-db_vertica.rst b/doc/config-ref-rst/source/tables/trove-db_vertica.rst new file mode 100644 index 0000000000..b114a7b5c7 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-db_vertica.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Vertica database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[vertica]** + - + * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.api.VerticaAPIStrategy`` + - (StrOpt) Class that implements datastore-specific API logic. + * - ``backup_incremental_strategy`` = ``{}`` + - (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. + * - ``backup_namespace`` = ``None`` + - (StrOpt) Namespace to load backup strategies from. + * - ``backup_strategy`` = ``None`` + - (StrOpt) Default strategy to perform backups. + * - ``cluster_member_count`` = ``3`` + - (IntOpt) Number of members in Vertica cluster. + * - ``cluster_support`` = ``True`` + - (BoolOpt) Enable clusters to be created and managed. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.guestagent.VerticaGuestAgentStrategy`` + - (StrOpt) Class that implements datastore-specific Guest Agent API logic. + * - ``mount_point`` = ``/var/lib/vertica`` + - (StrOpt) Filesystem path for mounting volumes if volume support is enabled. + * - ``readahead_size`` = ``2048`` + - (IntOpt) Size(MB) to be set as readahead_size for data volume + * - ``replication_strategy`` = ``None`` + - (StrOpt) Default strategy for replication. + * - ``restore_namespace`` = ``None`` + - (StrOpt) Namespace to load restore strategies from. + * - ``root_controller`` = ``trove.extensions.vertica.service.VerticaRootController`` + - (StrOpt) Root controller implementation for Vertica. + * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.taskmanager.VerticaTaskManagerStrategy`` + - (StrOpt) Class that implements datastore-specific task manager logic. + * - ``tcp_ports`` = ``5433, 5434, 22, 5444, 5450, 4803`` + - (ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``udp_ports`` = ``5433, 4803, 4804, 6453`` + - (ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). + * - ``volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. diff --git a/doc/config-ref-rst/source/tables/trove-debug.rst b/doc/config-ref-rst/source/tables/trove-debug.rst new file mode 100644 index 0000000000..ffd9c67da0 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-debug.rst @@ -0,0 +1,32 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``backlog`` = ``4096`` + - (IntOpt) Number of backlog requests to configure the socket with + * - ``pydev_debug`` = ``disabled`` + - (StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled. + * - ``pydev_debug_host`` = ``None`` + - (StrOpt) Pydev debug server host (localhost by default). + * - ``pydev_debug_port`` = ``5678`` + - (IntOpt) Pydev debug server port (5678 by default). + * - **[profiler]** + - + * - ``enabled`` = ``False`` + - (BoolOpt) If False fully disable profiling feature. + * - ``trace_sqlalchemy`` = ``True`` + - (BoolOpt) If False doesn't trace SQL requests. diff --git a/doc/config-ref-rst/source/tables/trove-dns.rst b/doc/config-ref-rst/source/tables/trove-dns.rst new file mode 100644 index 0000000000..1fc3dcba01 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-dns.rst @@ -0,0 +1,50 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of DNS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``dns_account_id`` = ```` + - (StrOpt) Tenant ID for DNSaaS. + * - ``dns_auth_url`` = ```` + - (StrOpt) Authentication URL for DNSaaS. + * - ``dns_domain_id`` = ```` + - (StrOpt) Domain ID used for adding DNS entries. + * - ``dns_domain_name`` = ```` + - (StrOpt) Domain name used for adding DNS entries. + * - ``dns_driver`` = ``trove.dns.driver.DnsDriver`` + - (StrOpt) Driver for DNSaaS. + * - ``dns_endpoint_url`` = ``0.0.0.0`` + - (StrOpt) Endpoint URL for DNSaaS. + * - ``dns_hostname`` = ```` + - (StrOpt) Hostname used for adding DNS entries. + * - ``dns_instance_entry_factory`` = ``trove.dns.driver.DnsInstanceEntryFactory`` + - (StrOpt) Factory for adding DNS entries. + * - ``dns_management_base_url`` = ```` + - (StrOpt) Management URL for DNSaaS. + * - ``dns_passkey`` = ```` + - (StrOpt) Passkey for DNSaaS. + * - ``dns_region`` = ```` + - (StrOpt) Region name for DNSaaS. + * - ``dns_service_type`` = ```` + - (StrOpt) Service Type for DNSaaS. + * - ``dns_time_out`` = ``120`` + - (IntOpt) Maximum time (in seconds) to wait for a DNS entry add. + * - ``dns_ttl`` = ``300`` + - (IntOpt) Time (in seconds) before a refresh of DNS information occurs. + * - ``dns_username`` = ```` + - (StrOpt) Username for DNSaaS. + * - ``trove_dns_support`` = ``False`` + - (BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS). diff --git a/doc/config-ref-rst/source/tables/trove-guestagent.rst b/doc/config-ref-rst/source/tables/trove-guestagent.rst new file mode 100644 index 0000000000..41b4459d5a --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-guestagent.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of guest agent configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``agent_call_high_timeout`` = ``60`` + - (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database). + * - ``agent_call_low_timeout`` = ``5`` + - (IntOpt) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases). + * - ``agent_heartbeat_expiry`` = ``60`` + - (IntOpt) Time (in seconds) after which a guest is considered unreachable + * - ``agent_heartbeat_time`` = ``10`` + - (IntOpt) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request. + * - ``agent_replication_snapshot_timeout`` = ``36000`` + - (IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot. + * - ``guest_config`` = ``/etc/trove/trove-guestagent.conf`` + - (StrOpt) Path to the Guest Agent config file to be injected during instance creation. + * - ``guest_id`` = ``None`` + - (StrOpt) ID of the Guest Instance. + * - ``guest_info`` = ``guest_info.conf`` + - (StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file + * - ``mount_options`` = ``defaults,noatime`` + - (StrOpt) Options to use when mounting a volume. + * - ``storage_namespace`` = ``trove.guestagent.strategies.storage.swift`` + - (StrOpt) Namespace to load the default storage strategy from. + * - ``storage_strategy`` = ``SwiftStorage`` + - (StrOpt) Default strategy to store backups. + * - ``usage_sleep_time`` = ``5`` + - (IntOpt) Time to sleep during the check for an active Guest. diff --git a/doc/config-ref-rst/source/tables/trove-heat.rst b/doc/config-ref-rst/source/tables/trove-heat.rst new file mode 100644 index 0000000000..de1e400240 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-heat.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Orchestration module configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``heat_endpoint_type`` = ``publicURL`` + - (StrOpt) Service endpoint type to use when searching catalog. + * - ``heat_service_type`` = ``orchestration`` + - (StrOpt) Service type to use when searching catalog. + * - ``heat_time_out`` = ``60`` + - (IntOpt) Maximum time (in seconds) to wait for a Heat request to complete. + * - ``heat_url`` = ``None`` + - (StrOpt) URL without the tenant segment. diff --git a/doc/config-ref-rst/source/tables/trove-logging.rst b/doc/config-ref-rst/source/tables/trove-logging.rst new file mode 100644 index 0000000000..41d00a6a1d --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-logging.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). + * - ``default_log_levels`` = ``amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN`` + - (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (BoolOpt) Enables or disables fatal status of deprecations. + * - ``format_options`` = ``-m 5`` + - (StrOpt) Options to use when formatting a volume. + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (StrOpt) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. + * - ``log_format`` = ``None`` + - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (StrOpt) Data to append to log format when level is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (StrOpt) Format string to use for log messages without context. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (StrOpt) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (StrOpt) Format string for user_identity field of the logging_context_format_string + * - ``network_label_regex`` = ``^private$`` + - (StrOpt) Regular expression to match Trove network labels. + * - ``publish_errors`` = ``False`` + - (BoolOpt) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``use_syslog_rfc_format`` = ``True`` + - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + * - ``watch_log_file`` = ``False`` + - (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-ref-rst/source/tables/trove-network.rst b/doc/config-ref-rst/source/tables/trove-network.rst new file mode 100644 index 0000000000..12300f0d99 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-network.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of network configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``network_driver`` = ``trove.network.nova.NovaNetwork`` + - (StrOpt) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.). + * - ``neutron_endpoint_type`` = ``publicURL`` + - (StrOpt) Service endpoint type to use when searching catalog. + * - ``neutron_service_type`` = ``network`` + - (StrOpt) Service type to use when searching catalog. + * - ``neutron_url`` = ``None`` + - (StrOpt) URL without the tenant segment. diff --git a/doc/config-ref-rst/source/tables/trove-nova.rst b/doc/config-ref-rst/source/tables/trove-nova.rst new file mode 100644 index 0000000000..da98833038 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-nova.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of nova configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``nova_proxy_admin_pass`` = ```` + - (StrOpt) Admin password used to connect to Nova. + * - ``nova_proxy_admin_tenant_id`` = ```` + - (StrOpt) Admin tenant ID used to connect to Nova. + * - ``nova_proxy_admin_tenant_name`` = ```` + - (StrOpt) Admin tenant name used to connect to Nova. + * - ``nova_proxy_admin_user`` = ```` + - (StrOpt) Admin username used to connect to Nova. diff --git a/doc/config-ref-rst/source/tables/trove-qpid.rst b/doc/config-ref-rst/source/tables/trove-qpid.rst new file mode 100644 index 0000000000..b015264a21 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-qpid.rst @@ -0,0 +1,46 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Qpid configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_qpid]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``qpid_heartbeat`` = ``60`` + - (IntOpt) Seconds between connection keepalive heartbeats. + * - ``qpid_hostname`` = ``localhost`` + - (StrOpt) Qpid broker hostname. + * - ``qpid_hosts`` = ``$qpid_hostname:$qpid_port`` + - (ListOpt) Qpid HA cluster host:port pairs. + * - ``qpid_password`` = ```` + - (StrOpt) Password for Qpid connection. + * - ``qpid_port`` = ``5672`` + - (IntOpt) Qpid broker port. + * - ``qpid_protocol`` = ``tcp`` + - (StrOpt) Transport to use, either 'tcp' or 'ssl'. + * - ``qpid_receiver_capacity`` = ``1`` + - (IntOpt) The number of prefetched messages held by receiver. + * - ``qpid_sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of SASL mechanisms to use for auth. + * - ``qpid_tcp_nodelay`` = ``True`` + - (BoolOpt) Whether to disable the Nagle algorithm. + * - ``qpid_topology_version`` = ``1`` + - (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + * - ``qpid_username`` = ```` + - (StrOpt) Username for Qpid connection. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/trove-quota.rst b/doc/config-ref-rst/source/tables/trove-quota.rst new file mode 100644 index 0000000000..827ef7ec38 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-quota.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of quota configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``max_accepted_volume_size`` = ``5`` + - (IntOpt) Default maximum volume size (in GB) for an instance. + * - ``max_backups_per_tenant`` = ``50`` + - (IntOpt) Default maximum number of backups created by a tenant. + * - ``max_instances_per_tenant`` = ``5`` + - (IntOpt) Default maximum number of instances per tenant. + * - ``max_volumes_per_tenant`` = ``20`` + - (IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant. + * - ``quota_driver`` = ``trove.quota.quota.DbQuotaDriver`` + - (StrOpt) Default driver to use for quota checks. diff --git a/doc/config-ref-rst/source/tables/trove-rabbitmq.rst b/doc/config-ref-rst/source/tables/trove-rabbitmq.rst new file mode 100644 index 0000000000..204bbdc7cc --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-rabbitmq.rst @@ -0,0 +1,66 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (BoolOpt) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (BoolOpt) Use durable queues in AMQP. + * - ``fake_rabbit`` = ``False`` + - (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + * - ``heartbeat_rate`` = ``2`` + - (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``kombu_reconnect_delay`` = ``1.0`` + - (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_reconnect_timeout`` = ``60`` + - (IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. + * - ``kombu_ssl_ca_certs`` = ```` + - (StrOpt) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = ```` + - (StrOpt) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = ```` + - (StrOpt) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = ```` + - (StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``rabbit_ha_queues`` = ``False`` + - (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. + * - ``rabbit_host`` = ``localhost`` + - (StrOpt) The RabbitMQ broker address where a single node is used. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (ListOpt) RabbitMQ HA cluster host:port pairs. + * - ``rabbit_login_method`` = ``AMQPLAIN`` + - (StrOpt) The RabbitMQ login method. + * - ``rabbit_max_retries`` = ``0`` + - (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + * - ``rabbit_password`` = ``guest`` + - (StrOpt) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (IntOpt) The RabbitMQ broker port where a single node is used. + * - ``rabbit_retry_backoff`` = ``2`` + - (IntOpt) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (IntOpt) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_use_ssl`` = ``False`` + - (BoolOpt) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (StrOpt) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (StrOpt) The RabbitMQ virtual host. + * - ``send_single_reply`` = ``False`` + - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/config-ref-rst/source/tables/trove-redis.rst b/doc/config-ref-rst/source/tables/trove-redis.rst new file mode 100644 index 0000000000..75a290f1d8 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-redis.rst @@ -0,0 +1,30 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. + * - **[matchmaker_redis]** + - + * - ``host`` = ``127.0.0.1`` + - (StrOpt) Host to locate redis. + * - ``password`` = ```` + - (StrOpt) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (IntOpt) Use this port to connect to redis host. diff --git a/doc/config-ref-rst/source/tables/trove-rpc.rst b/doc/config-ref-rst/source/tables/trove-rpc.rst new file mode 100644 index 0000000000..88b51078b3 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-rpc.rst @@ -0,0 +1,72 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``num_tries`` = ``3`` + - (IntOpt) Number of times to check if a volume exists. + * - ``report_interval`` = ``30`` + - (IntOpt) The interval (in seconds) which periodic tasks are run. + * - ``rpc_backend`` = ``rabbit`` + - (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. + * - ``rpc_cast_timeout`` = ``30`` + - (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. + * - ``rpc_conn_pool_size`` = ``30`` + - (IntOpt) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (IntOpt) Seconds to wait for a response from a call. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (BoolOpt) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (BoolOpt) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (StrOpt) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (StrOpt) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (StrOpt) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (IntOpt) Timeout for inactive connections (in seconds) + * - ``password`` = ```` + - (StrOpt) Password for message broker authentication + * - ``sasl_config_dir`` = ```` + - (StrOpt) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = ```` + - (StrOpt) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = ```` + - (StrOpt) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (StrOpt) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = ```` + - (StrOpt) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = ```` + - (StrOpt) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = ```` + - (StrOpt) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (StrOpt) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (BoolOpt) Debug: dump AMQP frames to stdout + * - ``username`` = ```` + - (StrOpt) User name for message broker authentication diff --git a/doc/config-ref-rst/source/tables/trove-swift.rst b/doc/config-ref-rst/source/tables/trove-swift.rst new file mode 100644 index 0000000000..383151bd89 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-swift.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of swift configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``swift_endpoint_type`` = ``publicURL`` + - (StrOpt) Service endpoint type to use when searching catalog. + * - ``swift_service_type`` = ``object-store`` + - (StrOpt) Service type to use when searching catalog. + * - ``swift_url`` = ``None`` + - (StrOpt) URL ending in AUTH_. diff --git a/doc/config-ref-rst/source/tables/trove-taskmanager.rst b/doc/config-ref-rst/source/tables/trove-taskmanager.rst new file mode 100644 index 0000000000..b1b3b18f4c --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-taskmanager.rst @@ -0,0 +1,54 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of taskmanager configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``cloudinit_location`` = ``/etc/trove/cloudinit`` + - (StrOpt) Path to folder with cloudinit scripts. + * - ``datastore_manager`` = ``None`` + - (StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision. + * - ``datastore_registry_ext`` = ``{}`` + - (DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove. + * - ``exists_notification_interval`` = ``3600`` + - (IntOpt) Seconds to wait between pushing events. + * - ``exists_notification_transformer`` = ``None`` + - (StrOpt) Transformer for exists notifications. + * - ``reboot_time_out`` = ``120`` + - (IntOpt) Maximum time (in seconds) to wait for a server reboot. + * - ``resize_time_out`` = ``600`` + - (IntOpt) Maximum time (in seconds) to wait for a server resize. + * - ``restore_usage_timeout`` = ``36000`` + - (IntOpt) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active. + * - ``revert_time_out`` = ``600`` + - (IntOpt) Maximum time (in seconds) to wait for a server resize revert. + * - ``server_delete_time_out`` = ``60`` + - (IntOpt) Maximum time (in seconds) to wait for a server delete. + * - ``state_change_poll_time`` = ``3`` + - (IntOpt) Interval between state change poll requests (seconds). + * - ``state_change_wait_time`` = ``180`` + - (IntOpt) Maximum time (in seconds) to wait for a state change. + * - ``update_status_on_fail`` = ``True`` + - (BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout. + * - ``usage_sleep_time`` = ``5`` + - (IntOpt) Time to sleep during the check for an active Guest. + * - ``use_heat`` = ``False`` + - (BoolOpt) Use Heat for provisioning. + * - ``use_nova_server_config_drive`` = ``False`` + - (BoolOpt) Use config drive for file injection when booting instance. + * - ``use_nova_server_volume`` = ``False`` + - (BoolOpt) Whether to provision a Cinder volume for the Nova instance. + * - ``verify_swift_checksum_on_restore`` = ``True`` + - (BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file. diff --git a/doc/config-ref-rst/source/tables/trove-upgrades.rst b/doc/config-ref-rst/source/tables/trove-upgrades.rst new file mode 100644 index 0000000000..27c8860a07 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-upgrades.rst @@ -0,0 +1,24 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of upgrades configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[upgrade_levels]** + - + * - ``conductor`` = ``icehouse`` + - (StrOpt) Set a version cap for messages sent to conductor services + * - ``guestagent`` = ``icehouse`` + - (StrOpt) Set a version cap for messages sent to guestagent services + * - ``taskmanager`` = ``icehouse`` + - (StrOpt) Set a version cap for messages sent to taskmanager services diff --git a/doc/config-ref-rst/source/tables/trove-volume.rst b/doc/config-ref-rst/source/tables/trove-volume.rst new file mode 100644 index 0000000000..500a83f811 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-volume.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of volume configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``block_device_mapping`` = ``vdb`` + - (StrOpt) Block device to map onto the created instance. + * - ``cinder_endpoint_type`` = ``publicURL`` + - (StrOpt) Service endpoint type to use when searching catalog. + * - ``cinder_service_type`` = ``volumev2`` + - (StrOpt) Service type to use when searching catalog. + * - ``cinder_url`` = ``None`` + - (StrOpt) URL without the tenant segment. + * - ``cinder_volume_type`` = ``None`` + - (StrOpt) Volume type to use when provisioning a Cinder volume. + * - ``device_path`` = ``/dev/vdb`` + - (StrOpt) Device path for volume if volume support is enabled. + * - ``trove_volume_support`` = ``True`` + - (BoolOpt) Whether to provision a Cinder volume for datadir. + * - ``volume_format_timeout`` = ``120`` + - (IntOpt) Maximum time (in seconds) to wait for a volume format. + * - ``volume_fstype`` = ``ext3`` + - (StrOpt) File system type used to format a volume. + * - ``volume_time_out`` = ``60`` + - (IntOpt) Maximum time (in seconds) to wait for a volume attach. diff --git a/doc/config-ref-rst/source/tables/trove-zeromq.rst b/doc/config-ref-rst/source/tables/trove-zeromq.rst new file mode 100644 index 0000000000..8478e29150 --- /dev/null +++ b/doc/config-ref-rst/source/tables/trove-zeromq.rst @@ -0,0 +1,42 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_zmq_all_req_rep`` = ``True`` + - (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + * - ``rpc_zmq_bind_address`` = ``*`` + - (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (IntOpt) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_concurrency`` = ``eventlet`` + - (StrOpt) Type of concurrency used. Either "native" or "eventlet" + * - ``rpc_zmq_contexts`` = ``1`` + - (IntOpt) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (StrOpt) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (StrOpt) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (IntOpt) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49152`` + - (IntOpt) Minimal port number for random ports range. + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``zmq_use_broker`` = ``True`` + - (BoolOpt) Shows whether zmq-messaging uses broker or not. diff --git a/tools/autogenerate-config-flagmappings/aodh.flagmappings b/tools/autogenerate-config-flagmappings/aodh.flagmappings index 179051c1e6..a09c95640d 100644 --- a/tools/autogenerate-config-flagmappings/aodh.flagmappings +++ b/tools/autogenerate-config-flagmappings/aodh.flagmappings @@ -21,13 +21,14 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging -matchmaker_heartbeat_freq rpc -matchmaker_heartbeat_ttl rpc +logging_user_identity_format logging memcached_servers common notification_driver amqp notification_topics amqp -notification_workers common +notification_transport_url amqp notifier_rpc_topic common +password common +port common project_alarm_quota common publish_errors logging record_history common @@ -38,13 +39,18 @@ rest_notifier_ssl_verify common rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc +rpc_poll_timeout rpc rpc_response_timeout rpc +rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq +rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq -rpc_zmq_port zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq syslog_log_facility logging transport_url amqp @@ -53,6 +59,8 @@ use_syslog logging use_syslog_rfc_format logging user_alarm_quota common verbose logging +watch_log_file logging +zmq_use_broker zeromq api/host api api/paste_config api api/pecan_debug api @@ -136,18 +144,22 @@ keystone_authtoken/token_cache_time auth_token matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis -matchmaker_ring/ringfile redis oslo_messaging_amqp/allow_insecure_clients rpc oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/password rpc +oslo_messaging_amqp/sasl_config_dir rpc +oslo_messaging_amqp/sasl_config_name rpc +oslo_messaging_amqp/sasl_mechanisms rpc oslo_messaging_amqp/server_request_prefix rpc oslo_messaging_amqp/ssl_ca_file rpc oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/username rpc oslo_messaging_qpid/amqp_auto_delete qpid oslo_messaging_qpid/amqp_durable_queues qpid oslo_messaging_qpid/qpid_heartbeat qpid diff --git a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings index b91c5d4b91..2f0f10fbc7 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings +++ b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings @@ -6,8 +6,8 @@ control_exchange amqp database_connection database debug logging default_log_levels logging -dispatcher rpc dns_control_exchange exchange +event_dispatchers dispatchers event_pipeline_cfg_file api executor_thread_pool_size common fatal_deprecations logging @@ -33,12 +33,15 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging magnetodb_control_exchange magnetodb magnum_control_exchange exchange memcached_servers common +meter_dispatchers dispatchers neutron_control_exchange exchange notification_driver amqp notification_topics amqp +notification_transport_url amqp nova_control_exchange exchange nova_http_log_debug debug password redis @@ -62,11 +65,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq sahara_control_exchange exchange sample_source exchange @@ -144,7 +150,6 @@ database/max_retries database database/metering_connection database database/metering_time_to_live database database/min_pool_size database -database/mongodb_replica_set database database/mysql_sql_mode database database/pool_timeout database database/retry_interval database @@ -156,7 +161,6 @@ dispatcher_file/backup_count collector dispatcher_file/file_path collector dispatcher_file/max_bytes collector dispatcher_gnocchi/archive_policy dispatcher_gnocchi -dispatcher_gnocchi/archive_policy_file dispatcher_gnocchi dispatcher_gnocchi/filter_project dispatcher_gnocchi dispatcher_gnocchi/filter_service_activity dispatcher_gnocchi dispatcher_gnocchi/resources_definition_file dispatcher_gnocchi diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index b98931fed1..3d51d4bc3a 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -30,6 +30,8 @@ backup_service_inithost_offload backups backup_sha_block_size_bytes backups_nfs backup_share backups_nfs backup_swift_auth backups_swift +backup_swift_auth_insecure swift +backup_swift_auth_url swift backup_swift_auth_version backups_swift backup_swift_block_size backups_swift backup_swift_ca_cert_file backups_swift @@ -66,6 +68,8 @@ cb_confirm_volume_delete_retries cloudbyte cb_confirm_volume_delete_retry_interval cloudbyte cb_create_volume cloudbyte cb_tsm_name cloudbyte +cb_update_file_system cloudbyte +cb_update_qos_group cloudbyte chap_password common chap_username common check_max_pool_luns_threshold emc @@ -103,6 +107,7 @@ dothill_verify_certificate dothill dothill_verify_certificate_path dothill dpl_pool prophetstor_dpl dpl_port prophetstor_dpl +drbdmanage_devs_on_controller drbd drbdmanage_redundancy drbd driver_client_cert datera driver_client_cert_key datera @@ -188,16 +193,16 @@ hitachi_thin_pool_id hitachi-hbsd hitachi_unit_name hitachi-hbsd hitachi_zoning_request hitachi-hbsd host common -hp3par_api_url hp3par -hp3par_cpg hp3par -hp3par_cpg_snap hp3par -hp3par_debug hp3par -hp3par_iscsi_chap_enabled hp3par -hp3par_iscsi_ips hp3par -hp3par_password hp3par -hp3par_snapshot_expiration hp3par -hp3par_snapshot_retention hp3par -hp3par_username hp3par +hpe3par_api_url hpe3par +hpe3par_cpg hpe3par +hpe3par_cpg_snap hpe3par +hpe3par_debug hpe3par +hpe3par_iscsi_chap_enabled hpe3par +hpe3par_iscsi_ips hpe3par +hpe3par_password hpe3par +hpe3par_snapshot_expiration hpe3par +hpe3par_snapshot_retention hpe3par +hpe3par_username hpe3par hplefthand_api_url hplefthand hplefthand_clustername hplefthand hplefthand_debug hplefthand @@ -228,6 +233,7 @@ hpxp_storage_id hpxp hpxp_target_ports hpxp hpxp_thin_pool hpxp hpxp_zoning_request hpxp +hypermetro_devices huawei ibmnas_platform_type ibmnas iet_conf common ignore_pool_full_threshold api @@ -269,6 +275,7 @@ iser_helper storage iser_ip_address storage iser_port storage iser_target_prefix storage +keystone_catalog_info backups_swift lenovo_api_protocol lenovo lenovo_backend_name lenovo lenovo_backend_type lenovo @@ -284,10 +291,10 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging lvm_conf_file lvm lvm_mirrors lvm lvm_type lvm -managed_replication_target common management_ips api max_age quota max_header_line api @@ -341,6 +348,7 @@ nimble_subnet_label nimble no_snapshot_gb_quota common notification_driver amqp notification_topics amqp +notification_transport_url amqp nova_api_insecure compute nova_ca_certificates_file compute nova_catalog_admin_info compute @@ -396,7 +404,7 @@ rbd_secret_uuid storage_ceph rbd_store_chunk_size storage_ceph rbd_user storage_ceph replication_api_class common -replication_devices common +replication_device common report_interval common request_timeout common reservation_expire quota @@ -410,11 +418,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq san_clustername san xiv san_ip san prophetstor_dpl xiv @@ -448,6 +459,7 @@ sf_emulate_512 solidfire sf_enable_volume_mapping solidfire sf_svip solidfire sf_template_account_name solidfire +sf_volume_prefix solidfire sheepdog_store_address sheepdog sheepdog_store_port sheepdog sio_force_delete emc_sio @@ -461,6 +473,7 @@ sio_storage_pool_name emc_sio sio_storage_pools emc_sio sio_unmap_volume_before_deletion emc_sio sio_verify_server_certificate emc_sio +smbfs_allocation_info_file_path smbfs smbfs_default_volume_format smbfs smbfs_mount_options smbfs smbfs_mount_point_base smbfs @@ -491,13 +504,13 @@ storwize_svc_flashcopy_timeout storwize storwize_svc_iscsi_chap_enabled storwize storwize_svc_multihostmap_enabled storwize storwize_svc_multipath_enabled storwize -storwize_svc_npiv_compatibility_mode storwize storwize_svc_stretched_cluster_partner storwize storwize_svc_vol_autoexpand storwize storwize_svc_vol_compression storwize storwize_svc_vol_easytier storwize storwize_svc_vol_grainsize storwize storwize_svc_vol_iogrp storwize +storwize_svc_vol_nofmtdisk storwize storwize_svc_vol_rsize storwize storwize_svc_vol_warning storwize storwize_svc_volpool_name storwize diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers index 81779363d9..7cf7605a24 100644 --- a/tools/autogenerate-config-flagmappings/cinder.headers +++ b/tools/autogenerate-config-flagmappings/cinder.headers @@ -20,7 +20,7 @@ hds-hnas HDS HNAS iSCSI and NFS driver hds-hus HDS HUS iSCSI driver hgst HGST volume driver hitachi-hbsd Hitachi storage volume driver -hp3par HP 3PAR Fibre Channel and iSCSI drivers +hpe3par HPE 3PAR Fibre Channel and iSCSI drivers hplefthand HP LeftHand/StoreVirtual driver hpmsa HP MSA volume driver hpxp HP XP volume driver diff --git a/tools/autogenerate-config-flagmappings/glance.flagmappings b/tools/autogenerate-config-flagmappings/glance.flagmappings index 15e2ab84df..6a596e27db 100644 --- a/tools/autogenerate-config-flagmappings/glance.flagmappings +++ b/tools/autogenerate-config-flagmappings/glance.flagmappings @@ -63,6 +63,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging mastertoken replicator max_header_line api max_request_id_length api @@ -72,6 +73,7 @@ metadata_source_path common metaonly replicator notification_driver amqp notification_topics amqp +notification_transport_url amqp owner_is_tenant api password redis port redis @@ -96,11 +98,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq scrub_pool_size imagecache scrub_time imagecache @@ -164,6 +169,7 @@ glance_store/cinder_catalog_info cinder glance_store/cinder_endpoint_template cinder glance_store/cinder_http_retries cinder glance_store/default_store api +glance_store/default_swift_reference swift glance_store/filesystem_store_datadir filesystem glance_store/filesystem_store_datadirs filesystem glance_store/filesystem_store_file_perm filesystem @@ -196,6 +202,26 @@ glance_store/sheepdog_store_chunk_size sheepdog glance_store/sheepdog_store_port sheepdog glance_store/store_capabilities_update_min_interval api glance_store/stores api +glance_store/swift_store_admin_tenants swift +glance_store/swift_store_auth_address swift +glance_store/swift_store_auth_insecure swift +glance_store/swift_store_auth_version swift +glance_store/swift_store_cacert swift +glance_store/swift_store_config_file swift +glance_store/swift_store_container swift +glance_store/swift_store_create_container_on_put swift +glance_store/swift_store_endpoint swift +glance_store/swift_store_endpoint_type swift +glance_store/swift_store_key swift +glance_store/swift_store_large_object_chunk_size swift +glance_store/swift_store_large_object_size swift +glance_store/swift_store_multi_tenant swift +glance_store/swift_store_multiple_containers_seed swift +glance_store/swift_store_region swift +glance_store/swift_store_retry_get_count swift +glance_store/swift_store_service_type swift +glance_store/swift_store_ssl_compression swift +glance_store/swift_store_user swift glance_store/vmware_api_insecure vmware glance_store/vmware_api_retry_count vmware glance_store/vmware_datacenter_path vmware diff --git a/tools/autogenerate-config-flagmappings/heat.flagmappings b/tools/autogenerate-config-flagmappings/heat.flagmappings index ec3acebea5..76b2f90bd5 100644 --- a/tools/autogenerate-config-flagmappings/heat.flagmappings +++ b/tools/autogenerate-config-flagmappings/heat.flagmappings @@ -41,6 +41,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging max_events_per_stack quota max_json_body_size api max_nested_stack_depth quota @@ -50,6 +51,7 @@ max_template_size quota memcached_servers common notification_driver amqp notification_topics amqp +notification_transport_url amqp num_engine_workers api onready notification password common @@ -65,13 +67,15 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq -secure_proxy_ssl_header api stack_action_timeout api stack_domain_admin api stack_domain_admin_password api @@ -336,5 +340,7 @@ paste_deploy/flavor api profiler/profiler_enabled testing profiler/trace_sqlalchemy testing revision/heat_revision common +service_extension_cache/caching common +service_extension_cache/expiration_time common trustee/auth_plugin trustee trustee/auth_section trustee diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index a5572fb483..498656dae1 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -11,6 +11,7 @@ force_raw_images common grub_config_template common hash_distribution_replicas common hash_partition_exponent common +hash_ring_reset_interval common host common instance_format logging instance_uuid_format logging @@ -25,10 +26,12 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging memcached_servers common my_ip common notification_driver amqp notification_topics amqp +notification_transport_url amqp parallel_image_downloads common password redis pecan_debug debug @@ -44,11 +47,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq state_path common syslog_log_facility logging @@ -165,7 +171,9 @@ glance/swift_endpoint_url glance glance/swift_store_multiple_containers_seed glance glance/swift_temp_url_duration glance glance/swift_temp_url_key glance +glance/temp_url_endpoint_type glance iboot/max_retry iboot +iboot/reboot_delay iboot iboot/retry_interval iboot ilo/clean_priority_clear_secure_boot_keys ilo ilo/clean_priority_erase_devices ilo @@ -243,6 +251,12 @@ neutron/cleaning_network_uuid neutron neutron/retries neutron neutron/url neutron neutron/url_timeout neutron +oneview/allow_insecure_connections oneview +oneview/manager_url oneview +oneview/max_polling_attempts oneview +oneview/password oneview +oneview/tls_cacert_file oneview +oneview/username oneview oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc @@ -311,6 +325,7 @@ pxe/image_cache_size pxe pxe/image_cache_ttl pxe pxe/images_path pxe pxe/instance_master_path pxe +pxe/ip_version pxe pxe/ipxe_boot_script pxe pxe/ipxe_enabled pxe pxe/pxe_append_params pxe @@ -324,6 +339,9 @@ pxe/uefi_pxe_config_template pxe seamicro/action_timeout seamicro seamicro/max_retry seamicro snmp/power_timeout snmp +snmp/reboot_delay snmp +ssh/get_vm_name_attempts ssh +ssh/get_vm_name_retry_interval ssh ssh/libvirt_uri ssh swift/swift_max_retries swift virtualbox/port virtualbox diff --git a/tools/autogenerate-config-flagmappings/ironic.headers b/tools/autogenerate-config-flagmappings/ironic.headers index 4f6a99d9c7..d654c7ec8f 100644 --- a/tools/autogenerate-config-flagmappings/ironic.headers +++ b/tools/autogenerate-config-flagmappings/ironic.headers @@ -9,6 +9,7 @@ ilo iLO inspector inspector irmc iRMC keystone keystone +oneview OneView seamicro SeaMicro snmp SNMP ssh SSH diff --git a/tools/autogenerate-config-flagmappings/keystone.flagmappings b/tools/autogenerate-config-flagmappings/keystone.flagmappings index 831fc6569a..bf4a9dafa7 100644 --- a/tools/autogenerate-config-flagmappings/keystone.flagmappings +++ b/tools/autogenerate-config-flagmappings/keystone.flagmappings @@ -21,6 +21,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging max_param_size api max_project_tree_depth api max_token_size api @@ -30,6 +31,7 @@ memcached_servers common notification_driver amqp notification_format amqp notification_topics amqp +notification_transport_url amqp password redis port redis public_endpoint api @@ -43,11 +45,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq secure_proxy_ssl_header api standard_threads debug @@ -238,6 +243,7 @@ ldap/project_domain_id_attribute ldap ldap/project_enabled_attribute ldap ldap/project_enabled_emulation ldap ldap/project_enabled_emulation_dn ldap +ldap/project_enabled_emulation_use_group_config ldap ldap/project_filter ldap ldap/project_id_attribute ldap ldap/project_member_attribute ldap @@ -276,6 +282,7 @@ ldap/user_enabled_attribute ldap ldap/user_enabled_default ldap ldap/user_enabled_emulation ldap ldap/user_enabled_emulation_dn ldap +ldap/user_enabled_emulation_use_group_config ldap ldap/user_enabled_invert ldap ldap/user_enabled_mask ldap ldap/user_filter ldap diff --git a/tools/autogenerate-config-flagmappings/manila.flagmappings b/tools/autogenerate-config-flagmappings/manila.flagmappings index 399a452a78..438fc7565e 100644 --- a/tools/autogenerate-config-flagmappings/manila.flagmappings +++ b/tools/autogenerate-config-flagmappings/manila.flagmappings @@ -113,6 +113,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging manila_huawei_conf_file huawei manila_service_keypair_name share max_age quota @@ -152,6 +153,7 @@ netapp_vserver_name_template netapp network_config_group share notification_driver amqp notification_topics amqp +notification_transport_url amqp nova_admin_auth_url compute nova_admin_password compute nova_admin_tenant_name compute @@ -206,11 +208,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq scheduler_default_filters scheduler scheduler_default_weighers scheduler diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings index ea31518639..bf85bca04d 100644 --- a/tools/autogenerate-config-flagmappings/nova.flagmappings +++ b/tools/autogenerate-config-flagmappings/nova.flagmappings @@ -166,6 +166,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging max_age policy max_concurrent_builds compute max_concurrent_live_migrations livemigration @@ -202,6 +203,7 @@ neutron_default_tenant_id neutron non_inheritable_image_properties api notification_driver amqp notification_topics amqp +notification_transport_url amqp notify_api_faults common notify_on_state_change common novncproxy_host vnc @@ -276,11 +278,14 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq running_deleted_instance_action compute running_deleted_instance_poll_interval compute @@ -400,6 +405,7 @@ cells/db_check_interval cells cells/driver cells cells/enable cells cells/instance_update_num_instances cells +cells/instance_update_sync_database_limit cells cells/instance_updated_at_threshold cells cells/manager cells cells/max_hop_count cells @@ -718,7 +724,9 @@ spice/server_listen spice spice/server_proxyclient_address spice ssl/ca_file ca ssl/cert_file ca +ssl/ciphers ca ssl/key_file ca +ssl/version ca trusted_computing/attestation_api_url trustedcomputing trusted_computing/attestation_auth_blob trustedcomputing trusted_computing/attestation_auth_timeout trustedcomputing diff --git a/tools/autogenerate-config-flagmappings/sahara.flagmappings b/tools/autogenerate-config-flagmappings/sahara.flagmappings index 444e5778ce..81e3e495f5 100644 --- a/tools/autogenerate-config-flagmappings/sahara.flagmappings +++ b/tools/autogenerate-config-flagmappings/sahara.flagmappings @@ -34,7 +34,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging -max_header_line common +logging_user_identity_format logging memcached_servers common min_transient_cluster_active_time common node_domain common @@ -42,6 +42,7 @@ notification_driver amqp notification_level amqp notification_publisher_id amqp notification_topics amqp +notification_transport_url amqp os_region_name common password redis periodic_enable common @@ -62,12 +63,18 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq +ssh_timeout_common ssh +ssh_timeout_files ssh +ssh_timeout_interactive ssh swift_topology_file common syslog_log_facility logging transport_url amqp diff --git a/tools/autogenerate-config-flagmappings/sahara.headers b/tools/autogenerate-config-flagmappings/sahara.headers index d026002b77..e65654571c 100644 --- a/tools/autogenerate-config-flagmappings/sahara.headers +++ b/tools/autogenerate-config-flagmappings/sahara.headers @@ -1,2 +1,3 @@ domain domain object_store_access Auth options for Swift access for VM +ssh SSH diff --git a/tools/autogenerate-config-flagmappings/trove.flagmappings b/tools/autogenerate-config-flagmappings/trove.flagmappings index 39e876c3d6..093fef1785 100644 --- a/tools/autogenerate-config-flagmappings/trove.flagmappings +++ b/tools/autogenerate-config-flagmappings/trove.flagmappings @@ -77,8 +77,6 @@ http_get_rate api http_mgmt_post_rate api http_post_rate api http_put_rate api -ignore_dbs guestagent -ignore_users guestagent injected_config_location api instance_format logging instance_uuid_format logging @@ -93,11 +91,12 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +logging_user_identity_format logging max_accepted_volume_size quota -max_backups_per_user quota +max_backups_per_tenant quota max_header_line api -max_instances_per_user quota -max_volumes_per_user quota +max_instances_per_tenant quota +max_volumes_per_tenant quota memcached_servers common mount_options guestagent network_driver network @@ -108,6 +107,8 @@ neutron_url network notification_driver amqp notification_service_id amqp notification_topics amqp +notification_transport_url amqp +nova_client_version compute nova_compute_endpoint_type compute nova_compute_service_type compute nova_compute_url compute @@ -148,14 +149,18 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_bind_port_retries zeromq rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq +rpc_zmq_max_port zeromq +rpc_zmq_min_port zeromq rpc_zmq_topic_backlog zeromq server_delete_time_out taskmanager sql_query_logging database +state_change_poll_time taskmanager state_change_wait_time taskmanager storage_namespace guestagent storage_strategy guestagent @@ -204,6 +209,18 @@ cassandra/root_controller db_cassandra cassandra/tcp_ports db_cassandra cassandra/udp_ports db_cassandra cassandra/volume_support db_cassandra +cors/allow_credentials cors +cors/allow_headers cors +cors/allow_methods cors +cors/allowed_origin cors +cors/expose_headers cors +cors/max_age cors +cors.subdomain/allow_credentials cors +cors.subdomain/allow_headers cors +cors.subdomain/allow_methods cors +cors.subdomain/allowed_origin cors +cors.subdomain/expose_headers cors +cors.subdomain/max_age cors couchbase/backup_incremental_strategy db_couchbase couchbase/backup_namespace db_couchbase couchbase/backup_strategy db_couchbase @@ -286,6 +303,8 @@ mariadb/backup_incremental_strategy db_mariadb mariadb/backup_namespace db_mariadb mariadb/backup_strategy db_mariadb mariadb/device_path db_mariadb +mariadb/ignore_dbs db_mariadb +mariadb/ignore_users db_mariadb mariadb/mount_point db_mariadb mariadb/replication_namespace db_mariadb mariadb/replication_strategy db_mariadb @@ -325,6 +344,8 @@ mysql/backup_incremental_strategy db_mysql mysql/backup_namespace db_mysql mysql/backup_strategy db_mysql mysql/device_path db_mysql +mysql/ignore_dbs db_mysql +mysql/ignore_users db_mysql mysql/mount_point db_mysql mysql/replication_namespace db_mysql mysql/replication_strategy db_mysql @@ -391,10 +412,14 @@ oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_middleware/max_request_body_size api +oslo_middleware/secure_proxy_ssl_header api percona/backup_incremental_strategy db_percona percona/backup_namespace db_percona percona/backup_strategy db_percona percona/device_path db_percona +percona/ignore_dbs db_percona +percona/ignore_users db_percona percona/mount_point db_percona percona/replication_namespace db_percona percona/replication_password db_percona @@ -429,6 +454,7 @@ pxc/backup_strategy db_pxc pxc/cluster_support db_pxc pxc/device_path db_pxc pxc/guestagent_strategy db_pxc +pxc/ignore_dbs db_pxc pxc/ignore_users db_pxc pxc/min_cluster_member_count db_pxc pxc/mount_point db_pxc