The following pull request was submitted through Github. It can be accessed and reviewed at: https://github.com/lxc/lxd/pull/3184
This e-mail was sent by the LXC bot, direct replies will not reach the author unless they happen to be subscribed to this list. === Description (from pull-request) ===
From 070f8490f5914f33ec2d8724aec2f0275597fd49 Mon Sep 17 00:00:00 2001 From: Alberto Donato <[email protected]> Date: Tue, 18 Apr 2017 12:13:29 +0200 Subject: [PATCH] Update documentation around configuration. --- doc/backup.md | 2 ++ doc/configuration.md | 41 ++++++++++++++++------------------------- 2 files changed, 18 insertions(+), 25 deletions(-) diff --git a/doc/backup.md b/doc/backup.md index 2c8821b..1be486d 100644 --- a/doc/backup.md +++ b/doc/backup.md @@ -5,6 +5,8 @@ To backup a LXD instance different strategies are available. ## Full backup This requires that the whole `/var/lib/lxd` folder will be backuped up. Additionally, it is necessary to backup all storage pools as well. +The filesystem used for backups must support symlinks. + In order to restore the LXD instance the old `/var/lib/lxd` folder needs to be removed and replaced with the `/var/lib/lxd` snapshot. All storage pools need to be restored as well. diff --git a/doc/configuration.md b/doc/configuration.md index ff69154..8700f3e 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -15,31 +15,22 @@ The key/value configuration is namespaced with the following namespaces currently supported: - core (core daemon configuration) - images (image configuration) - - storage (storage configuration) - -Key | Type | Default | API extension | Deprecated | Description -:-- | :--- | :------ | :------------ | :--------- | :---------- -core.https\_address | string | - | - | | Address to bind for the remote API -core.https\_allowed\_origin | string | - | - | | Access-Control-Allow-Origin http header value -core.https\_allowed\_methods | string | - | - | | Access-Control-Allow-Methods http header value -core.https\_allowed\_headers | string | - | - | | Access-Control-Allow-Headers http header value -core.https\_allowed\_credentials| boolean | - | - | | Whether to set Access-Control-Allow-Credentials http header value to "true" -core.proxy\_https | string | - | - | | https proxy to use, if any (falls back to HTTPS\_PROXY environment variable) -core.proxy\_http | string | - | - | | http proxy to use, if any (falls back to HTTP\_PROXY environment variable) -core.proxy\_ignore\_hosts | string | - | - | | hosts which don't need the proxy for use (similar format to NO\_PROXY, e.g. 1.2.3.4,1.2.3.5, falls back to NO\_PROXY environment variable) -core.trust\_password | string | - | - | | Password to be provided by clients to setup a trust -storage.lvm\_vg\_name | string | - | - | by pool source property | LVM Volume Group name to be used for container and image storage. A default Thin Pool is created using 100% of the free space in the Volume Group, unless `storage.lvm_thinpool_name` is set. -storage.lvm\_thinpool\_name | string | "LXDPool" | - | by volume.lvm.thinpool\_name pool property | LVM Thin Pool to use within the Volume Group specified in `storage.lvm_vg_name`, if the default pool parameters are undesirable. -storage.lvm\_fstype | string | ext4 | - | by volume.block.filesystem pool property | Format LV with filesystem, for now it's value can be only ext4 (default) or xfs. -storage.lvm\_mount\_options | string | discard | storage\_lvm\_mount\_options | by volume.block.mount\_options pool property | Mount options for the LV filesystem -storage.lvm\_volume\_size | string | 10GiB | - | by volume.size pool property | Size of the logical volume -storage.zfs\_pool\_name | string | - | - | by pool source property | ZFS pool name -storage.zfs\_remove\_snapshots | boolean | false | storage\_zfs\_remove\_snapshots | by volume.zfs.remove\_snapshots pool property | Automatically remove any needed snapshot when attempting a container restore -storage.zfs\_use\_refquota | boolean | false | storage\_zfs\_use\_refquota | by volume.zfs.use\_refquota pool property | Don't include snapshots as part of container quota (size property) or in reported disk usage -images.compression\_algorithm | string | gzip | - | | Compression algorithm to use for new images (bzip2, gzip, lzma, xz or none) -images.remote\_cache\_expiry | integer | 10 | - | | Number of days after which an unused cached remote image will be flushed -images.auto\_update\_interval | integer | 6 | - | | Interval in hours at which to look for update to cached images (0 disables it) -images.auto\_update\_cached | boolean | true | - | | Whether to automatically update any image that LXD caches + +Key | Type | Default | API extension | Description +:-- | :--- | :------ | :------------ | :---------- +core.https\_address | string | - | - | Address to bind for the remote API +core.https\_allowed\_headers | string | - | - | Access-Control-Allow-Headers http header value +core.https\_allowed\_methods | string | - | - | Access-Control-Allow-Methods http header value +core.https\_allowed\_origin | string | - | - | Access-Control-Allow-Origin http header value +core.https\_allowed\_credentials| boolean | - | - | Whether to set Access-Control-Allow-Credentials http header value to "true" +core.proxy\_http | string | - | - | http proxy to use, if any (falls back to HTTP\_PROXY environment variable) +core.proxy\_https | string | - | - | https proxy to use, if any (falls back to HTTPS\_PROXY environment variable) +core.proxy\_ignore\_hosts | string | - | - | hosts which don't need the proxy for use (similar format to NO\_PROXY, e.g. 1.2.3.4,1.2.3.5, falls back to NO\_PROXY environment variable) +core.trust\_password | string | - | - | Password to be provided by clients to setup a trust +images.auto\_update\_cached | boolean | true | - | Whether to automatically update any image that LXD caches +images.auto\_update\_interval | integer | 6 | - | Interval in hours at which to look for update to cached images (0 disables it) +images.compression\_algorithm | string | gzip | - | Compression algorithm to use for new images (bzip2, gzip, lzma, xz or none) +images.remote\_cache\_expiry | integer | 10 | - | Number of days after which an unused cached remote image will be flushed Those keys can be set using the lxc tool with:
_______________________________________________ lxc-devel mailing list [email protected] http://lists.linuxcontainers.org/listinfo/lxc-devel
