VhMddlmZmZmZeZdZdZdZddl m Z ddl m Z ddl mZddlmZmZmZmZdd lmZGd d eZd Zed k(reyy))absolute_importdivisionprint_functiona module: gitlab_runner short_description: Create, modify and delete GitLab Runners description: - Register, update and delete runners on GitLab Server side with the GitLab API. - All operations are performed using the GitLab API v4. - For details, consult the full API documentation at U(https://docs.gitlab.com/ee/api/runners.html) and U(https://docs.gitlab.com/ee/api/users.html#create-a-runner-linked-to-a-user). - A valid private API token is required for all operations. You can create as many tokens as you like using the GitLab web interface at U(https://$GITLAB_URL/profile/personal_access_tokens). - A valid registration token is required for registering a new runner. To create shared runners, you need to ask your administrator to give you this token. It can be found at U(https://$GITLAB_URL/admin/runners/). - This module does not handle the C(gitlab-runner) process part, but only manages the runner on GitLab Server side through its API. Once the module has created the runner, you may use the generated token to run C(gitlab-runner register) command. notes: - To create a new runner at least the O(api_token), O(description) and O(api_url) options are required. - Runners need to have unique descriptions, since this attribute is used as key for idempotency. author: - Samy Coenen (@SamyCoenen) - Guillaume Martinez (@Lunik) requirements: - python-gitlab >= 1.5.0 for legacy runner registration workflow (runner registration token - U(https://docs.gitlab.com/runner/register/#register-with-a-runner-registration-token-deprecated)) - python-gitlab >= 4.0.0 for new runner registration workflow (runner authentication token - U(https://docs.gitlab.com/runner/register/#register-with-a-runner-authentication-token)) extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: group: description: - ID or full path of the group in the form group/subgroup. - Mutually exclusive with O(owned) and O(project). - Must be group's numeric ID if O(registration_token) is not set and O(state=present). type: str version_added: '6.5.0' project: description: - ID or full path of the project in the form of group/name. - Mutually exclusive with O(owned) since community.general 4.5.0. - Mutually exclusive with O(group). - Must be project's numeric ID if O(registration_token) is not set and O(state=present). type: str version_added: '3.7.0' description: description: - The unique name of the runner. required: true type: str aliases: - name state: description: - Make sure that the runner with the same name exists with the same configuration or delete the runner with the same name. required: false default: present choices: ["present", "absent"] type: str registration_token: description: - The registration token is used to register new runners before GitLab 16.0. - Required if O(state=present) for GitLab < 16.0. - If set, the runner will be created using the old runner creation workflow. - If not set, the runner will be created using the new runner creation workflow, introduced in GitLab 16.0. - If not set, requires python-gitlab >= 4.0.0. type: str owned: description: - Searches only runners available to the user when searching for existing, when false admin token required. - Mutually exclusive with O(project) since community.general 4.5.0. - Mutually exclusive with O(group). default: false type: bool version_added: 2.0.0 active: description: - Define if the runners is immediately active after creation. - Mutually exclusive with O(paused). required: false default: true type: bool paused: description: - Define if the runners is active or paused after creation. - Mutually exclusive with O(active). required: false default: false type: bool version_added: 8.1.0 locked: description: - Determines if the runner is locked or not. required: false default: false type: bool access_level: description: - Determines if a runner can pick up jobs only from protected branches. - If O(access_level_on_creation) is not explicitly set to V(true), this option is ignored on registration and is only applied on updates. - If set to V(not_protected), runner can pick up jobs from both protected and unprotected branches. - If set to V(ref_protected), runner can pick up jobs only from protected branches. - Before community.general 8.0.0 the default was V(ref_protected). This was changed to no default in community.general 8.0.0. If this option is not specified explicitly, GitLab will use V(not_protected) on creation, and the value set will not be changed on any updates. required: false choices: ["not_protected", "ref_protected"] type: str access_level_on_creation: description: - Whether the runner should be registered with an access level or not. - If set to V(true), the value of O(access_level) is used for runner registration. - If set to V(false), GitLab registers the runner with the default access level. - The default of this option changed to V(true) in community.general 7.0.0. Before, it was V(false). required: false default: true type: bool version_added: 6.3.0 maximum_timeout: description: - The maximum time that a runner has to complete a specific job. required: false default: 3600 type: int run_untagged: description: - Run untagged jobs or not. required: false default: true type: bool tag_list: description: The tags that apply to the runner. required: false default: [] type: list elements: str a - name: Create an instance-level runner community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 state: present active: true tag_list: ['docker'] run_untagged: false locked: false register: runner # Register module output to run C(gitlab-runner register) command in another task - name: Create a group-level runner community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 state: present active: true tag_list: ['docker'] run_untagged: false locked: false group: top-level-group/subgroup register: runner # Register module output to run C(gitlab-runner register) command in another task - name: Create a project-level runner community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 state: present active: true tag_list: ['docker'] run_untagged: false locked: false project: top-level-group/subgroup/project register: runner # Register module output to run C(gitlab-runner register) command in another task - name: "Register instance-level runner with registration token (deprecated)" community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" registration_token: 4gfdsg345 description: Docker Machine t1 state: present active: true tag_list: ['docker'] run_untagged: false locked: false register: runner # Register module output to run C(gitlab-runner register) command in another task - name: "Delete runner" community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 state: absent - name: Delete an owned runner as a non-admin community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 owned: true state: absent - name: "Register a project-level runner with registration token (deprecated)" community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" registration_token: 4gfdsg345 description: MyProject runner state: present project: mygroup/mysubgroup/myproject register: runner # Register module output to run C(gitlab-runner register) command in another task a msg: description: Success or failure message. returned: always type: str sample: "Success" result: description: JSON-parsed response from the server. returned: always type: dict error: description: The error message returned by the GitLab API. returned: failed type: str sample: "400: path is already in use" runner: description: API object. returned: always type: dict )basic_auth_argument_spec) AnsibleModule) to_native)auth_argument_specgitlab_authenticationgitlablist_all_kwargs) LooseVersionc@eZdZd dZdZ dZ dZ dZ dZdZ y) GitLabRunnerNc2||_||_d|_|r|jj|_y|r|jj|_y|j dr|jj|_y|jj|_y)Nowned)_module_gitlab runner_objectrunnerslist_runners_endpointparamsall)selfmodulegitlab_instancegroupprojects s/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/gitlab_runner.py__init__zGitLabRunner.__init__sx & ! %,__%9%9D " %*]]%7%7D " ]]7 #%4%<%<%A%AD "%4%<%<%@%@D "c^d}|d|d|d|dd}|jd |d|d<n|d|d<|jd |d |d <|j||d <|jd  |d |d <nC|jd d|d<|d |d<n$|jdd|d<|d|d<nd|d<|jjd}|s|j d d|j |}d}nh|j |j|\}}|rG|jjr |jjdd|z |j||_|S#t$r2}|jjdt|zYd}~?d}~wwxYw)NFlocked run_untaggedmaximum_timeouttag_list)r#r$r%r&pausedactive access_level descriptionregistration_tokentokenr group_type runner_typegroup_idr project_type project_id instance_typeaccess_level_on_creationTz"Successfully updated the runner %schangedmsgzFailed to update runner: %s r6) getrrrpop create_runner update_runner check_mode exit_jsonsave Exception fail_jsonr)rr*optionsr5 argumentsr3runneres rcreate_or_update_runnerz$GitLabRunner.create_or_update_runner$sh'#N3&'89 +   ;;x ,")("3Ih ")("3Ih  ;;~ & 2(/(?In %    %'2Im ${{/0<%,-A%B '"W%1+7 -((/(8 *%Y'3+9 -(*1)*< ,'+: -('+||':':;U'V $+ nd3'' 2FG"001C1CYOOGV<<**LL**4=ado=o*p^KKM$ !^LL**/MPYZ[P\/\*]]^sE11 F,:(F''F,c2|jjry |jd'|jjj |}|St tjt dkr|jjdS|jjjj |} |S#tjj$r3}|jjdt|zYd}~Sd}~wwxYw)NTr,z4.0.0zCNew runner creation workflow requires python-gitlab 4.0.0 or higherr7zFailed to create runner: %s )rr<r8rrcreater r __version__r@user exceptionsGitlabCreateErrorr)rrBrCrDs rr:zGitLabRunner.create_runnerZs << " " V}}W%1--44Y? f001L4II &&+p&q  **2299)D !!33 V LL " "'E RS 'T " U U  Vs$6CAC/CD#(DDc*d}|jD]{\}}| t|trDt||}|j |}|j ||k7sMt |||d}]t|||k7smt |||d}}||fS)NFT)items isinstancergetattrsortsetattr)rrCrBr5arg_key arg_valuelist1list2s rr;zGitLabRunner.update_runnerns"+//"3 ' GY$i.#FG4EJJL%EJJL~;"&vw/9<;"& '  r!c<|jdit}|D]}t|drA|j|k(s|jj j |jcS|d|k(sY|jj j |dcSy)Nr*id)rr hasattrr*rrr8rW)rr*rrCs r find_runnerzGitLabRunner.find_runners($((;?; BFv}-&&+5<<//33FII>>=)[8<<//33F4LAA Br!c:|j|}|r||_yy)NTF)rZr)rr*rCs r exists_runnerzGitLabRunner.exists_runners#!!+. !'D r!ch|jjry|j}|jS)NT)rr<rdelete)rrCs r delete_runnerzGitLabRunner.delete_runners) << " "##}}r!)NN) __name__ __module__ __qualname__r rEr:r;rZr\r_rXr!rrrs<A"1f !( Br!rct}|jt|jttdddgtddtddtddtddg tddtddtdd d g tddtd dtddtdtdtddddgt |ddgddgddgddgddgddgddgddgddgg ddgggdgd }t |}|j d!}|j d"}|j d}|j d}|j d#}|j d$}|j d%} |j d&} |j d'} |j d(} |j d} |j d}d}d}| r |jj| }n|r |jj|}t||||}|j!|}|dk(r<|r'|j#|j%dd,|z-n|j%dd.-|dk(r|||| | | | || d/ }t'|j(j+d0t'd1k\r||d<|j-||r,|j%d|j.j0d2|z3y|j%d|j.j0d4|z3yy#tjj$r*}|jd)| zt|*Yd}~Ud}~wwxYw#tjj$r*}|jd+|zt|*Yd}~d}~wwxYw)5NstrTname)typerequiredaliasesbool)rfdefaultFr)rfelementsrj not_protected ref_protected)rfchoicesinti)rfno_log)rfpresentabsent)rfrjrn)r*r(r'rr&r$r#r)r3r%r+rrstate api_username api_tokenapi_oauth_token api_job_tokenrrrr(r' api_password)rtrurvrw) argument_specmutually_exclusiverequired_togetherrequired_one_ofsupports_check_modersr*r&r$r#r)r%r+zNo such a project %s)r6 exceptionzNo such a group %szSuccessfully deleted runner %sr4z!Runner deleted or does not exists) r(r&r$r#r)r%r+rrrz14.8.0z-Successfully created or updated the runner %s)r5rCr6zNo need to update the runner %s)rupdater dictrr rprojectsr8r rJGitlabGetErrorr@rgroupsrr\r_r=r rversionrEr_attrs)ryrrrsrunner_description runner_active runner_pausedr&r$ runner_lockedr)r%r+rrgitlab_project gitlab_grouprD gitlab_runner runner_exists runner_valuess rmainrs,.M+-.edVHE./.6E2>vt4/u.PQ!%64!@%6U48% y8Y:OP"# [ ) . / _ - + , / *  g   x   ^ ,  N !'F.,F3O MM' "E}5MM(+MMM(+M}}Z(H==0LMM(+M==0Lmm$56O';<mmI&G MM' "ENL [,5599'BN  W*1155ersrA@ Q fL \ 0>4A \R6RjfYR zFr!