summaryrefslogtreecommitdiff
path: root/README.rst
Commit message (Collapse)AuthorAgeFilesLines
* Add release note link in READMEqingszhao2018-06-271-0/+1
| | | | Change-Id: I99081cdfde928bc4089e1bdc40eae1bd50082bc2
* Update links in READMEXiaojueGuan2018-06-121-2/+2
| | | | | | Change the outdated links to the latest links in README Change-Id: Ia3480724d5db282ab71e1b9940b9ef2d871e2f44
* Replace guts with openstack.config1.31.0Monty Taylor2018-04-271-0/+7
| | | | | | | | | | | | | | | | | | | The code has been moved into openstacksdk. Make os-client-config a thin wrapper around that code. The legacy client code needs to stay, as it was removed in openstacksdk. We also have to plumb os_client_config.defaults and os_client_config.cloud_region.CloudRegion in so that users get the os-client-config versions from the openstacksdk methods that return the relevant objects. Support for per-service region_name has been dropped. This was never used anywhere and was added for compatibility with openstacksdk Profile objects. Since Profile objects are no more, we can remove it. It never made any sense. Change-Id: I7180e20aa675c0ccbe3718493a6eff2be7e1b8b6
* rearrange existing documentation to follow the new standard layoutDoug Hellmann2017-06-221-480/+1
| | | | | | Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: Ib68812eda4ab0ce09c6d438f9f236111d61ef38b Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* fix location of team tags in READMEDoug Hellmann2017-01-311-9/+3
| | | | | | | | | Remove the extraneous title markup and move the team tag include instructions below the main project title in the readme so it renders more nicely. Change-Id: Icd384c81a455a3e1a86abd1f2ef84e775e06c307 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Show team and repo badges on READMEFlavio Percoco2016-11-261-0/+9
| | | | | | | | | | | | | | | | This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/0bed66f234ed59d0c6e2aa220e709950 Change-Id: I80c57e310b601d47be5b5f81c604d7d6310a60eb
* Clarify how to set SSL settingsCedric Brandily2016-10-201-0/+13
| | | | | | | This change adds an example in order to clarif how to SSL settings in configuration files. Change-Id: Id047f21d0a51752f46b16e3f4efbfec62cfbd5fb
* Reword the entries in the README a bitMonty Taylor2016-06-021-5/+6
| | | | | | | Wanted to make each section a little better, but also to start to indicate that legacy clients should really not be your first choice. Change-Id: I26e08d037c7b28ced22a2a0126693d7e3e779f58
* Add shade constructor helper methodMonty Taylor2016-06-021-0/+33
| | | | | | | | | We have helper factory methods for REST Client, legacy client and OpenStack SDK all with the same interface ... we might as well have one for shade too. It makes documenting and talking about the simple case of all of them easy. Change-Id: I046da85ae4a3e2a6333223921d5ae9ce3673121d
* Rename session_client to make_rest_clientMonty Taylor2016-06-011-17/+17
| | | | | | | | | | While writing some docs, it became clear that session_client was just a horrible horrible name and that I'm a bad person. Rename it so that we can make docs that make humans happy. Also, move the REST client section of the README up a bit. Change-Id: I1a27853e3031489da5916308a76f19bc72185d24
* Add helper method for OpenStack SDK constructorMonty Taylor2016-06-011-0/+37
| | | | | | | | openstacksdk already has a helper method for dealing with occ, but if a user is already using the occ helper methods, there is no reason we should not provide them an easy path to using the SDK. Change-Id: I1040efb94385fdac0aa02ac960ba95089b954377
* Fix formatting in readme fileIlya Shakhat2016-04-221-0/+2
| | | | Change-Id: Ifa37d38b3c7689f703c7129459b15a367e2aafff
* Flesh out netowrk config listMonty Taylor2016-04-021-1/+1
| | | | | | | | Add support for indicating default_interface. Also, add some validation and normalization code, some interface methods and, shockingly, documentation. Change-Id: Ib45b68894585ac02821d5d2376510fd7a8e8ee40
* Change network info indication to a generic listMonty Taylor2016-03-301-4/+8
| | | | | | | | | | | Networks can have more information than just internal or external. Notably, if you have two private networks and you're trying to assign floating ips, you need to know which network should be the recipient. This should be backwards compatible with existing external_network and internal_network options. Change-Id: I0d469339ba00486683fcd3ce2995002fa0a576d1
* Update the README a bit1.16.0Monty Taylor2016-02-221-20/+27
| | | | | | | Cleaned up example references to now-not-existing HP Public Cloud. Also added a named-cloud entry to the make_client section. Change-Id: I398c438e22eb84d6079a5c45f068753c3bcaa216
* Allow session_client to take the same args as make_clientMonty Taylor2016-02-221-2/+15
| | | | | | | | | | | | | | | make_client is a great, simple yet flexible way to get a fully featured Client object. simple_client is similar for Session objects, but lacks the argparse and arbitrary kwargs that make_client - plus it has a weird name. Since adding those two features to make_client did not make it too confusing - do the same for simple_client. Also, rename it to session_client (with a backwards-compat alias) and add it to the README docs. In the process of doing this, extract the "get me a cloud config" functinality into an additional helper function - get_config. Change-Id: Iadd24dfa021f870b3e5858bab8cd91fc96a373c2
* Fix README.rst, add a check for it to fit PyPI rulesYuriy Taraday2015-12-311-1/+1
| | | | | | | | | | README.rst doesn't appear right on PyPI currently. This commit fixes the issue and expands "docs" environment in tox.ini to use readme tool [0] to verify that README.rst is good for PyPI. [0] https://github.com/pypa/readme Change-Id: I6025bb6c661d8a4a7cd9802a1298928662278f2d
* add URLs for release announcement toolsDoug Hellmann2015-12-301-0/+8
| | | | | | | | | | The release announcement scripts expects to find URLs for the bug tracker, documentation, etc. by looking for patterns in the README.rst file. This change adds the URLs in a format consistent with other OpenStack projects and that works with the release announcement generator. Change-Id: I88151008cca91da3fed7e4c0ec6dfb641a0062b6
* Fix some README typosTim Burke2015-12-281-4/+4
| | | | Change-Id: I3ebec661d1b02da0c940cde63ab862871dca11c5
* Add support for generalized per-region settingsMonty Taylor2015-12-071-0/+32
| | | | | | | | | | Internap creates a public and a private network for each customer for each region on region activation. This means there is a per-region external network that the user may want to specify. Also, conoha has per-region auth-urls. Per-region config is still overridden by argparse or kwargs values. Change-Id: Ie2f3d2ca3ccbe7e3dd674983136b42c323544997
* Merge "Fix a README typo - hepler is not actually a thing"Jenkins2015-12-071-1/+1
|\
| * Fix a README typo - hepler is not actually a thingMonty Taylor2015-12-071-1/+1
| | | | | | | | Change-Id: Ie8c267e75171b88bd3a1a3a684e85869e75843d7
* | Merge "Make client constructor optional"Jenkins2015-12-071-5/+4
|\ \ | |/
| * Make client constructor optionalMonty Taylor2015-12-071-5/+4
| | | | | | | | | | | | | | | | | | Turns out we know the mapping of service name to constsructor, so we can try the import for the user without actually importing. Keep the argument though, because this method should be usable by just about any random openstack client lib. Also, because backwards compat. Change-Id: I7e9672e3bf61b8b7b92d55903f4596382f18b515
* | Updated README to clarify legacy client usageMonty Taylor2015-12-061-14/+14
|/ | | | | | Also, update it to use code-block - which makes things look much nicer. Change-Id: I930ab63a5d159cf4cea27b4e2c4d6fd933de04fc
* Add simple helper function for client constructionMonty Taylor2015-12-071-0/+31
| | | | | | | | Often times you don't want to take advantage of all the flexibility, you simple want the basic works-like-it-should thing. Add a warpper around get_legacy_client to do tht one thing. Change-Id: I086dc4a8e762d4e8e56e01cabe2386577f2ceec8
* Add method for registering argparse optionsMonty Taylor2015-12-061-0/+23
| | | | | | | | | | | | | keystoneauth knows about a bunch of argparse options that users from a command line will want. We do a good job of processing them once they've been collected, but an os-client-config user doesn't have a great way to make sure that they register all of the options, especially when once considers that you really want to peek at the args to see which auth plugin has been selected so that the right arguments can be registered and displayed. Depends-On: Ifea90b981044009c3642b268dd639a703df1ef05 Change-Id: Ic196f65f89b3ccf92ebec39564f5eaefe8a4ae4b
* Add support for secure.yaml file for auth infoMonty Taylor2015-11-221-0/+28
| | | | | | | | | | | | | | | Almost nothing in clouds.yaml is secret, but the file has to be treated as if it were because of the passwords or other secrets contained in it. This makes it difficult to put clouds.yaml into a public or broadly accessible config repository. Add support for having a second optional file, secure.yaml, which can contain any value you can put in clouds.yaml and which will be overlayed on top of clouds.yaml values. Most people probably do not need this, but for folks with complex cloud configs with teams of people working on them, this reduces the amount of things that have to be managed by the privileged system. Change-Id: I631d826588b0a0b1f36244caa7982dd42d9eb498
* Clean up cache interface, add support for services1.9.0Monty Taylor2015-10-171-2/+11
| | | | | | | | | | | | | | | We just added an unreleased interface method to the CloudConfig object - but maybe that should have been more aligned with dogpile words. SO - change the docs to reference the dogpile words and add support for that, while keeping backwards compat support for people using max_age. Also, do the -/_ transform on the cache config like elsewhere. Then, while we're in there, add support for per-service cache timings. We need this in nodepool and shade is adding support, so ability to configure it will be important. Change-Id: I31190a31ab0b79fc080db3611c0cd584076387d4
* Fix documentation around regionsMonty Taylor2015-10-141-1/+1
| | | | | | | It turns out region_name is an important parameter - it's not just another kwarg that will get passed through. Change-Id: I5cca8d324a1dcd1355991df793fe29eedfa15dc0
* Fix two typosMonty Taylor2015-10-011-2/+2
| | | | Change-Id: Idf3df94ea039f07fa958a3afadf3388221ffa2ff
* Support passing force_ipv4 to the constructorMonty Taylor2015-10-011-8/+10
| | | | | | | | | IPv6 support is detectable, so rather than having a user opt-in to it, provide a flag that can be provided to tell it that detected IPv6 support is lying. This should have to be set for far fewer people and should result in transparent opt-in to IPv6 where available. Change-Id: Ib0c4c4e8b3b7b4bcee5fa3414719969274929b9a
* update RST for readme so pypi looks prettySteve Martinelli2015-09-221-3/+9
| | | | | | | | Navigating to https://pypi.python.org/pypi/os-client-config results in seeing the raw RST content of the readme file. This is likely caused by minor RST warnings, but pypi gives up and shows it raw. Change-Id: Ia2d6202ade5282d9aeae9bb948175aae2aa264cd
* Merge "Specify the config file with environment variable"Jenkins2015-07-111-0/+4
|\
| * Specify the config file with environment variableMonty Taylor2015-07-091-0/+4
| | | | | | | | | | | | | | | | | | | | The fine folks at ansible want to be able to specify a specific location for the config file with an env var which seems like a perfectly reasonable thing to allow. Inject the specified file at the beginning of the list so that it'll be the first one found. Change-Id: Ib1947be1c0ae812e9cb83c7b99168c05dfc6fa6a Co-authored-by: Chris Church <chris@ninemoreminutes.com>
* | Merge "Add support for configuring region lists with yaml"Jenkins2015-07-111-2/+5
|\ \ | |/
| * Add support for configuring region lists with yamlMonty Taylor2015-07-091-2/+5
| | | | | | | | | | | | | | | | | | | | yaml supports encoding lists in a manner that is cleaner than comma separated lists. While the old commas-in-region_name will still work, add a 'regions' option that can be used to configure lists of regions. Remove the comma-separated-list from the docs so that people don't try to use it - even though it will work. Change-Id: Ieb0aedb9c03fd26e644e9ba733b935f2c69daaf0
* | Fix rendering issue in ReadmeSpencer Krum2015-07-081-0/+1
|/ | | | Change-Id: If089b0331c6b40e983d81623ee3a6a541f93a45a
* Add support for indicating preference for IPv6Monty Taylor2015-06-261-0/+31
| | | | | | | | People, such as Infra, would like to use IPv6 when it's there, but don't want to need to write the "if ipv6, awesome, else, ipv4" code all the time. Change-Id: I870955863f1e8851c684dc604584c1ef3e20dd6b
* Some cleanup in the README.rstGhe Rivero2015-06-061-18/+19
| | | | Change-Id: I9f7c6c727708a9095566bce8d4ff03837be95d07
* Add SSL documentation to README.rstGhe Rivero2015-06-051-0/+14
| | | | | | | Explain usage and warn avoid behavior with conflicting cacert and verify options. Change-Id: I25b43ba47bd0feb941b649265c6e67723a93e277
* Add cloud vendor files config in docGhe Rivero2015-06-041-2/+4
| | | | | | | Although it is possible to include specific config files for unknown vendors, this wasn't specified in the documentation. Change-Id: Ib27277d480e373a8a083e820161e0bdb985de284
* Rename cloud to profileMonty Taylor2015-05-271-8/+8
| | | | | | | | | | | The cloud parameter was confusing people, especially since it was inside of a dict that was named "clouds". profile was suggested as less confusing, which seems fine. Continue processing cloud as a parameter so that we don't break anyway, but change the docs to only mention profile. Change-Id: Idf3d089703985ecc60f23a3c780ddcab914aa678
* Use appdirs for platform-independent locationsMonty Taylor2015-05-121-0/+22
| | | | | | | | Cache, data and config files live rooted in different places across different OS's. Use appdirs to find where. Depends-On: Ic939dea11b7476ec504d2bf65854a0781b1bfb39 Change-Id: I7338ae1d0442e0c5cc1ec4ae4d619fac319a4a28
* Only add fall through cloud as a fall throughMonty Taylor2015-05-121-4/+8
| | | | | | | | | | | | | | We only want do define the 'openstack' cloud if there are neither environment varaibles nor config files. We need to define it as a place to put passed-in-parameters in the case of neither, but we don't want it any other time. The behavior can now be described as: - If you have a config file, you will get the clouds listed in it - If you have environment variable, you will get a cloud named 'envvars' - If you have neither, you will get a cloud named 'defaults' Change-Id: I6752c1ccecf1ef979b2603246eeaab7da360c8a4
* Remove crufty lines from READMEMonty Taylor2015-05-021-3/+0
| | | | Change-Id: Ibf36a67503aab5f3bcd3ba535da5f9f54ce9c28d
* Allow overriding envvars as the name of the cloudMonty Taylor2015-04-111-1/+2
| | | | | | | | | | For environment variables created cloud objects, it's possible someone may not want it to be called envvars. I mean, let's be honest, I cannot imagine why this would be important ... but people get emotional about things. Let them name their cloud "bunnyrabbit" because that makes people happy. Change-Id: I0c232de7d93080ea632fb66a82b9e6d3e925c901
* Put env vars into their own cloud configMonty Taylor2015-04-111-6/+9
| | | | | | | | | | | | | | | | The semantics around mixing environment variables and config file values are confusing at best and no reasonable usecase has been expressed as to why doing so is desirable. Move the logic around environment variable processing to always provide an "envvars" cloud if any envvars are set. The cloud will only exist in the presence of OS_ env vars. get_one_cloud() will default to returning the envvars cloud if it exists. Change-Id: I6c3a54997c3278feedfdf93cc4d1e74b6235700a Closes-Bug: #1439927
* Change dogpile cache defaultsMonty Taylor2015-03-131-3/+11
| | | | | | | | | | | Memory cache can grow unbounded, so it should really be opt in. Change to match shade with the following defaults: - If you specify nothing, you get null cache - If you specify an expiration time and nothing else, you get memory cache - If you specify an explicit cache class, you will get that class Change-Id: I6c9eab71a88a534de7e52ad2a564450c44aacc1d
* Merge "Support keystone auth plugins in a generic way."Jenkins2015-01-211-13/+29
|\
View Lorry Controller Status