summaryrefslogtreecommitdiff
path: root/doc/sources
AgeCommit message (Collapse)Author
2022-02-02spell check docs with spellintian (#1223)Brett Holman
Fix spelling errors - Add Makefile target that checks for spelling errors - Add Makefile target that fixes spelling errors - Add spelling check to travis doc tests - Fix various spelling errors in the docs
2022-01-18Enable OVF environment transport via ISO in example (#1195)Megian
This enables the OVF enviroment transport via ISO variable as defined in the Open Virtualization Format Specification Version: 2.1.1. 8.1 VirtualHardwareSection 11.1 Transport media Co-authored-by: Gabriel Mainberger <gabriel.mainberger@vshn.net>
2022-01-18Add DatasourceOVF network-config propery to Ubuntu OVF example (#1184)Megian
Cloud-init includes the capability to take the network-config from a separate key. This removes the need to merge the network config in the user-data and make it more transparent in some cases. Reference: https://github.com/canonical/cloud-init/blob/42b938e8ff4c50833ff7b8f5acc1d9ab3f43ab18/cloudinit/sources/DataSourceOVF.py#L557
2021-10-18VMware: read network-config from ISO (#1066)Thomas Weißschuh
There is no reason for the ISO missing this functionality. As discussed in https://github.com/canonical/cloud-init/pull/947/files#r707338489
2021-07-20VMware: add network-config support in ovf-env.xml (#947)PengpengSun
Details: 1. Support guest set network config through guestinfo.ovfEnv using OVF 2. 'network-config' Property is optional 3. 'network-config' Property's value has to be base64 encoded Added unittests and updated ovf-env.xml example
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-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-08-22azure dhclient-hook cleanupsScott Moser
This adds some function to the generator to maintain the presense of a flag file '/run/cloud-init/enabled' indicating that cloud-init is enabled. Then, only run the dhclient hooks if on Azure and cloud-init is enabled. The test for is_azure currently only checks to see that the board vendor is Microsoft, not actually that we are on azure. Running should not be harmful anywhere, other than slowing down dhclient. The value of this additional code is that then dhclient having run does not task the system with the load of cloud-init. Additionally, some changes to config are done here. * rename 'dhclient_leases' to 'dhclient_lease_file' * move that to the datasource config (datasource/Azure/dhclient_lease_file) Also, it removes the config in config/cloud.cfg that set agent_command to __builtin__. This means that by default cloud-init still needs the agent installed. The suggested follow-on improvement is to use __builtin__ if there is no walinux-agent installed.
2016-08-15Get Azure endpoint server from DHCP clientBrent Baude
It is more efficient and cross-distribution safe to use the hooks function from dhclient to obtain the Azure endpoint server (DHCP option 245). This is done by providing shell scritps that are called by the hooks infrastructure of both dhclient and NetworkManager. The hooks then invoke 'cloud-init dhclient-hook' that maintains json data with the dhclient options in /run/cloud-init/dhclient.hooks/<interface>.json . The azure helper then pulls the value from /run/cloud-init/dhclient.hooks/<interface>.json file(s). If that file does not exist or the value is not present, it will then fall back to the original method of scraping the dhcp client lease file.
2015-12-17doc/sources/nocloud: document the volume label requirementPeter Hurley
document that vfat and iso9660 filesystems must have 'cidata' volume label to be recognized as a potential NoCloud data source.
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
2014-10-17Add documentation for DigitalOcean datasourceNeal Shrader
2014-09-27Fix link for config_drive docThomas Bechtold
The current link does no longer work.
2014-02-19Read encoded with base64 user dataKiril Vladimiroff
This allows users of CloudSigma's VM to encode their user data with base64. In order to do that thet have to add the ``cloudinit-user-data`` field to the ``base64_fields``. The latter is a comma-separated field with all the meta fields whit base64 encoded values.
2014-02-13cloudsigma: change default dsmode to 'net'Scott Moser
Previously this had 'local' as the default datasource mode, meaning that user-data code such as boot hooks and such would not be guaranteed to have network access. That would be out of sync with the expectation on other platforms where the default is 'network up'. The user can still specify 'dsmode' as local if necessary and the local datasource will claim itself found.
2014-02-12Add CloudSigma data sourceKiril Vladimiroff
2014-01-24Fixes for SmartOS datasource (LP: #1272115):Ben Howard
1. fixed conflation of user-data and cloud-init user-data. Cloud-init user-data is now namespaced as 'cloud-init:user-data'. 2. user-scripts are now fetched from the meta-data service each boot and executed as in the scripts directory 3. datacenter name is now namespaced as sdc:datacenter 4. user-scripts should be shebanged if there is no file magic
2013-09-27fix doc for smartosScott Moser
2013-09-19Fixes for the MP.Ben Howard
Changed cc_disk_setup to handle the file systems as a label, no longer passing "log" around. Tidied up the documentation to reflect the changes and made grammer, spelling and improved the content a little. Added disk_setup to the default modules list.
2013-09-10Update OpenNebula documentation (parseuser, more fs. labels, K-V single quotes)Vlastimil Holer
2013-09-05Merged trunk lp:cloud-initVlastimil Holer
2013-08-24changes to behavior on specifying keys.Scott Moser
The most likely end user operation (or at least a valid one) for base64 encoding would be to encode the user-data, but leave all other values as plaintext. In order to facilitate that, the user can simply add: b64-user-data=true to indicate that user-data is base64 encoded. Other changes here are to change the cloud-config and metadata keynames that are used. base64_all = boolean(True) base64_keys = [list, of, keys] Fixed up tests to accomodate.
2013-08-23Fixed some typos. Change decode_base64 from sys_cfg to ds_cfgBen Howard
2013-08-20Fixed no_base64_decode settingsBen Howard
2013-07-30Added base64 support to SmartOS datasource.Ben Howard
Added documentation on SmartOS datasource.
2013-07-25azure: support bouncing interfaces to publish new hostnameScott Moser
See the added doc/sources/azure/README.rst for why this is necessary. Essentially, we now are doing the following in the get_data() method of azure datasource to publish this NewHostname: hostname NewHostName ifdown eth0; ifup eth0 LP: #1202758
2013-02-21Example cloud.cfgVlastimil Holer
2013-02-20OpenNebula documentation tuning.Vlastimil Holer
2013-02-20OpenNebula datasource documentation update.Vlastimil Holer
2013-02-19Merged trunk lp:cloud-initVlastimil Holer
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
2012-10-03Minor OpenNebula's documentation tuning.Vlastimil Holer
2012-10-03Add documentation for OpenNebula datasource.Vlastimil Holer
2012-08-14doc: move datasource documentation to doc/sourcesScott Moser
Each datasource had a bit of doc with it, and those were just landing in doc/. I've moved them to doc/sources now.