X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fhow-to-use%2FLibraryUsage.rst;h=16cf4467beeb141d731e0e7f999cdea430f19514;hb=84d902632f1dd77f891c49cfb1d58af5ae051d1a;hp=9efb26f45f093f781d72ac9524eb49278e838b74;hpb=ce303377176f5a7588b61a0d90fda8cd535bde8d;p=snaps.git diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst index 9efb26f..16cf446 100644 --- a/docs/how-to-use/LibraryUsage.rst +++ b/docs/how-to-use/LibraryUsage.rst @@ -31,15 +31,23 @@ attributes are listed below: - project\_name (aka. tenant\_name) - identity\_api\_version (for obtaining Keystone authorization token. Versions 2.0 & v3 only validated.) -- image\_api\_version (Glance version 1 currently only validated) +- image\_api\_version (Glance version 1 & 2 only validated) - network\_api\_version (Neutron version 2 currently only validated) - compute\_api\_version (Nova version 2 currently only validated) +- heat\_api\_version (Heat version 1 currently only validated) - user\_domain\_id (default='default') +- user\_domain\_name (default='default') - project\_domain\_id (default='default') +- project\_domain\_name (default='default') +- interface (default='admin', used to specify the endpoint type for keystone: public, admin, internal) +- cacert (default=False, expected values T|F to denote server certificate verification, else value contains the path to an HTTPS certificate) +- region_name (The region name default=None) - proxy\_settings - host (the HTTP proxy host) - port (the HTTP proxy port) + - https\_host (the HTTPS proxy host, default value of host) + - https\_port (the HTTPS proxy port, default value of port) - ssh\_proxy\_cmd (same as the value placed into ssh -o ProxyCommand='')