Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-24 06:59:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add installation instructions for the Windows CLI variant

Browse Source
This commit is contained in:
Malte Poll 2024-03-06 10:23:31 +01:00
parent 483c888a3c
commit 52e4e64316
4 changed files with 56 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/getting-started/install.md
View File

@ -6,7 +6,7 @@ Constellation runs entirely in your cloud environment and can be controlled via
Make sure the following requirements are met: 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 * You have admin rights on your machine
* [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed * [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed
* Your CSP is Microsoft Azure, Google Cloud Platform (GCP), Amazon Web Services (AWS), or STACKIT * 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 sudo install constellation-darwin-amd64 /usr/local/bin/constellation
``` ```
</tabItem>
<tabItem value="windows-amd64" label="Windows (amd64)">
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`
</tabItem> </tabItem>
</tabs> </tabs>

4
docs/docs/workflows/verify-cli.md
View File

@ -33,6 +33,10 @@ You don't need to verify the Constellation node images. This is done automatical
## Verify the signature ## 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: 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 ```shell-session

25
docs/versioned_docs/version-2.16/getting-started/install.md
View File

@ -6,7 +6,7 @@ Constellation runs entirely in your cloud environment and can be controlled via
Make sure the following requirements are met: 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 * You have admin rights on your machine
* [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed * [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed
* Your CSP is Microsoft Azure, Google Cloud Platform (GCP), Amazon Web Services (AWS), or STACKIT * 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 sudo install constellation-darwin-amd64 /usr/local/bin/constellation
``` ```
</tabItem>
<tabItem value="windows-amd64" label="Windows (amd64)">
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`
</tabItem> </tabItem>
</tabs> </tabs>

4
docs/versioned_docs/version-2.16/workflows/verify-cli.md
View File

@ -33,6 +33,10 @@ You don't need to verify the Constellation node images. This is done automatical
## Verify the signature ## 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: 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 ```shell-session