From 28f41b2e51e5f4128acb5861452ae543211c0ef3 Mon Sep 17 00:00:00 2001 From: t-miyak Date: Tue, 17 Dec 2024 20:03:07 +0900 Subject: [PATCH] docs: update README --- modules/gh-runner-gke/README.md | 1 + modules/gh-runner-mig-container-vm/README.md | 2 ++ modules/gh-runner-mig-vm/README.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/modules/gh-runner-gke/README.md b/modules/gh-runner-gke/README.md index 9862b89..ccfdeba 100644 --- a/modules/gh-runner-gke/README.md +++ b/modules/gh-runner-gke/README.md @@ -102,6 +102,7 @@ This example shows how to deploy Self Hosted Runners on GKE that supports Docker | project\_id | The project id to deploy Github Runner cluster | `string` | n/a | yes | | region | The GCP region to deploy instances into | `string` | `"us-east4"` | no | | service\_account | Optional Service Account for the nodes | `string` | `""` | no | +| spot | A boolean that represents whether the underlying node VMs are spot | `bool` | `false` | no | | subnet\_ip | IP range for the subnet | `string` | `"10.0.0.0/17"` | no | | subnet\_name | Name for the subnet | `string` | `"runner-subnet"` | no | | subnetwork\_project | The ID of the project in which the subnetwork belongs. If it is not provided, the project\_id is used. | `string` | `""` | no | diff --git a/modules/gh-runner-mig-container-vm/README.md b/modules/gh-runner-mig-container-vm/README.md index f08391c..ef0b0fb 100644 --- a/modules/gh-runner-mig-container-vm/README.md +++ b/modules/gh-runner-mig-container-vm/README.md @@ -41,6 +41,8 @@ This example shows how to deploy a Self Hosted Runner on MIG Container VMs. | repo\_url | Repo URL for the Github Action | `string` | n/a | yes | | restart\_policy | The desired Docker restart policy for the runner image | `string` | `"Always"` | no | | service\_account | Service account email address | `string` | `""` | no | +| spot | Provision a SPOT instance | `bool` | `false` | no | +| spot\_instance\_termination\_action | Action to take when Compute Engine preempts a Spot VM. | `string` | `"STOP"` | no | | subnet\_ip | IP range for the subnet | `string` | `"10.10.10.0/24"` | no | | subnet\_name | Name for the subnet | `string` | `"gh-runner-subnet"` | no | | subnetwork\_project | The ID of the project in which the subnetwork belongs. If it is not provided, the project\_id is used. | `string` | `""` | no | diff --git a/modules/gh-runner-mig-vm/README.md b/modules/gh-runner-mig-vm/README.md index ec6fb16..f95dfd9 100644 --- a/modules/gh-runner-mig-vm/README.md +++ b/modules/gh-runner-mig-vm/README.md @@ -48,6 +48,8 @@ This example shows how to deploy a MIG Self Hosted Runner with an image pre-bake | source\_image | Source disk image. If neither source\_image nor source\_image\_family is specified, defaults to the latest public CentOS image. | `string` | `""` | no | | source\_image\_family | Source image family. If neither source\_image nor source\_image\_family is specified, defaults to the latest public Ubuntu image. | `string` | `"ubuntu-1804-lts"` | no | | source\_image\_project | Project where the source image comes from | `string` | `"ubuntu-os-cloud"` | no | +| spot | Provision a SPOT instance | `bool` | `false` | no | +| spot\_instance\_termination\_action | Action to take when Compute Engine preempts a Spot VM. | `string` | `"STOP"` | no | | startup\_script | User startup script to run when instances spin up | `string` | `""` | no | | subnet\_ip | IP range for the subnet | `string` | `"10.10.10.0/24"` | no | | subnet\_name | Name for the subnet | `string` | `"gh-runner-subnet"` | no |