summaryrefslogtreecommitdiff
path: root/doc/rtd
AgeCommit message (Collapse)Author
2017-05-03doc: document network configuration defaults policy and formats.Ryan Harper
Add documentation for cloud-init networking configuration formats, default behavior, policy and other specific details about how network config is consumed and utilized.
2017-04-21Doc: add additional RTD examplesJoshua Powers
Includes missing examples for RTD, including examples for datasources, disk partitions and apt update. Also fix doc in cloud-config-update-apt.txt. LP: #1459604
2017-04-12Fix examples that reference upstream chef repository.Jon Grimm
Also add integration test. Note: this new test is not comprehensive; it simply ensures that the example chef configuration does not blow up and that chef seems to be installed after its completion. This new test is disabled by default as it depends on a 3rd party repository. LP: #1678145
2017-04-12doc: correct grammar and improve clarity in merging documentation.David Tagatac
Move merging.rst into doc/rtd/topics with small fixes.
2017-04-12doc: Add missing doc link to snap-config module.Ryan Harper
2017-03-30doc: correct grammar in capabilities.rstDavid Tagatac
2017-03-17doc: fix config drive doc with regard to unpartitioned disks.Scott Moser
The ConfigDrive datasource has read un-partitioned disks for quite a while, but the documentation lagged behind. LP: #1673818
2017-03-13doc: add instructions for running integration tests via tox.Joshua Powers
Add instructions on how to run the cii tests to the docs.
2017-03-10Add feature flags to cloudinit.version.Wesley Wiedenmeier
This exposes a mechanism for users of cloud-init to determine if a version has a specific feature, and adds documentation to that affect. We list an existing feature NETWORK_CONFIG_V1 as an example. Also add a 'features' subcommand for listing these to stdout.
2017-01-26Fix small typo and change iso-filename for consistencyRobin Naundorf
* Fix small typo * Fix ISO-Filename for consistency
2017-01-17doc: Fix typos and clarify some aspects of the part-handlerErik M. Bray
The existing documentation referred to a handle_type method when it really should be handle_part. It also referred to 'methods' when it really should say 'functions' to be clear (while it's true the built-in handlers are classes with methods of these names, in this context we mean module-level functions). Also clarified that a part-handler should come before the parts that it handles, and can override built-in handlers.
2017-01-17doc: add some documentation on OpenStack datasource.Scott Moser
This just fills out some of the documentation on the OpenStack datasource.
2016-12-23doc: adjust headers in tests documentation for consistency.Scott Moser
This just makes headers in doc/rtd/topics/tests.rst consistent with other rst files, as the comment in doc/rtd/index.rst suggests.
2016-12-22integration test: initial commit of integration test frameworkWesley Wiedenmeier
The adds in end-to-end testing of cloud-init. The framework utilizes LXD and cloud images as a backend to test user-data passed in. Arbitrary data is then captured from predefined commands specified by the user. After collection, data verification is completed by running a series of Python unit tests against the collected data. Currently only the Ubuntu Trusty, Xenial, Yakkety, and Zesty releases are supported. Test cases for 50% of the modules is complete and available. Additionally a Read the Docs file was created to guide test writing and execution.
2016-11-22Doc: various documentation fixesSean Bright
Several various minor fixes for the readthedocs documentation.
2016-11-10doc: Add documentation on stages of boot.Scott Moser
This adds long overdue documentation on stages that cloud-init runs during boot.
2016-11-10doc: make the RST files consistently formated and other improvements.Scott Moser
The biggest things here are: * move doc/sources/*/README.rst to doc/rtd/topics/datasources This gives each datasource a page in the rtd docs, which make it easier to read. * consistently use the same header style throughout. As suggested at http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html use: # with overline, for parts * with overline, for chapters =, for sections -, for subsections ^, for subsubsections “, for paragraphs Also, move and re-format vendor-data documentation to rtd.
2016-10-20Add documentation for logging features.Wesley Wiedenmeier
Update the summary of rsyslog module and add logging.rst to docs.
2016-09-30Improve module documentation and doc cleanup.Wesley Wiedenmeier
This adds lots of config module documentation in a standard format. It will greatly improve the content at readthedocs. Additionally: * Add a 'doc' env to tox.ini * Changed default highlight language for sphinx conf from python to yaml most examples in documentation are yaml configs * Updated datasource examples to highlight sh code properly
2016-05-20Update merging documentation to make its application clearerDaniel Watkins
Currently, some users think that user-data and conf.d configuration will be merged together[0]. This has never been the case, and we should make it clear that this is not currently supported to avoid user confusion. [0] https://bugs.launchpad.net/cloud-init/+bug/1532234
2015-11-14use the Ubuntu font, when possible, in the documentationDustin Kirkland
2015-11-14resize to match the rtd widthDustin Kirkland
2015-11-14replaced old logos with new logosDustin Kirkland
2015-06-01Doc: include information on vendor-data in OpenStackScott Moser
2015-04-03Initial CloudStack Documentation.Pierre-Luc Dion
2015-04-01Add documentation about OpenStack vendor data handling.Daniel Watkins
2015-01-06tools/run-pep8: remove leading ',' fed to --ignoreScott Moser
--ignore was being called with ',E121,E...' rather than 'E121,E...'. that resulted in odd behavior, missing the pep8 errors that are fixed here.
2014-11-21Ensure the cc_chef doc links to the cc_chef codeJoshua Harlow
2014-10-23Show the handle method for the cc_ubuntu_init_switch moduleJoshua Harlow
2014-10-23Use bold for the internal nameJoshua Harlow
2014-10-23Add a link to the module codeJoshua Harlow
2014-10-23Add the beginnings of module documentationJoshua Harlow
2014-01-24pep8/pylint fixesScott Moser
tools/run-pep8 wasn't checking all python files. tools/run-pylint wasnt checking bin/cloud-init fixed resultant pep8 issues after finding them.
2014-01-17more boto removal. move httpretty from 'Requires'Scott Moser
the Requires would get that string rendered into the package's Depends/Requires (rather than BuildDepends/BuildRequires). We should have BuildDepends/BuildRequires too, but since trunk's package builds do not run 'make test', this isn't a big deal. This also adds 'test-requires' for httpretty.
2013-09-05Merged trunk lp:cloud-initVlastimil Holer
2013-05-16remove executable on logo.svgScott Moser
2013-03-08Enable the merging.txt to be in .rst format for public viewingJoshua Harlow
2013-03-07pep8 and pylint fixesScott Moser
2013-02-20Add OpenNebula DS on list of datasources.Vlastimil Holer
2013-02-05Continue adding datasource docs.harlowja
Add a base set for ec2 and datasource none.
2013-02-04Add initial docs about datasources.harlowja
Start moving the current README for datasources to a RST format and include those files in the rtd site. LP: #1113650
2013-01-28Include the resolv.conf example.Joshua Harlow
2013-01-25Don't forget the hacking 'inclusion' file.Joshua Harlow
2013-01-25Integreate HACKING into the rtd site.Joshua Harlow
2013-01-24Remove the release for now.harlowja
2013-01-24Fix the release variable.harlowja
2013-01-24Make the logo better.harlowja
2013-01-24Add docs which can be used on readthedocs.orgJoshua Harlow
Include a new set of docs that can be used to create a readthedocs.org site, which includes examples, directory layout, capabilities and such. This in-code documentation then allows for readthedocs.org to create a website directly from the cloud-init codebase.