summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2020-01-16docs: add proposed SRU testing procedure (#167)Chad Smith
Co-Authored-By: Daniel Watkins <daniel@daniel-watkins.co.uk>
2020-01-06doc: make apt_update example consistent (#154)Daniel Watkins
Other options near it use the non-default value, so the inconsistency has lead to confusion for readers.
2020-01-06doc: add modules page toc with links (#153)Chad Smith
LP: #1852456
2019-12-20modules: drop cc_snap_config config module (#134)Chad Smith
cloud-init has moved to cc_snap module and a top-level config key 'snap'. cc_snap_config was deprecated in cloud-init version 18.2 Co-authored-by: Daniel Watkins <daniel@daniel-watkins.co.uk>
2019-12-20docs: add initial troubleshooting to FAQ (#104)Joshua Powers
docs: add initial troubleshooting to FAQ
2019-12-20freebsd: introduce the freebsd renderer (#61)Gonéri Le Bouder
* freebsd: introduce the freebsd renderer Refactoring of the FreeBSD code base to provide a real network renderer for FreeBSD. Use the generic update_sysconfig_file() from rhel_util to handle the access to /etc/rc.conf. Interfaces are not automatically renamed by FreeBSD using the following configuration in /etc/rc.conf: ``` ifconfig_fxp0_name="eth0" ``` * freesd: use regex named groups Reduce the complexity of `get_interfaces_by_mac_on_freebsd()` with named groups. * freebsd: breaks up _write_network() in tree small functions - `_write_ifconfig_entries()` - `_write_route_entries()` - `_write_resolve_conf()` * extend find_fallback_nic() to support FreeBSD this uses `route -n show default` to find the default interface * freebsd: use dns keys from NetworkState class The NetworkState class (settings instance) exposes the DNS configuration in two keys: - `dns_nameservers` - `dns_searchdomains` On OpenStack, these keys are set when a global DNS server is set. The alternative is the `dns_nameservers` and `dns_search` keys from each subdomain. We continue to read those. * freebsd: properly target the /etc/resolv.conf file * freebsd: ignore 'service routing restart' ret code On FreeBSD 10, the restart of routing and dhclient is likely to fail because - routing: it cannot remove the loopback route, but it will still set up the default route as expected. - dhclient: it cannot stop the dhclient started by the netif service. In both case, the situation is ok, and we can proceed. * freebsd: handle case when metadata MAC local locally Handle the case where the metadata configuration comes with a MAC that does not exist locally. See: - https://github.com/canonical/cloud-init/pull/61/files/635ce14b3153934ba1041be48b7245062f21e960#r359600604 - https://github.com/canonical/cloud-init/pull/61/files/635ce14b3153934ba1041be48b7245062f21e960#r359600966 * freebsd: show up a warning if several subnet found The FreeBSD provider currently only allow one subnet per interface. * freebsd: honor the target parameter in _write_network * freebsd: log when a bad route is found * freebsd: pass _postcmds to start_services() * freebsd: updatercconf() is depercated Replace `updatercconf()` by `rhel_util.update_sysconfig_file()`. * freebsd: ensure gateway is ipv4 before using it With the legacy ENI format, an IPv6 gateway may be pushed. This instead of the expected IPv4. * freebsd: find_fallback_nic, support FB10 On FreeBSD <= 10, `ifconfig -l` ignores the down interfaces. * freebsd: use util.target_path() to load resolv.conf Ensure we access `/etc/resolv.conf`, not `etc/resolv.conf`. * freebsd: skip subnet without netmask Those are likely to be either invalid of in IPv6 format. IPv6 support will be addressed later in a new patchset. * freebsd: get_devicelist returns netif list Ensure `get_devicelist()` returns the list of known netif on FreeBSD. * replace rhel_util.update_sysconfig_file wrapper call, with a wrapper function * reverse if condition to remove an indent Co-authored-by: Igor Galić <me+github@igalic.co>
2019-12-19cc_snappy: remove deprecated module (#127)Daniel Watkins
* cc_snappy: remove deprecated module * cloud_tests: remove cc_snappy tests (and references) This module was deprecated in favor of cc_snap in cloud-init v.18.2
2019-12-18cloud-init: fix capitalisation of SSH (#126)Daniel Watkins
* cc_ssh: fix capitalisation of SSH * doc: fix capitalisation of SSH * cc_keys_to_console: fix capitalisation of SSH * ssh_util: fix capitalisation of SSH * DataSourceIBMCloud: fix capitalisation of SSH * DataSourceAzure: fix capitalisation of SSH * cs_utils: fix capitalisation of SSH * distros/__init__: fix capitalisation of SSH * cc_set_passwords: fix capitalisation of SSH * cc_ssh_import_id: fix capitalisation of SSH * cc_users_groups: fix capitalisation of SSH * cc_ssh_authkey_fingerprints: fix capitalisation of SSH
2019-12-18docs: Updating index of datasourcesAdam Dobrawy
- Added RbxCloud - Sorted alphabetically
2019-12-18docs: Fix anchor of datasource_rbxAdam Dobrawy
2019-12-13docs: clear up apt config sections (#107)Joshua Powers
More clearly differentiate between the primary apt repo configuration and any 3rd party apt configuration. LP: #1832823
2019-12-13doc: add kernel command line option to user data (#105)Joshua Powers
LP: #1846524
2019-12-11docs: add cloud-id manpageJoshua Powers
2019-12-11docs: add cloud-init-per manpageJoshua Powers
2019-12-11docs: add cloud-init manpageJoshua Powers
2019-12-09one moreJoshua Powers
2019-12-09Address OddBloke reviewJoshua Powers
2019-12-06docs: Add document on how to report bugsJoshua Powers
2019-12-06docs: fix line length and remove highlightingJoshua Powers
doc8 does not know about the ephasize-lines portion of code-block and throws an error. As this is the only place right now I am going to remove it untill we can find a better solution. rstcheck and restructuredtext-lint have issues with sphinx declaritives, so doc8 is still the best to use for now.
2019-12-06docs: Add security.md to readthedocsJoshua Powers
* docs: Add security.md to readthedocs This enables the ability to show the security policy on both GitHub and on the readthedocs site. To do this, enable the ability to import Markdown based files and translate them to rst. * Add doc-requirements.txt and update tox to use Also removes the extra, uncessary extension addition of .md
2019-11-26cloud_tests: add azure platform support to integration testsahosmanmsft
Added Azure to cloud tests supporting upstream integration testing. Implement the inherited platform classes, Azure configurations to release/platform, and docs on how to run Azure CI.
2019-11-20docs: Update the configdrive datasource links (#44)Joshua Powers
Update ConfigDrive datasource documentation to point to the most recent OpenStack documentation for ConfigDrive. LP: #1852461
2019-11-07docs: touchups in rtd intro and README.mdChad Smith
- rtd/index.rst: update sentence to read:   cloud-init will also parse and process any optional user data - rtd/topics/datasources/rbxcloud.rst: fix rst link names to build docs - README.md:   - update travis badge url to project home: github/canonical/cloud-init   - update page title to:     Cloud-init official project upstream as of 11/2019
2019-11-07doc: update launchpad git refs to githubRyan Harper
2019-10-31Add config for ssh-key import and consuming user-dataPavel Zakharov
This patch enables control over SSH public-key import and discarding supplied user-data (both disabled by default). allow-userdata: false ssh: allow_public_ssh_keys: false This feature enables closed appliances to prevent customers from unintentionally breaking the appliance which were not designed for user interaction. The downstream change for this is here: https://github.com/delphix/cloud-init/pull/4
2019-10-23docs: Fix incorrect Azure IMDS IP addressJoshua Powers
The Azure datasource was incorrectly listing the IP address. This updates the address to match what is in the Azure provided IMDS documentation. LP: #1849508
2019-10-11Add Support for e24cloud to Ec2 datasource.Scott Moser
e24cloud provides an EC2 compatible datasource. This just identifies their platform based on dmi 'system-vendor' having 'e24cloud'. https://www.e24cloud.com/en/ . Updated chassis typo in zstack unit test docstring. LP: #1696476
2019-10-04Add RbxCloud datasourceAdam Dobrawy
2019-09-26docs: fix zstack documentation lintsChad Smith
Resolve the following lints raised by 'make doc': - doc/rtd/topics/datasources/zstack.rst:5: D001 Line too long - doc/rtd/topics/datasources/zstack.rst:10: D001 Line too long
2019-09-18Add datasource for ZStack platform.Shixin Ruan
Zstack platform provides a AWS Ec2 metadata service, and identifies their platform to the guest by setting the 'chassis asset tag' to a string that ends with '.zstack.io'. LP: #1841181
2019-09-18docs: organize TOC and update summary of projectJoshua Powers
2019-09-18docs: create cli specific pageJoshua Powers
This is formerly the capabilities page.
2019-09-18docs: added output examples to analyze.rstJoshua Powers
2019-09-18docs: doc8 fixes for instancedata pageJoshua Powers
The huge table was scrolling off the page for me and it made more sense to break this up and have sections for each item anyway.
2019-09-18docs: clean up formatting, organize boot pageJoshua Powers
2019-09-14docs: more complete list of availabilityJoshua Powers
2019-09-14docs: start FAQ pageJoshua Powers
Takeover the moreinfo.rst page and update initially with pages a user can use to learn about cloud-init. For now, other docs and presentations about cloud-init. Goal is to use this page to collect very commonly asked questions.
2019-09-14docs: cleanup output & order of datasource pageJoshua Powers
2019-09-07doc: document doc, create makefile and tox targetJoshua Powers
* Create makefile and tox targets for documentation building and testing to better replicate the live web docs using the same theme. * Created docs.rst to explain how to build and contribute to documentation with style guide and tips. * doc/rtd/conf.py:     * Add copyright to rtd config     * Use Sphinx's RTD theme to replicate actual docs
2019-09-04docs: fix whitespace, spelling, and line lengthJoshua Powers
2019-09-03docs: remove unnecessary file in doc directoryJoshua Powers
2019-08-20Add missing #cloud-config comment on first example in documentation.Florian Müller
Since this is the first code snippet some users might see, they could end up in the same situation like me today when they wonder why their yaml user config is not working at all.
2019-08-19format.rst: add text/jinja2 to list of content types (+ cleanups)Daniel Watkins
The cleanups, specifically, are to sort the list of content types, and remove trailing whitespace.
2019-08-14DataSourceOracle: configure secondary NICs on Virtual MachinesDaniel Watkins
Oracle Cloud Infrastructure's Instance Metadata Service provides network configuration information for non-primary NICs. This commit introduces support, on Virtual Machines[0], for fetching that network metadata, converting it to v1 network-config[1] and combining it into the network configuration generated for the primary interface. By default, this behaviour is not enabled. Configuring the Oracle datasource to `configure_secondary_nics` enables it: datasource: Oracle: configure_secondary_nics: true Failures to fetch and generate secondary NIC configuration will log a warning, but otherwise will not affect boot. [0] The expected use of the IMDS-provided network configuration is substantially different on Bare Metal Machines, so support for that will be addressed separately. [1] This is v1 config, because cloudinit.net.cmdline generates v1 config and we need to integrate the secondary NICs into that configuration.
2019-08-08New data source for the Exoscale.com cloud platformChris Glass
- dsidentify switches to the new Exoscale datasource on matching DMI name - New Exoscale datasource added Signed-off-by: Mathieu Corbin <mathieu.corbin@exoscale.ch>
2019-08-08doc: remove intersphinx extensionDaniel Watkins
We don't use it in our doc builds, and if sphinx.pocoo.org is down then it causes doc build issues.
2019-07-16Fix typo in publicly viewable documentation.David Medberry
2019-07-15Cloud-init analyze module: Added ability to analyze boot events.Sam Gilson
This branch introduces a new command line feature for cloud-init. Currently, the cloud-init module has the capability to analyze events in cloud-init.log in three ways: 'show', 'blame', 'dump'. These changes add a fourth capability, called 'boot'. Running the command 'cloud-init analyze boot' will provide the user three timestamps. 1) Timestamp for when the kernel starts initializing. 2) Timestamp for when the kernel finishes its initialization. 3) Timestamp for when systemd activates cloud-init. This feature enables cloud-init users to analyze different boot phases. This would aid in debugging performance issues related to cloud-init startup or tracking regression.
2019-06-25doc: indicate that netplan is default in Ubuntu nowDaniel Watkins
2019-04-09Change DataSourceNoCloud to ignore file system label's case.Risto Oikarinen
NoCloud data source now accepts both 'cidata' and 'CIDATA' as filesystem labels. This is similar to DataSourceConfigDrive's support for 'config-2' and 'CONFIG-2'.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-10 06:24:10 +0000