VhzddlmZmZmZeZdZdZdZddl Z ddl Z ddl Z ddl Z ddl mZddlmZmZddlmZd d d d d dZddddZdZgdZddgZGddeZdZedk(reyy))absolute_importdivisionprint_functionaM module: lxd_container short_description: Manage LXD instances description: - Management of LXD containers and virtual machines. author: "Hiroaki Nakamura (@hnakamur)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full version_added: 6.4.0 diff_mode: support: full version_added: 6.4.0 options: name: description: - Name of an instance. type: str required: true project: description: - Project of an instance. - See U(https://documentation.ubuntu.com/lxd/en/latest/projects/). required: false type: str version_added: 4.8.0 architecture: description: - The architecture for the instance (for example V(x86_64) or V(i686)). - See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get). type: str required: false config: description: - 'The config for the instance (for example V({"limits.cpu": "2"})).' - See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get). - If the instance already exists and its "config" values in metadata obtained from the LXD API U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get) 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). type: dict required: false ignore_volatile_options: description: - If set to V(true), options starting with C(volatile.) are ignored. As a result, they are reapplied for each execution. - This default behavior can be changed by setting this option to V(false). - The default value changed from V(true) to V(false) in community.general 6.0.0. type: bool required: false default: false version_added: 3.7.0 profiles: description: - Profile to be used by the instance. type: list elements: str devices: description: - 'The devices for the instance (for example V({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})).' - See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get). type: dict required: false ephemeral: description: - Whether or not the instance is ephemeral (for example V(true) or V(false)). - See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get). required: false type: bool source: description: - 'The source for the instance (for example V({ "type": "image", "mode": "pull", "server": "https://cloud-images.ubuntu.com/releases/", "protocol": "simplestreams", "alias": "22.04" })).' - 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).' required: false type: dict state: choices: - started - stopped - restarted - absent - frozen description: - Define the state of an instance. required: false default: started type: str target: description: - For cluster deployments. Will attempt to create an instance on a target node. If the instance exists elsewhere in a cluster, then it will not be replaced or moved. The name should respond to same name of the node you see in C(lxc cluster list). type: str required: false version_added: 1.0.0 timeout: description: - A timeout for changing the state of the instance. - This is also used as a timeout for waiting until IPv4 addresses are set to the all network interfaces in the instance after starting or restarting. required: false default: 30 type: int type: description: - Instance type can be either V(virtual-machine) or V(container). required: false default: container choices: - container - virtual-machine type: str version_added: 4.1.0 wait_for_ipv4_addresses: description: - If this is V(true), the C(lxd_container) waits until IPv4 addresses are set to the all network interfaces in the instance after starting or restarting. required: false default: false type: bool wait_for_container: description: - If set to V(true), the tasks will wait till the task reports a success status when performing container operations. default: false type: bool version_added: 4.4.0 force_stop: description: - If this is V(true), the C(lxd_container) forces to stop the instance when it stops or restarts the instance. required: false default: false type: bool url: description: - The unix domain socket path or the https URL for the LXD server. required: false default: unix:/var/lib/lxd/unix.socket type: str snap_url: description: - The unix domain socket path when LXD is installed by snap package manager. required: false default: unix:/var/snap/lxd/common/lxd/unix.socket type: str client_key: description: - The client certificate key file path. - If not specified, it defaults to C(${HOME}/.config/lxc/client.key). required: false aliases: [key_file] type: path client_cert: description: - The client certificate file path. - If not specified, it defaults to C(${HOME}/.config/lxc/client.crt). required: false aliases: [cert_file] type: path trust_password: description: - The client trusted password. - 'You need to set this password on the LXD server before running this module using the following command: C(lxc config set core.trust_password ). See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).' - If trust_password is set, this module send a request for authentication before sending any requests. required: false type: str notes: - Instances can be a container or a virtual machine, both of them must have unique name. If you attempt to create an instance with a name that already existed in the users namespace the module will simply return as "unchanged". - There are two ways to run commands inside a container or virtual machine, using the command module or using the ansible lxd connection plugin bundled in Ansible >= 2.1, the later requires python to be installed in the instance which can be done with the command module. - You can copy a file from the host to the instance with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the P(community.general.lxd#connection) connection plugin. See the example below. - You can copy a file in the created instance to the localhost with C(command=lxc file pull instance_name/dir/filename filename). See the first example below. - Linuxcontainers.org has phased out LXC/LXD support with March 2024 (U(https://discuss.linuxcontainers.org/t/important-notice-for-lxd-users-image-server/18479)). Currently only Ubuntu is still providing images. a # An example for creating a Ubuntu container and install python - hosts: localhost connection: local tasks: - name: Create a started container community.general.lxd_container: name: mycontainer ignore_volatile_options: true state: started source: type: image mode: pull server: https://cloud-images.ubuntu.com/releases/ protocol: simplestreams alias: "22.04" profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 - name: Check python is installed in container delegate_to: mycontainer ansible.builtin.raw: dpkg -s python register: python_install_check failed_when: python_install_check.rc not in [0, 1] changed_when: false - name: Install python in container delegate_to: mycontainer ansible.builtin.raw: apt-get install -y python when: python_install_check.rc == 1 # An example for creating an Ubuntu 14.04 container using an image fingerprint. # This requires changing 'server' and 'protocol' key values, replacing the # 'alias' key with with 'fingerprint' and supplying an appropriate value that # matches the container image you wish to use. - hosts: localhost connection: local tasks: - name: Create a started container community.general.lxd_container: name: mycontainer ignore_volatile_options: true state: started source: type: image mode: pull # Provides current (and older) Ubuntu images with listed fingerprints server: https://cloud-images.ubuntu.com/releases # Protocol used by 'ubuntu' remote (as shown by 'lxc remote list') protocol: simplestreams # This provides an Ubuntu 14.04 LTS amd64 image from 20150814. fingerprint: e9a8bdfab6dc profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 # An example of creating a ubuntu-minial container - hosts: localhost connection: local tasks: - name: Create a started container community.general.lxd_container: name: mycontainer ignore_volatile_options: true state: started source: type: image mode: pull # Provides Ubuntu minimal images server: https://cloud-images.ubuntu.com/minimal/releases/ protocol: simplestreams alias: "22.04" profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 # An example for creating container in project other than default - hosts: localhost connection: local tasks: - name: Create a started container in project mytestproject community.general.lxd_container: name: mycontainer project: mytestproject ignore_volatile_options: true state: started source: protocol: simplestreams type: image mode: pull server: https://cloud-images.ubuntu.com/releases/ alias: "22.04" profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 # An example for deleting a container - hosts: localhost connection: local tasks: - name: Delete a container community.general.lxd_container: name: mycontainer state: absent type: container # An example for restarting a container - hosts: localhost connection: local tasks: - name: Restart a container community.general.lxd_container: name: mycontainer state: restarted type: container # An example for restarting a container using https to connect to the LXD server - hosts: localhost connection: local tasks: - name: Restart a container community.general.lxd_container: url: https://127.0.0.1:8443 # These client_cert and client_key values are equal to the default values. # client_cert: "{{ lookup('env', 'HOME') }}/.config/lxc/client.crt" # client_key: "{{ lookup('env', 'HOME') }}/.config/lxc/client.key" trust_password: mypassword name: mycontainer state: restarted # Note your container must be in the inventory for the below example. # # [containers] # mycontainer ansible_connection=lxd # - hosts: - mycontainer tasks: - name: Copy /etc/hosts in the created container to localhost with name "mycontainer-hosts" ansible.builtin.fetch: src: /etc/hosts dest: /tmp/mycontainer-hosts flat: true # An example for LXD cluster deployments. This example will create two new container on specific # nodes - 'node01' and 'node02'. In 'target:', 'node01' and 'node02' are names of LXD cluster # members that LXD cluster recognizes, not ansible inventory names, see: 'lxc cluster list'. # LXD API calls can be made to any LXD member, in this example, we send API requests to # 'node01.example.com', which matches ansible inventory name. - hosts: node01.example.com tasks: - name: Create LXD container community.general.lxd_container: name: new-container-1 ignore_volatile_options: true state: started source: type: image mode: pull alias: "22.04" target: node01 - name: Create container on another node community.general.lxd_container: name: new-container-2 ignore_volatile_options: true state: started source: type: image mode: pull alias: "22.04" target: node02 # An example for creating a virtual machine - hosts: localhost connection: local tasks: - name: Create container on another node community.general.lxd_container: name: new-vm-1 type: virtual-machine state: started ignore_volatile_options: true wait_for_ipv4_addresses: true profiles: ["default"] source: protocol: simplestreams type: image mode: pull server: ['...'] # URL to the image server alias: debian/11 timeout: 600 a addresses: description: Mapping from the network device name to a list of IPv4 addresses in the instance. returned: when state is started or restarted type: dict sample: {"eth0": ["10.155.92.191"]} old_state: description: The old state of the instance. returned: when state is started or restarted type: str sample: "stopped" logs: description: The logs of requests and responses. returned: when ansible-playbook is invoked with -vvvv. type: list sample: "(too long to be placed here)" actions: description: List of actions performed for the instance. returned: success type: list sample: ["create", "start"] N) AnsibleModule) LXDClientLXDClientException) urlencode_started_stopped _restarted _destroyed_frozen)startedstopped restartedabsentfrozenrrr)RunningStoppedFrozenzunix:/var/lib/lxd/unix.socket) architectureconfigdevices ephemeralprofilessourcetyperrceZdZdZdZdZdZedZddZ dZ dZ d Z d Z d Zd Zd ZddZedZdZdZdZdZdZdZdZdZdZdZy)LXDContainerManagementc|||_|jjd|_|jjd|_|j |jjd|_|jjd|_|jjd|_|jjd|_d|_ |jjd|_ |jjd |_ |jjd |_ |jjjd |_|j'd jt j"d |_|jjjd|_|j$'djt j"d |_|jj&dk\|_ |jjdt*k7r|jjd|_nt j.j1|jjdj3ddr|jjd|_n|jjd|_ t;|j,|j|j$|j(|_d|_ |j<jCddj|j@dg}|ddk(r-|jdk(rd|_ n|jdk(rd |_ |jjjd!d|_"g|_#iid"|_$i|_%i|_&y#t4$r1}|jj7|j8Yd}~1d}~wwxYw#t>$r1}|jj7|j8Yd}~1d}~wwxYw)#zManagement of LXC containers via Ansible. :param module: Processed Ansible Module. :type module: ``object`` nameprojectstatetimeoutwait_for_ipv4_addresses force_stopNtargetwait_for_containerr client_keyz{0}/.config/lxc/client.keyHOME client_certz{0}/.config/lxc/client.crturlsnap_urlzunix:)msg)key_file cert_filedebugz/1.0/instancesGETz {0}?project=ok_error_codes error_code containerz/1.0/containersvirtual-machinez/1.0/virtual-machinestrust_password)beforeafter)'moduleparamsr!r" _build_configr#r$r%r& addressesr'r(rgetr1formatosenvironr2 _verbosityr3ANSIBLE_LXD_DEFAULT_URLr-pathexistsreplace Exception fail_jsonr0rclientr api_endpointdor;actionsdiffold_instance_json old_sections)selfr>echeck_api_endpoints s/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/lxd_container.py__init__zLXDContainerManagement.__init__sC  KK&&v. {{)))4  [[''0 {{)))4 '+{{'9'9:S'T$++,,\:kk((2 "&++"4"45I"JKK&&v.  **..|< == 8?? 6@RSDM++// > >> !9@@FASTDN[[++q0  -{{!!%(,CC;;--e4 2 2: > F FwPR ST;;--j9;;--e4 -#4==DNNjjDK-![[^^E>3H3HIZIZ3[mplq^r l +s 2yyK'$5!//$;!"kk00445EtL !B/ !#5 - KK ! !aee ! , , -" - KK ! !aee ! , , -s1CO  &O99O> P; &P66P;ci|_tD]:}|jjj |d}|,||j|<<yN)r CONFIG_PARAMSr>r?rB)rTattr param_vals rWr@z$LXDContainerManagement._build_configsH ! .D **..tT:I$$- D! .cdj|j|j}|jr/dj|t t |j}|j jd|dgS)N{0}/{1}{0}?{1}r"r4r5r6rCrNr!r"r dictrMrOrTr-s rW_get_instance_jsonz)LXDContainerManagement._get_instance_jsons`t00$))< <<""3 $t||2L(MNC{{~~eS#~??r^cdj|j|j}|jr/dj|t t |j}|j jd|dgS)N {0}/{1}/staterarbr4r5r6rcres rW_get_instance_state_jsonz/LXDContainerManagement._get_instance_state_jsons`$$T%6%6 B <<""3 $t||2L(MNC{{~~eS#~??r^c2|ddk(ryt|ddS)Nrerrorrmetadatastatus)ANSIBLE_LXD_STATES) resp_jsons rW_instance_json_to_module_statez5LXDContainerManagement._instance_json_to_module_states' V  '!)J"7"ABBr^cZdj|j|j}|jr/dj|t t |j}||j d}|rd|d<|jjs|jjd||Sy) Nrhrarb)actionr$TforcePUT body_json) rCrNr!r"r rdr$r> check_moderMrO)rTrrr&r-rvs rW _change_statez$LXDContainerManagement._change_state!s$$T%6%6 B <<""3 $t||2L(MNC%$,,? !%Ig {{%%;;>>% >B B&r^c*|j}t}|jr|j|d<|jr|j|d<|rdj |t |}|j j}|j|d<|j|jvr|j|d<|jjs)|jjd|||j|jj!dy) Nr'r"rar!rPOST)r(create)rNrdr'r"rCr rcopyr!rr>rwrMrOr(rPappend)rTr- url_paramsrs rW_create_instancez'LXDContainerManagement._create_instance+sV ;;#';;Jx <<$(LLJy ! ""3 *(=>C!!#v 99D-- -!YYF6N{{%% KKNN634CZCZN [ H%r^c\|jd|jjdy)NstartrxrPr}rTs rW_start_instancez&LXDContainerManagement._start_instance<s" 7# G$r^cr|jd|j|jjdy)Nstoprxr&rPr}rs rW_stop_instancez%LXDContainerManagement._stop_instance@s( 64??3 F#r^cr|jd|j|jjdy)Nrestartrrs rW_restart_instancez(LXDContainerManagement._restart_instanceDs( 9doo6 I&r^c`dj|j|j}|jr/dj|t t |j}|j js|jjd||jjdy)Nr`rarbDELETEdelete) rCrNr!r"r rdr>rwrMrOrPr}res rW_delete_instancez'LXDContainerManagement._delete_instanceHsvt00$))< <<""3 $t||2L(MNC{{%% KKNN8S ) H%r^c\|jd|jjdy)Nfreezerrs rW_freeze_instancez'LXDContainerManagement._freeze_instancePs" 8$ H%r^c\|jd|jjdy)Nunfreezerrs rW_unfreeze_instancez)LXDContainerManagement._unfreeze_instanceTs" :& J'r^Nc |dgn|}|jxsijddxsi}|jdxsijDcic] \}}||vr||}}}|jDcic]%\}}||dDcgc]}|ddk(s |dc}'}}}}|Scc}}wcc}wcc}}}w)NlorlnetworkrAfamilyinetaddress)rirBitems)rTignore_devicesdatakvrarAs rW_instance_ipv4_addressesz/LXDContainerManagement._instance_ipv4_addressesXs#1#9$~--/52:::tLRPR),299; 1& qD     1 a nN( v8M) N N   O s$B.>B9 B4B4#B94B9cbt|dkDxr td|jDS)Nrc38K|]}t|dkDyw)rN)len).0rs rW zALXDContainerManagement._has_all_ipv4_addresses..hs)Q#a&1*)Qs)rallvalues)rAs rW_has_all_ipv4_addressesz.LXDContainerManagement._has_all_ipv4_addressesfs*9~!Qc)Qi>N>N>P)Q&QQr^c tjjtj|jz}tjj|krwt j d|j }|j|s|jjr||_ ytjj|krvyy#t$r }d|_ d}~wwxYw)N)secondsz"timeout for getting IPv4 addresses) datetimenow timedeltar$timesleeprrr>rwrArr0)rTduerArUs rW_get_addressesz%LXDContainerManagement._get_addressesjs ##'')H,>,>t||,TTC##'')C/ 1  99; // :dkk>T>T%.DN ##'')C/ " 8AE  sB3C6!C C0#C++C0c\|jdk(r!|j|jn_|jdk(r|jn|jdk(r|j|j r|j |j r|jyyNrrr) old_staterrr _needs_to_apply_instance_configs_apply_instance_configsr%rrs rWr zLXDContainerManagement._startedws >>X %  ! ! #  "~~)'')9,$$&446,,.  ' '    ! (r^c|jdk(r|jy|jdk(rB|jr1|j|j |j yy|jdk(r|j |jr|j |j y)Nrrr)rrrrrrrrs rWr zLXDContainerManagement._stoppeds >>X %  ! ! #~~*88:((*002''); >>X-++-88:002##%r^c<|jdk(r!|j|jnO|jdk(r|j|j r|j |j |jr|jyy)Nrr) rrrrrrrr%rrs rWr z!LXDContainerManagement._restarteds| >>X %  ! ! #  "~~)'')446,,.  " " $  ' '    ! (r^c|jdk7rO|jdk(r|j|jdk7r|j|jyyr)rrrrrs rWr z!LXDContainerManagement._destroyedsO >>X %~~)'')~~*##%  ! ! # &r^c"|jdk(r1|j|j|jy|jdk(r|j|j r|j |jy)Nrr)rrrrrrrs rWrzLXDContainerManagement._frozensn >>X %  ! ! #  "  ! ! #~~*$$&446,,.  ! ! #r^cD||jvry|dk(r_t|jj|dxsi}|jdj D]\}}||vry|||k7syy|jj|i}|j||k7S)NFrT)rrdrSrBr)rTkey old_configsrrs rW _needs_to_change_instance_configz7LXDContainerManagement._needs_to_change_instance_configs dkk ! (?t0044S$?E2FK H-335 1K'q>Q&  ++//R8K;;s#{2 2r^crttttz D]}|j|syy)NTF)setr[CONFIG_CREATION_PARAMSr)rTparams rWrz7LXDContainerManagement._needs_to_apply_instance_configss7'#.D*EE E44U; r^c2tj|jjddxsi}i}t t t t z D]~}||vr||||<|j|s!|dk(rG|jddxsi|d<|jdjD] \}}||d|<m|j|||<||jdd<dj|j|j}|jr/dj|tt!|j}|j"j$s|j&j)d|| |j*j-d y) Nrlrr=instancer`rarbrtruapply_instance_configs)r|deepcopyrRrBrr[rrrrrQrCrNr!r"r rdr>rwrMrOrPr})rT old_metadatarvrrrr-s rWrz.LXDContainerManagement._apply_instance_configssk}}T%;%;<@@TRXVX  '#.D*EE :E $#/#6 % 44U;H$*3--$*G*M2Ih' $ H 5 ; ; =3112 (+A.3(,{{5'9Ie$ :*3 ':&t00$))< <<""3 $t||2L(MNC{{%% KKNN5#N ; 45r^c fd} j%jjjjjj d_j_jj dxsijDcic]/\}}|ttttz vr |||1c}}_ jjdd<jjdd<j!j_j"jdd<j$jdd<t't(j$}|t+j,d kD}jj.|j"j,jd }jj0rjj2|d <j4j4|d <jj6di|ycc}}w#t8$r}t+j,d kD}|j:|j,jd }jj0r|j<d |d <jj>di|Yd}~yd}~wwxYw)zRun the main method.ct|ts|S|jDcic]&\}}jr|j dr$||(c}}Scc}}w)Nz volatile.) isinstancerdrignore_volatile_options startswith)contentrrrTs rWadjust_contentz2LXDContainerManagement.run..adjust_contentsY",Wd";7 !(BA9U9UZ[ZfZfgrZs1B Bs %A ANrrlr<rr=r#r) log_verbositychangedrrPrQlogsrA)r0rrPrQ) r;rM authenticater>r?rBrrfrRrrr[rrSrQrrprr#getattrLXD_ANSIBLE_STATESrrPrFr3rrA exit_jsonrr0kwargsrL) rTrsectionrrr state_changed result_jsonrU fail_paramss ` rWrunzLXDContainerManagement.runsi  . 1"". (()<)<=+/;;+=+=+A+AB[+\D (%)%<%<%>D "*.)?)?)C)CJ)O)USU(\(\(^!$GWc-037M3NNN00!D  /3.?.?DIIh  +-1[[DIIg z *!@@AWAWXDN+/>>DIIh  (*.**DIIg w 'T#5djj#ABF H -1M!%!7!7(!^^<< K{{  &*kk&6&6 F#~~)+/>> K( !DKK ! ! 0K 0;!<" 1 -1Muu(<< K {{  &'hhv&6 F# !DKK ! ! 0K 0 1s,B I(4IE5II K,!BK''K,)FrZ)__name__ __module__ __qualname__rXr@rfri staticmethodrprxrrrrrrrrrrr r r r rrrrrrr^rWrrs?B.@ @ CC C&"%$'&&( RR  "& "$ $3" 6,61r^rc ttd0idtdddtddtddtd d td d dtd dtd dtdddtd dtttj ddtddtdd dtddddgdtd d d td d d!td d d"tdt d#tdd$ d%td&d'g(d)td&d*g(d+tdd,d-}t |.}|jy/)1zAnsible Main module.r!strT)rrequiredr")rrrrdrboolF)rdefaultrrrlist)relementsrr#r)choicesrr'r$intrr9r:)rrrr(r%r&r-r.z)unix:/var/snap/lxd/common/lxd/unix.socketr)rHr1)raliasesr+r2r;)rno_log) argument_specsupports_check_mode)r>Nr)rrdrrkeysrGrr)r> lxd_manages rWmainrsL L  L L L %)%L $%L *+L 01L 89L >/4467!?L FGL LML T#$&78UL ^ $ _L f%)%gL noL v/wL ~CL F# GL N$ OL V U48WL Z!]OFb(v6JNNr^__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNr|rrDransible.module_utils.basicr>ansible_collections.community.general.plugins.module_utils.lxdrr+ansible.module_utils.six.moves.urllib.parser rrnrGr[robjectrrrrr^rWrsA@ v pA F .  4hA  : #F+S1VS1l Up zFr^