fix(docs): add remote Docker host instructions

matifali · matifali · commit d3a3a89fd262 · 2024-11-13T11:42:41.000Z
Add information on using a remote Docker host in the provider
authentication documentation. Include methods to configure the Docker
provider to connect via SSH or TCP and the option to run an external
provisioner on the remote host. This update enhances clarity and
usability for users managing remote Docker environments.
diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml
@@ -16,6 +16,8 @@ permissions:
 jobs:
   check-docs:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # required to post PR review comments by the action
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
diff --git a/docs/admin/templates/extending-templates/provider-authentication.md b/docs/admin/templates/extending-templates/provider-authentication.md
@@ -44,6 +44,16 @@ environments:
 - [Kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs)
 - [Docker](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs)
 
+## Using remote Docker host
+
+You can use a remote Docker host in 2 ways.
+
+1. Configuring docker provider to use a
+   [remote host](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts)
+   over SSH or TCP.
+2. Running an [external provisioner](../../provisioners.md) on the remote docker
+   host.
+
 Other providers might also support authenticated environments. Check the
 [documentation of the Terraform provider](https://registry.terraform.io/browse/providers)
 for details.
