The document for google.cloud.iap connection is broken

[khurley]

The document explaining google.cloud.iap connection is broken. There is no information being displayed about anything.

It would be very helpful to have a working example on this page of how to establish a connection to GCP nodes from an outside node running an Ansible process.

ISSUE TYPE

• Documentation Report

COMPONENT NAME

ANSIBLE VERSION

[sambilbow]

This is the broken documentation: https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/iap_connection.html

[sambilbow]

There is a README.md here by the way. (plugins/connection/README.md).

A few 'gotchas' I found, since I wanted to use gcloud sdk user (auth_kind=account) not serviceaccount:

• inventory file must be named <name>.gcp.yml source
• put connection: google.cloud.iap in your playbook otherwise it uses default SSH.
• put remote_user: <username> (UNIX username) in your playbook as well as your gcloud account username in ansible.cfg, otherwise it passes your local device's username in SSH

Here's a minimal working example:

ansible.cfg

[gcloud]
account = <replace with gcloud account>
project = <replace with project>
region = <replace with region>
zone = <replace with zone>

[defaults]
inventory = <replace with name>.gcp.yml
interpreter_python = auto_silent
deprecation_warnings = false
remote_user = <replace with UNIX user>

[inventory]
enable_plugins = google.cloud.gcp_compute

inventory.gcp.yml

plugin: google.cloud.gcp_compute
zones:
  - <replace with zone>
projects:
  - <replace with project>
auth_kind: application # use serviceaccount if you want
scopes:
  - 'https://www.googleapis.com/auth/cloud-platform'
  - 'https://www.googleapis.com/auth/compute.readonly'
hostnames:
  - name
compose:
  ansible_gcloud_zone: zone
filters:
  - 'status = RUNNING'
  - 'name = <replace with instance name>'

playbooks/main.yml

- name: "Connect to GCP"
  hosts: all
  # Without this connection I get 'Task failed: Failed to connect to the host via ssh: ssh: Could not resolve hostname <compute engine instance name>
  connection: google.cloud.iap 
  tasks:
    - name: "Retrieve hostname"
      changed_when: false
      ansible.builtin.command:
        cmd: hostname
      register: hostname_output

    - name: "Debug hostname"
      ansible.builtin.debug:
        var: hostname_output.stdout