ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

LXD moved to Canonical (#7332)

Browse source 
* plugins/inventory/lxd: update links to doc

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>

* plugins/modules/lxd_container: update links to doc

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>

* plugins/modules/lxd_profile: update links to doc

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>

* plugins/modules/lxd_project: update links to doc

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>

---------

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
This commit is contained in:
Simon Deziel 2023-10-04 17:48:54 +00:00 committed by GitHub
parent cda6fc956f
commit 160e00e5b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
plugins/inventory/lxd.py
View file

@ -47,7 +47,7 @@ DOCUMENTATION = r'''
- You need to set this password on the lxd server before - You need to set this password on the lxd server before
running this module using the following command running this module using the following command
C(lxc config set core.trust_password <some random password>) C(lxc config set core.trust_password <some random password>)
See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/). See U(https://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password).
- If O(trust_password) is set, this module send a request for authentication before sending any requests. - If O(trust_password) is set, this module send a request for authentication before sending any requests.
type: str type: str
state: state:
@ -359,7 +359,7 @@ class InventoryModule(BaseInventoryPlugin):
Kwargs: Kwargs:
None None
Source: Source:
https://github.com/lxc/lxd/blob/master/doc/rest-api.md https://documentation.ubuntu.com/lxd/en/latest/rest-api/
Raises: Raises:
None None
Returns: Returns:

17
plugins/modules/lxd_container.py
View file

@ -34,23 +34,24 @@ options:
project: project:
description: description:
- 'Project of an instance. - 'Project of an instance.
See U(https://github.com/lxc/lxd/blob/master/doc/projects.md).' See U(https://documentation.ubuntu.com/lxd/en/latest/projects/).'
required: false required: false
type: str type: str
version_added: 4.8.0 version_added: 4.8.0
architecture: architecture:
description: description:
- 'The architecture for the instance (for example V(x86_64) or V(i686)). - 'The architecture for the instance (for example V(x86_64) or V(i686)).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).'
type: str type: str
required: false required: false
config: config:
description: description:
- 'The config for the instance (for example V({"limits.cpu": "2"})). - 'The config for the instance (for example V({"limits.cpu": "2"})).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).'
- If the instance already exists and its "config" values in metadata - If the instance already exists and its "config" values in metadata
obtained from the LXD API U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#instances-containers-and-virtual-machines) obtained from the LXD API U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get)
are different, this module tries to apply the configurations. are different, then this module tries to apply the configurations
U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_put).
- The keys starting with C(volatile.) are ignored for this comparison when O(ignore_volatile_options=true). - The keys starting with C(volatile.) are ignored for this comparison when O(ignore_volatile_options=true).
type: dict type: dict
required: false required: false
@ -73,13 +74,13 @@ options:
description: description:
- 'The devices for the instance - 'The devices for the instance
(for example V({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})). (for example V({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).'
type: dict type: dict
required: false required: false
ephemeral: ephemeral:
description: description:
- Whether or not the instance is ephemeral (for example V(true) or V(false)). - Whether or not the instance is ephemeral (for example V(true) or V(false)).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).
required: false required: false
type: bool type: bool
source: source:
@ -87,7 +88,7 @@ options:
- 'The source for the instance - 'The source for the instance
(for example V({ "type": "image", "mode": "pull", "server": "https://images.linuxcontainers.org", (for example V({ "type": "image", "mode": "pull", "server": "https://images.linuxcontainers.org",
"protocol": "lxd", "alias": "ubuntu/xenial/amd64" })).' "protocol": "lxd", "alias": "ubuntu/xenial/amd64" })).'
- 'See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1) for complete API documentation.' - 'See U(https://documentation.ubuntu.com/lxd/en/latest/api/) for complete API documentation.'
- 'Note that C(protocol) accepts two choices: V(lxd) or V(simplestreams).' - 'Note that C(protocol) accepts two choices: V(lxd) or V(simplestreams).'
required: false required: false
type: dict type: dict

13
plugins/modules/lxd_profile.py
View file

@ -32,7 +32,7 @@ options:
project: project:
description: description:
- 'Project of a profile. - 'Project of a profile.
See U(https://github.com/lxc/lxd/blob/master/doc/projects.md).' See U(https://documentation.ubuntu.com/lxd/en/latest/projects/).'
type: str type: str
required: false required: false
version_added: 4.8.0 version_added: 4.8.0
@ -43,12 +43,13 @@ options:
config: config:
description: description:
- 'The config for the instance (e.g. {"limits.memory": "4GB"}). - 'The config for the instance (e.g. {"limits.memory": "4GB"}).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#patch-3)' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get).'
- If the profile already exists and its "config" value in metadata - If the profile already exists and its "config" value in metadata
obtained from obtained from
GET /1.0/profiles/<name> GET /1.0/profiles/<name>
U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#get-19) U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get)
are different, they this module tries to apply the configurations. are different, then this module tries to apply the configurations
U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_put).
- Not all config values are supported to apply the existing profile. - Not all config values are supported to apply the existing profile.
Maybe you need to delete and recreate a profile. Maybe you need to delete and recreate a profile.
required: false required: false
@ -57,14 +58,14 @@ options:
description: description:
- 'The devices for the profile - 'The devices for the profile
(e.g. {"rootfs": {"path": "/dev/kvm", "type": "unix-char"}). (e.g. {"rootfs": {"path": "/dev/kvm", "type": "unix-char"}).
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#patch-3)' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get).'
required: false required: false
type: dict type: dict
new_name: new_name:
description: description:
- A new name of a profile. - A new name of a profile.
- If this parameter is specified a profile will be renamed to this name. - If this parameter is specified a profile will be renamed to this name.
See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-11) See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_post).
required: false required: false
type: str type: str
merge_profile: merge_profile:

9
plugins/modules/lxd_project.py
View file

@ -35,18 +35,19 @@ options:
config: config:
description: description:
- 'The config for the project (for example V({"features.profiles": "true"})). - 'The config for the project (for example V({"features.profiles": "true"})).
See U(https://linuxcontainers.org/lxd/docs/master/projects/).' See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_get).'
- If the project already exists and its "config" value in metadata - If the project already exists and its "config" value in metadata
obtained from obtained from
C(GET /1.0/projects/<name>) C(GET /1.0/projects/<name>)
U(https://linuxcontainers.org/lxd/docs/master/api/#/projects/project_get) U(https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_get)
are different, then this module tries to apply the configurations. are different, then this module tries to apply the configurations
U(https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_put).
type: dict type: dict
new_name: new_name:
description: description:
- A new name of a project. - A new name of a project.
- If this parameter is specified a project will be renamed to this name. - If this parameter is specified a project will be renamed to this name.
See U(https://linuxcontainers.org/lxd/docs/master/api/#/projects/project_post). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_post).
required: false required: false
type: str type: str
merge_project: merge_project: