Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v14] docs: Add troubleshooting step around case insensitive routing to Ansible guides #46861

Merged
merged 5 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@
"Mqgcq",
"Multifactor",
"Multihost",
"MYHOSTNAME",
"Mzgz",
"NOFILE",
"NOKEY",
Expand Down
28 changes: 28 additions & 0 deletions docs/pages/enroll-resources/machine-id/access-guides/ansible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,34 @@ If `ssh` works, try running the playbook with verbose mode on:
$ ansible-playbook -vvv playbook.yaml
```

If your hostnames contain uppercase characters (like `MYHOSTNAME`), please note that Teleport's internal hostname matching
is case sensitive by default, which can also lead to seeing this error.

If this is the case, you can work around this by enabling case-insensitive routing at the cluster level.

<Tabs>
<TabItem label="Self-hosted Teleport">

Edit your `/etc/teleport.yaml` config file on all servers running the Teleport `auth_service`, then restart Teleport on each.

```yaml
auth_service:
case_insensitive_routing: true
```

</TabItem>
<TabItem label="Managed Teleport Enterprise/Cloud">

Run `tctl edit cluster_networking_config` to add the following specification, then save and exit.

```yaml
spec:
case_insensitive_routing: true
```

</TabItem>
</Tabs>

## Next steps

- Read the [configuration reference](../../../reference/machine-id/configuration.mdx) to explore
Expand Down
32 changes: 30 additions & 2 deletions docs/pages/enroll-resources/server-access/guides/ansible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ to a valid SSH username that works with the target host and is allowed by Telepo
From the folder `ansible`, run the ansible playbook:

```code
$ ansible-playbook playbook.yaml
$ ansible-playbook playbook.yaml

# PLAY [all] *****************************************************************************************************************************************
# TASK [Gathering Facts] *****************************************************************************************************************************
Expand All @@ -106,7 +106,7 @@ all ansible commands in the audit log.

## Troubleshooting

In case if ansible can not connect, you may see error like this one:
In cases where Ansible cannot connect, you may see an error like this:

```txt
example.host | UNREACHABLE! => {
Expand All @@ -129,3 +129,31 @@ If `ssh` works, try running the playbook with verbose mode on:
```code
$ ansible-playbook -vvvv playbook.yaml
```

If your hostnames contain uppercase characters (like `MYHOSTNAME`), please note that Teleport's internal hostname matching
is case sensitive by default, which can also lead to seeing this error.

If this is the case, you can work around this by enabling case-insensitive routing at the cluster level.

<Tabs>
<TabItem label="Self-hosted Teleport">

Edit your `/etc/teleport.yaml` config file on all servers running the Teleport `auth_service`, then restart Teleport on each.

```yaml
auth_service:
case_insensitive_routing: true
```

</TabItem>
<TabItem label="Managed Teleport Enterprise/Cloud">

Run `tctl edit cluster_networking_config` to add the following specification, then save and exit.

```yaml
spec:
case_insensitive_routing: true
```

</TabItem>
</Tabs>
Loading