Switch from GitLab API v1 to GitLab API v4

Author: drybjed

CHANGES.rst

@@ -16,6 +16,11 @@ The current role maintainer_ is drybjed.
 
 .. _debops.gitlab_runner master: https://github.com/debops/ansible-gitlab_runner/compare/v0.2.0...master
 
+Changed
+~~~~~~~
+
+- Switch from GitLab API v1 to GitLab API v4 for Runner management. [drybjed_]
+
 
 `debops.gitlab_runner v0.2.0`_ - 2017-08-16
 -------------------------------------------

defaults/main.yml

@@ -134,9 +134,18 @@ gitlab_runner__api_fqdn: 'code.{{ gitlab_runner__domain }}'
                                                                    # ]]]
 # .. envvar:: gitlab_runner__api_url [[[
 #
-# The HTTP API endpoint of the GitLab CI server to use for Runner registration.
+# The HTTP API endpoint of the GitLab CI server.
 # The role will check if the API server is available before trying to use it.
-gitlab_runner__api_url: 'https://{{ gitlab_runner__api_fqdn }}/ci'
+gitlab_runner__api_url: 'https://{{ gitlab_runner__api_fqdn }}/'
+
+                                                                   # ]]]
+# .. envvar:: gitlab_runner__api_token [[[
+#
+# The personal GitLab API access token used for API operations, for example
+# removal of existing Runners. This is not a Runner registration token. You can
+# generate an access token in GitLab "User Settings", "Access Tokens"
+# configuration page.
+gitlab_runner__api_token: ''
 
                                                                    # ]]]
 # .. envvar:: gitlab_runner__executor [[[

tasks/main.yml

@@ -96,7 +96,7 @@
 
 - name: Register new GitLab Runners
   uri:
-    url: '{{ (item.api_url | d(gitlab_runner__api_url)) + "/api/v1/runners/register.json" }}'
+    url: '{{ (item.api_url | d(gitlab_runner__api_url)) + "api/v4/runners" }}'
     method: 'POST'
     body: 'token={{ item.token | d(gitlab_runner__token) }}&description={{ item.name | urlencode }}&tag_list={{ ((item.tags|d([]) + (gitlab_runner__shell_tags if (item.executor == "shell") else []) + gitlab_runner__combined_tags) | unique | join(",")) | urlencode }}&run_untagged={{ item.run_untagged | d(gitlab_runner__run_untagged) }}'
     status_code: '200,201'
@@ -125,16 +125,18 @@
 
 - name: Delete GitLab Runners if requested
   uri:
-    url: '{{ (item.0.api_url | d(gitlab_runner__api_url)) + "/api/v1/runners/delete" }}'
+    url: '{{ (item.0.api_url | d(gitlab_runner__api_url)) + "api/v4/runners/" + item.1.id | string }}'
     method: 'DELETE'
-    body: 'token={{ item.1.token }}'
+    headers:
+      'PRIVATE-TOKEN': '{{ gitlab_runner__api_token }}'
   with_together:
     - '{{ gitlab_runner__default_instances + gitlab_runner__instances + gitlab_runner__group_instances + gitlab_runner__host_instances }}'
     - '{{ ansible_local.gitlab_runner.instance_tokens if (ansible_local|d() and ansible_local.gitlab_runner|d() and ansible_local.gitlab_runner.instance_tokens|d()) else [] }}'
   when: (gitlab_runner__register_api.status|d() and gitlab_runner__register_api.status == 200 and
-         item.0.name|d() and item.1.name|d() and item.0.name == item.1.name and
+         gitlab_runner__api_token and item.0.name|d() and item.1.name|d() and item.0.name == item.1.name and
          (item.0.state|d() and item.0.state == 'absent'))
   failed_when: False
+  no_log: True
 
 - name: Get the SSH key from the remote host
   slurp:

templates/etc/gitlab-runner/ansible.json.j2

@@ -2,9 +2,9 @@
 {% set gitlab_runner__tpl_instance_tokens = [] %}
 {% if gitlab_runner__register_new_instances|d() and gitlab_runner__register_new_instances.results %}
 {%   for item in gitlab_runner__register_new_instances.results %}
-{%     if item.item.name|d() and item.json|d() and item.json.token|d() %}
+{%     if item.item.name|d() and item.json|d() and item.json.id|d() and item.json.token|d() %}
 {%       set _ = gitlab_runner__tpl_instances.append(item.item.name) %}
-{%       set _ = gitlab_runner__tpl_instance_tokens.append({ "name": item.item.name, "token": item.json.token }) %}
+{%       set _ = gitlab_runner__tpl_instance_tokens.append({ "id": item.json.id, "name": item.item.name, "token": item.json.token }) %}
 {%     endif %}
 {%   endfor %}
 {% endif %}
@@ -14,7 +14,7 @@
 {%       for element in (gitlab_runner__default_instances + gitlab_runner__instances + gitlab_runner__group_instances + gitlab_runner__host_instances) %}
 {%         if (item.name == element.name and (element.state is undefined or element.state != 'absent')) %}
 {%           set _ = gitlab_runner__tpl_instances.append(item.name) %}
-{%           set _ = gitlab_runner__tpl_instance_tokens.append({ "name": item.name, "token": item.token }) %}
+{%           set _ = gitlab_runner__tpl_instance_tokens.append({ "id": item.id, "name": item.name, "token": item.token }) %}
 {%         endif %}
 {%       endfor %}
 {%     endif %}