From 759a340bfcfd83a9c03be97670d83115b6d451e2 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 13 Nov 2024 14:55:41 +0500 Subject: [PATCH 1/4] docs: add Docker to provider authentication docs --- .../templates/extending-templates/provider-authentication.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/admin/templates/extending-templates/provider-authentication.md b/docs/admin/templates/extending-templates/provider-authentication.md index 770aeb3179927..5033742ef90e0 100644 --- a/docs/admin/templates/extending-templates/provider-authentication.md +++ b/docs/admin/templates/extending-templates/provider-authentication.md @@ -42,6 +42,7 @@ environments: - [Amazon Web Services](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) - [Microsoft Azure](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs) - [Kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs) +- [Docker](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs) Other providers might also support authenticated environments. Check the [documentation of the Terraform provider](https://registry.terraform.io/browse/providers) From d3a3a89fd2627a1628ad57c0578a41005d585578 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 13 Nov 2024 15:52:53 +0500 Subject: [PATCH 2/4] fix(docs): add remote Docker host instructions 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. --- .github/workflows/weekly-docs.yaml | 2 ++ .../extending-templates/provider-authentication.md | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml index d66503e2552ed..f55f344941081 100644 --- 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 index 5033742ef90e0..027a27ae0cb85 100644 --- 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. From b4aa70e6220baae73efee89dd1d720528bc30a34 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 13 Nov 2024 20:31:35 +0500 Subject: [PATCH 3/4] Update docs/admin/templates/extending-templates/provider-authentication.md Co-authored-by: Edward Angert --- .../extending-templates/provider-authentication.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/admin/templates/extending-templates/provider-authentication.md b/docs/admin/templates/extending-templates/provider-authentication.md index 027a27ae0cb85..4a7c753cef2cc 100644 --- a/docs/admin/templates/extending-templates/provider-authentication.md +++ b/docs/admin/templates/extending-templates/provider-authentication.md @@ -44,15 +44,13 @@ 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 +## Use a remote Docker host for authentication -You can use a remote Docker host in 2 ways. +There are two ways to use a remote Docker host for authentication: -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. +- Configure the Docker provider to use a + [remote host over SSH or TCP](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts). +- Run 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) From 26e0650a48d7a75179adf9eb607a1ecaf96b2334 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 13 Nov 2024 15:37:11 +0000 Subject: [PATCH 4/4] make fmt --- .../templates/extending-templates/provider-authentication.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/admin/templates/extending-templates/provider-authentication.md b/docs/admin/templates/extending-templates/provider-authentication.md index 4a7c753cef2cc..c2fe8246610bb 100644 --- a/docs/admin/templates/extending-templates/provider-authentication.md +++ b/docs/admin/templates/extending-templates/provider-authentication.md @@ -49,8 +49,9 @@ environments: There are two ways to use a remote Docker host for authentication: - Configure the Docker provider to use a - [remote host over SSH or TCP](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts). -- Run an [external provisioner](../../provisioners.md) on the remote docker host. + [remote host over SSH or TCP](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts). +- Run 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)