add example for windows runner

aktech · aktech · commit 884fad7cf8f7 · 2024-02-26T11:09:24.000Z
diff --git a/docs/os-platform/_category_.json b/docs/os-platform/_category_.json
@@ -0,0 +1,7 @@
+{
+  "label": "OS Platform",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}
diff --git a/docs/os-platform/index.md b/docs/os-platform/index.md
@@ -0,0 +1,6 @@
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+# OS Platform
+
+<DocCardList items={useCurrentSidebarCategory().items}/>
diff --git a/docs/os-platform/windows.md b/docs/os-platform/windows.md
@@ -0,0 +1,58 @@
+---
+id: windows
+description: Cirun Documentation - Windows Runner.
+image: "https://cirun.io/cirun-summary-image-v4.png"
+keywords: [Cirun, Windows, ]
+---
+
+# Windows
+
+<head>
+  <body className="other-extra-body-class" />
+  <title>Cirun Docs</title>
+  <meta data-rh="true" name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:site" content="https://docs.cirun.io" />
+  <meta name="twitter:title" content="Cirun Documentation" />
+  <meta name="twitter:description" content="Cirun Documentation - Custom Images for Runner." />
+  <meta name="twitter:image" content="https://docs.cirun.io/img/cirun-summary-image-v4.png" />
+</head>
+
+You can use windows operating system for your runners as well. Here are a couple of examples
+of creating windows runner on Azure and AWS:
+
+## Azure
+
+:::note
+
+The spinup time of windows runners on Azure is higher than AWS.
+
+:::
+
+```yaml
+runners:
+  - name: "azure-windows-runner"
+    cloud: "azure"
+    region: "uksouth"
+    instance_type: "Standard_D2s_v3"
+    machine_image:
+      publisher: microsoftwindowsdesktop
+      offer: windows-11
+      sku: win11-22h2-pro
+      version: latest
+    labels:
+      - "cirun-azure-windows-runner"
+```
+
+
+## AWS
+
+```yaml
+runners:
+  - name: "aws-windows-runner"
+    cloud: "aws"
+    region: "us-east-1"
+    instance_type: "t2.medium"
+    machine_image: "ami-0f9c44e98edf38a2b"
+    labels:
+     - "cirun-aws-windows-runner"
+```
diff --git a/sidebars.js b/sidebars.js
@@ -62,6 +62,14 @@ module.exports = {
         "custom-images/arm-based-machines",
       ],
     },
+    {
+      type: "category",
+      label: "OS Platform",
+      link: { type: "doc", id: "os-platform/index" },
+      items: [
+        "os-platform/windows",
+      ],
+    },
     {
       type: "doc",
       label: "Privacy",
