Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-08-15 10:15:33 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarify permissions on install page (#184)

Browse source 
* docs: clarify permissions on install page

* docs: remove default attribute from tabs

* docs: publish to 2.0
This commit is contained in:
Thomas Tendyck 2022-09-21 16:58:04 +02:00 • committed by GitHub
parent 029e6783a3
commit 811ccc80a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 128 additions and 136 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/workflows/create.md
View file

@ -25,14 +25,14 @@ You can find the currently supported machine types for your cloud environment in
Constellation can generate a configuration file for your cloud provider:
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
```bash
constellation config generate azure
```
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
```bash
constellation config generate gcp

4
docs/docs/workflows/recovery.md
View file

@ -18,7 +18,7 @@ Constellation provides logging information on the boot process and status via [c
In the following, you'll find detailed descriptions for identifying clusters stuck in recovery for each cloud environment.
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
In the Azure cloud portal find the cluster's resource group `<cluster-name>-<suffix>`
Inside the resource group check that the control plane *Virtual machine scale set* `constellation-scale-set-controlplanes-<suffix>` has enough members in a *Running* state.
@ -54,7 +54,7 @@ If that fails, because the control plane is unhealthy, you will see log messages
This means that you have to recover the node manually. For this, you need its IP address, which can be obtained from the *Overview* page under *Private IP address*.
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
First, check that the control plane *Instance Group* has enough members in a *Ready* state.
Go to *Instance Groups* and check the group for the cluster's control plane `<cluster-name>-control-plane-<suffix>`.

8
docs/docs/workflows/scale.md
View file

@ -49,7 +49,7 @@ kubectl -n kube-system get nodes
Alternatively, you can choose to manually scale your cluster up or down:
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. Find your Constellation resource group.
2. Select the `scale-set-workers`.
@ -57,7 +57,7 @@ Alternatively, you can choose to manually scale your cluster up or down:
4. Set the new **instance count** and **save**.
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. In Compute Engine go to [Instance Groups](https://console.cloud.google.com/compute/instanceGroups/).
2. **Edit** the **worker** instance group.
@ -74,7 +74,7 @@ To increase the number of control-plane nodes, follow these steps:
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. Find your Constellation resource group.
2. Select the `scale-set-controlplanes`.
@ -82,7 +82,7 @@ To increase the number of control-plane nodes, follow these steps:
4. Set the new (increased) **instance count** and **save**.
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. In Compute Engine go to [Instance Groups](https://console.cloud.google.com/compute/instanceGroups/).
2. **Edit** the **control-plane** instance group.

14
docs/docs/workflows/storage.md
View file

@ -22,14 +22,14 @@ For more details see [encrypted persistent storage](../architecture/encrypted-st
Constellation supports the following drivers, which offer node-level encryption and optional integrity protection.
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. [Azure Disk Storage](https://github.com/edgelesssys/constellation-azuredisk-csi-driver)
Mount Azure [Disk Storage](https://azure.microsoft.com/en-us/services/storage/disks/#overview) into your Constellation cluster. See the example below on how to install the modified Azure Disk CSI driver or check out the [repository](https://github.com/edgelesssys/constellation-azuredisk-csi-driver) for installation and more information about the Constellation-managed version of the driver. Since Azure Disks are mounted as ReadWriteOnce, they're only available to a single pod.
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. [Persistent Disk](https://github.com/edgelesssys/constellation-gcp-compute-persistent-disk-csi-driver):
@ -48,7 +48,7 @@ Note that in case the options above aren't a suitable solution for you, Constell
The following installation guide gives an overview of how to securely use CSI-based cloud storage for persistent volumes in Constellation.
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. Install the CSI driver:
@ -82,7 +82,7 @@ The following installation guide gives an overview of how to securely use CSI-ba
```
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. Install the CSI driver:
@ -111,7 +111,7 @@ The following installation guide gives an overview of how to securely use CSI-ba
volumeBindingMode: WaitForFirstConsumer
EOF
```
</tabItem>
</tabs>
@ -176,7 +176,7 @@ By default, integrity protection is disabled for performance reasons. If you wan
The examples above are defined to be automatically set as the default storage class. The default storage class is responsible for all persistent volume claims that don't explicitly request `storageClassName`. In case you need to change the default, follow the steps below:
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. List the storage classes in your cluster:
@ -223,7 +223,7 @@ The examples above are defined to be automatically set as the default storage cl
```
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. List the storage classes in your cluster:

4
docs/docs/workflows/troubleshooting.md
View file

@ -9,7 +9,7 @@ To provide information during early stages of the node's boot process, Constella
You can view these information in the follow places:
<tabs groupId="csp">
<tabItem value="azure" label="Azure" default>
<tabItem value="azure" label="Azure">
1. In your Azure subscription find the Constellation resource group.
2. Inside the resource group find the Application Insights resource called `constellation-insights-*`.
@ -20,7 +20,7 @@ You can view these information in the follow places:
To **find the disk UUIDs** use the following query: `traces | where message contains "Disk UUID"`
</tabItem>
<tabItem value="gcp" label="GCP" default>
<tabItem value="gcp" label="GCP">
1. Select the project that hosts Constellation.
2. Go to the `Compute Engine` service.