From 52e4e64316c8e310bbdb93bca0945d8ac49d5c57 Mon Sep 17 00:00:00 2001
From: Malte Poll <1780588+malt3@users.noreply.github.com>
Date: Wed, 6 Mar 2024 10:23:31 +0100
Subject: [PATCH] docs: add installation instructions for the Windows CLI
variant
---
docs/docs/getting-started/install.md | 25 ++++++++++++++++++-
docs/docs/workflows/verify-cli.md | 4 +++
.../version-2.16/getting-started/install.md | 25 ++++++++++++++++++-
.../version-2.16/workflows/verify-cli.md | 4 +++
4 files changed, 56 insertions(+), 2 deletions(-)
diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md
index 8d41e3c8e..94110617c 100644
--- a/docs/docs/getting-started/install.md
+++ b/docs/docs/getting-started/install.md
@@ -6,7 +6,7 @@ Constellation runs entirely in your cloud environment and can be controlled via
Make sure the following requirements are met:
-* Your machine is running Linux or macOS
+* Your machine is running Linux, macOS, or Windows
* You have admin rights on your machine
* [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed
* Your CSP is Microsoft Azure, Google Cloud Platform (GCP), Amazon Web Services (AWS), or STACKIT
@@ -92,6 +92,29 @@ curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/c
sudo install constellation-darwin-amd64 /usr/local/bin/constellation
```
+
+
+
+
+1. Download the CLI:
+
+```bash
+Invoke-WebRequest -OutFile ./constellation.exe -Uri 'https://github.com/edgelesssys/constellation/releases/latest/download/constellation-windows-amd64.exe'
+```
+
+2. [Verify the signature](../workflows/verify-cli.md) (optional)
+
+3. Install the CLI under `C:\Program Files\Constellation\bin\constellation.exe`
+
+3. Add the CLI to your PATH:
+
+ 1. Open `Advanced system settings` by searching for the App in the Windows search
+ 2. Go to the `Advanced` tab
+ 3. Click `Environment Variables…`
+ 4. Click variable called `Path` and click `Edit…`
+ 5. Click `New`
+ 6. Enter the path to the folder containing the binary you want on your PATH: `C:\Program Files\Constellation\bin`
+
diff --git a/docs/docs/workflows/verify-cli.md b/docs/docs/workflows/verify-cli.md
index 1280c51b0..78341f314 100644
--- a/docs/docs/workflows/verify-cli.md
+++ b/docs/docs/workflows/verify-cli.md
@@ -33,6 +33,10 @@ You don't need to verify the Constellation node images. This is done automatical
## Verify the signature
+:::info
+This guide assumes Linux on an amd64 processor. The exact steps for other platforms differ slightly.
+:::
+
First, [install the Cosign CLI](https://docs.sigstore.dev/system_config/installation). Next, [download](https://github.com/edgelesssys/constellation/releases) and verify the signature that accompanies your CLI executable, for example:
```shell-session
diff --git a/docs/versioned_docs/version-2.16/getting-started/install.md b/docs/versioned_docs/version-2.16/getting-started/install.md
index 8d41e3c8e..94110617c 100644
--- a/docs/versioned_docs/version-2.16/getting-started/install.md
+++ b/docs/versioned_docs/version-2.16/getting-started/install.md
@@ -6,7 +6,7 @@ Constellation runs entirely in your cloud environment and can be controlled via
Make sure the following requirements are met:
-* Your machine is running Linux or macOS
+* Your machine is running Linux, macOS, or Windows
* You have admin rights on your machine
* [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed
* Your CSP is Microsoft Azure, Google Cloud Platform (GCP), Amazon Web Services (AWS), or STACKIT
@@ -92,6 +92,29 @@ curl -LO https://github.com/edgelesssys/constellation/releases/latest/download/c
sudo install constellation-darwin-amd64 /usr/local/bin/constellation
```
+
+
+
+
+1. Download the CLI:
+
+```bash
+Invoke-WebRequest -OutFile ./constellation.exe -Uri 'https://github.com/edgelesssys/constellation/releases/latest/download/constellation-windows-amd64.exe'
+```
+
+2. [Verify the signature](../workflows/verify-cli.md) (optional)
+
+3. Install the CLI under `C:\Program Files\Constellation\bin\constellation.exe`
+
+3. Add the CLI to your PATH:
+
+ 1. Open `Advanced system settings` by searching for the App in the Windows search
+ 2. Go to the `Advanced` tab
+ 3. Click `Environment Variables…`
+ 4. Click variable called `Path` and click `Edit…`
+ 5. Click `New`
+ 6. Enter the path to the folder containing the binary you want on your PATH: `C:\Program Files\Constellation\bin`
+
diff --git a/docs/versioned_docs/version-2.16/workflows/verify-cli.md b/docs/versioned_docs/version-2.16/workflows/verify-cli.md
index 1280c51b0..78341f314 100644
--- a/docs/versioned_docs/version-2.16/workflows/verify-cli.md
+++ b/docs/versioned_docs/version-2.16/workflows/verify-cli.md
@@ -33,6 +33,10 @@ You don't need to verify the Constellation node images. This is done automatical
## Verify the signature
+:::info
+This guide assumes Linux on an amd64 processor. The exact steps for other platforms differ slightly.
+:::
+
First, [install the Cosign CLI](https://docs.sigstore.dev/system_config/installation). Next, [download](https://github.com/edgelesssys/constellation/releases) and verify the signature that accompanies your CLI executable, for example:
```shell-session