Merge pull request #9 from cocallaw/example_docs

Update Example Documentation
cocallaw · Sep 7, 2022 · 2939fb5 · 2939fb5
2 parents 5c4026d + a298d96
commit 2939fb5
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 0 deletions.
diff --git a/examples/ACR-Image/README.md b/examples/ACR-Image/README.md
@@ -0,0 +1,27 @@
+## Deployment using Azure Container Registry (ACR)
+
+The example below shows the required variables needed to deploy the solution when pulling the Subnet Router Tailscale container from an Azure Container Registry instance. The container must be built and pushed to ACR before deployment occurs.
+
+```hcl
+module "subnet_router" {
+  source  = "cocallaw/tailscale-subnet-router/azure"
+  version = "1.2.0"
+
+  resource_group_name               = "myresourcegroup"
+  vnet_name                         = "myvnet"
+  subnet_name                       = "mysubnet"
+  storage_account_name              = "mystorageacct"
+  container_name                    = "mycontainer"
+  container_size                    = "small"
+  container_group_name              = "mycontainergroup"
+  container_source                  = "ACR"
+  tailscale_ACR_repository          = "myacr.azurecr.io/tailscale"
+  tailscale_image_tag               = "latest"
+  tailscale_ACR_repository_username = "myacrusername"
+  tailscale_ACR_repository_password = "supersecretP@ssw0rd"
+  tailscale_hostname                = "mytailscalehostname"
+  tailscale_advertise_routes        = "10.0.0.0/24"
+  tailscale_auth_key                = "tskey-1234567890-ABCDEFGHIJKLMNOPQRSTUVXYZ"
+}
+
+```
diff --git a/examples/DockerHub-Image/README.md b/examples/DockerHub-Image/README.md
@@ -0,0 +1,23 @@
+## Deployment using Docker Hub Pre Built Container
+
+The example below shows the required variables needed to deploy the solution when pulling the Subnet Router Tailscale container from [cocallaw/tailscale-sr on Docker Hub][1]
+
+```hcl
+module "subnet_router" {
+  source  = "cocallaw/tailscale-subnet-router/azure"
+  version = "1.2.0"
+
+  resource_group_name               = "myresourcegroup"
+  vnet_name                         = "myvnet"
+  subnet_name                       = "mysubnet"
+  storage_account_name              = "mystgacct"
+  container_name                    = "mycontainer"
+  container_size                    = "small"
+  container_group_name              = "mycontainergroup"
+  tailscale_hostname                = "mytailscalehostname"
+  tailscale_advertise_routes        = "10.0.0.0/24"
+  tailscale_auth_key                = "tskey-1234567890-ABCDEFGHIJKLMNOPQRSTUVXYZ"
+}
+```
+
+[1]: https://hub.docker.com/r/cocallaw/tailscale-sr