Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-02-25 09:11:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update wording for MiniConstellation in docs (#241)

Browse Source
This commit is contained in:
Moritz Eckert 2022-10-13 11:29:56 +02:00 committed by GitHub
parent 50cff97ec5
commit c7010f76ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 37 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/getting-started/first-steps.md
View File

@ -4,7 +4,7 @@ The following steps guide you through the process of creating a cluster and depl
and have access to a cloud subscription. and have access to a cloud subscription.
:::tip :::tip
If you don't have a cloud subscription, check out [mini Constellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization. If you don't have a cloud subscription, check out [MiniConstellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization.
::: :::
## Create a cluster ## Create a cluster

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

@ -103,7 +103,7 @@ The CLI supports autocompletion for various shells. To set it up, run `constella
The CLI makes authenticated calls to the CSP API. Therefore, you need to set up Constellation with the credentials for your CSP. The CLI makes authenticated calls to the CSP API. Therefore, you need to set up Constellation with the credentials for your CSP.
:::tip :::tip
If you don't have a cloud subscription, you can try [mini Constellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization. If you don't have a cloud subscription, you can try [MiniConstellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization.
::: :::
### Required permissions ### Required permissions

6
docs/docs/getting-started/mini-constellation.md
View File

@ -1,4 +1,4 @@
# Mini Constellation # MiniConstellation
With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription. With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription.
@ -6,7 +6,7 @@ The command uses virtualization to create a local cluster with one control-plane
:::info :::info
Since mini Constellation is running on your local system, common cloud features, such as load-balancing, Since MiniConstellation is running on your local system, common cloud features, such as load-balancing,
attaching persistent storage, or autoscaling, are unavailable. attaching persistent storage, or autoscaling, are unavailable.
::: :::
@ -40,7 +40,7 @@ attaching persistent storage, or autoscaling, are unavailable.
## Create your cluster ## Create your cluster
Setting up your mini Constellation cluster is as easy as running the following command: Setting up your MiniConstellation cluster is as easy as running the following command:
```bash ```bash
constellation mini up constellation mini up

20
docs/docs/reference/cli.md
View File

@ -17,9 +17,9 @@ Commands:
* [instance-types](#constellation-config-instance-types): Print the supported instance types for all cloud providers * [instance-types](#constellation-config-instance-types): Print the supported instance types for all cloud providers
* [create](#constellation-create): Create instances on a cloud platform for your Constellation cluster * [create](#constellation-create): Create instances on a cloud platform for your Constellation cluster
* [init](#constellation-init): Initialize the Constellation cluster * [init](#constellation-init): Initialize the Constellation cluster
* [mini](#constellation-mini): Manage mini Constellation clusters * [mini](#constellation-mini): Manage MiniConstellation clusters
* [up](#constellation-mini-up): Create and initialize a new mini Constellation cluster * [up](#constellation-mini-up): Create and initialize a new MiniConstellation cluster
* [down](#constellation-mini-down): Destroy a mini Constellation cluster * [down](#constellation-mini-down): Destroy a MiniConstellation cluster
* [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster * [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster
* [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster * [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster
* [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster * [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster
@ -180,11 +180,11 @@ constellation init [flags]
## constellation mini ## constellation mini
Manage mini Constellation clusters Manage MiniConstellation clusters
### Synopsis ### Synopsis
Manage mini Constellation clusters. Manage MiniConstellation clusters.
### Options ### Options
@ -200,11 +200,11 @@ Manage mini Constellation clusters.
## constellation mini up ## constellation mini up
Create and initialize a new mini Constellation cluster Create and initialize a new MiniConstellation cluster
### Synopsis ### Synopsis
Create and initialize a new mini Constellation cluster. Create and initialize a new MiniConstellation cluster.
A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM. A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM.
@ -224,13 +224,13 @@ constellation mini up [flags]
--config string path to the configuration file (default "constellation-conf.yaml") --config string path to the configuration file (default "constellation-conf.yaml")
``` ```
## constellation mini down ## constellation mini **down**
Destroy a mini Constellation cluster Destroy a MiniConstellation cluster
### Synopsis ### Synopsis
Destroy a mini Constellation cluster. Destroy a MiniConstellation cluster.
``` ```
constellation mini down [flags] constellation mini down [flags]

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

@ -7,6 +7,10 @@ Creating your cluster requires two steps:
See the [architecture](../architecture/orchestration.md) section for details on the inner workings of this process. See the [architecture](../architecture/orchestration.md) section for details on the inner workings of this process.
:::tip
If you don't have a cloud subscription, check out [MiniConstellation](../getting-started/mini-constellation.md), which lets you set up a local Constellation cluster using virtualization.
:::
## The *create* step ## The *create* step
This step creates the necessary resources for your cluster in your cloud environment. This step creates the necessary resources for your cluster in your cloud environment.

4
docs/sidebars.js
View File

@ -76,12 +76,12 @@ const sidebars = {
}, },
{ {
type: 'doc', type: 'doc',
label: 'First steps', label: 'First steps (cloud)',
id: 'getting-started/first-steps', id: 'getting-started/first-steps',
}, },
{ {
type: 'doc', type: 'doc',
label: 'Mini Constellation', label: 'First steps (local)',
id: 'getting-started/mini-constellation', id: 'getting-started/mini-constellation',
}, },
{ {

2
docs/versioned_docs/version-2.1/getting-started/first-steps.md
View File

@ -4,7 +4,7 @@ The following steps guide you through the process of creating a cluster and depl
and have access to a cloud subscription. and have access to a cloud subscription.
:::tip :::tip
If you don't have a cloud subscription, check out [mini Constellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization. If you don't have a cloud subscription, check out [MiniConstellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization.
::: :::
## Create a cluster ## Create a cluster

2
docs/versioned_docs/version-2.1/getting-started/install.md
View File

@ -103,7 +103,7 @@ The CLI supports autocompletion for various shells. To set it up, run `constella
The CLI makes authenticated calls to the CSP API. Therefore, you need to set up Constellation with the credentials for your CSP. The CLI makes authenticated calls to the CSP API. Therefore, you need to set up Constellation with the credentials for your CSP.
:::tip :::tip
If you don't have a cloud subscription, you can try [mini Constellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization. If you don't have a cloud subscription, you can try [MiniConstellation](mini-constellation.md), which lets you set up a local Constellation cluster using virtualization.
::: :::
### Required permissions ### Required permissions

6
docs/versioned_docs/version-2.1/getting-started/mini-constellation.md
View File

@ -1,4 +1,4 @@
# Mini Constellation # MiniConstellation
With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription. With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription.
@ -6,7 +6,7 @@ The command uses virtualization to create a local cluster with one control-plane
:::info :::info
Since mini Constellation is running on your local system, common cloud features, such as load-balancing, Since MiniConstellation is running on your local system, common cloud features, such as load-balancing,
attaching persistent storage, or autoscaling, are unavailable. attaching persistent storage, or autoscaling, are unavailable.
::: :::
@ -40,7 +40,7 @@ attaching persistent storage, or autoscaling, are unavailable.
## Create your cluster ## Create your cluster
Setting up your mini Constellation cluster is as easy as running the following command: Setting up your MiniConstellation cluster is as easy as running the following command:
```bash ```bash
constellation mini up constellation mini up

18
docs/versioned_docs/version-2.1/reference/cli.md
View File

@ -17,9 +17,9 @@ Commands:
* [instance-types](#constellation-config-instance-types): Print the supported instance types for all cloud providers * [instance-types](#constellation-config-instance-types): Print the supported instance types for all cloud providers
* [create](#constellation-create): Create instances on a cloud platform for your Constellation cluster * [create](#constellation-create): Create instances on a cloud platform for your Constellation cluster
* [init](#constellation-init): Initialize the Constellation cluster * [init](#constellation-init): Initialize the Constellation cluster
* [mini](#constellation-mini): Manage mini Constellation clusters * [mini](#constellation-mini): Manage MiniConstellation clusters
* [up](#constellation-mini-up): Create and initialize a new mini Constellation cluster * [up](#constellation-mini-up): Create and initialize a new MiniConstellation cluster
* [down](#constellation-mini-down): Destroy a mini Constellation cluster * [down](#constellation-mini-down): Destroy a MiniConstellation cluster
* [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster * [verify](#constellation-verify): Verify the confidential properties of a Constellation cluster
* [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster * [upgrade](#constellation-upgrade): Plan and perform an upgrade of a Constellation cluster
* [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster * [plan](#constellation-upgrade-plan): Plan an upgrade of a Constellation cluster
@ -180,11 +180,11 @@ constellation init [flags]
## constellation mini ## constellation mini
Manage mini Constellation clusters Manage MiniConstellation clusters
### Synopsis ### Synopsis
Manage mini Constellation clusters. Manage MiniConstellation clusters.
### Options ### Options
@ -200,11 +200,11 @@ Manage mini Constellation clusters.
## constellation mini up ## constellation mini up
Create and initialize a new mini Constellation cluster Create and initialize a new MiniConstellation cluster
### Synopsis ### Synopsis
Create and initialize a new mini Constellation cluster. Create and initialize a new MiniConstellation cluster.
A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM. A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM.
@ -226,11 +226,11 @@ constellation mini up [flags]
## constellation mini down ## constellation mini down
Destroy a mini Constellation cluster Destroy a MiniConstellation cluster
### Synopsis ### Synopsis
Destroy a mini Constellation cluster. Destroy a MiniConstellation cluster.
``` ```
constellation mini down [flags] constellation mini down [flags]

4
docs/versioned_sidebars/version-2.1-sidebars.json
View File

@ -58,12 +58,12 @@
}, },
{ {
"type": "doc", "type": "doc",
"label": "First steps", "label": "First steps (cloud)",
"id": "getting-started/first-steps" "id": "getting-started/first-steps"
}, },
{ {
"type": "doc", "type": "doc",
"label": "Mini Constellation", "label": "First steps (local)",
"id": "getting-started/mini-constellation" "id": "getting-started/mini-constellation"
}, },
{ {