From 76e9d7c5acd5e8898946d5aa0691ca5040a0bfe1 Mon Sep 17 00:00:00 2001 From: Thomas Tendyck Date: Mon, 10 Oct 2022 09:33:07 +0200 Subject: [PATCH] docs: mini-constellation: fix typos and simplify some sentences --- .../getting-started/mini-constellation.md | 34 +++++++++---------- .../getting-started/mini-constellation.md | 34 +++++++++---------- 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/docs/getting-started/mini-constellation.md b/docs/docs/getting-started/mini-constellation.md index 8807239d1..cf1b404e4 100644 --- a/docs/docs/getting-started/mini-constellation.md +++ b/docs/docs/getting-started/mini-constellation.md @@ -1,12 +1,12 @@ # Mini Constellation -With `constellation mini`, users can deploy and test Constellation locally without the need for a cloud subscription. +With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription. The command uses virtualization to create a local cluster with one control-plane and one worker node. :::info -Since mini Constellation is running on your local system, please note that common cloud features, such as load-balancing, +Since mini Constellation is running on your local system, common cloud features, such as load-balancing, attaching persistent storage, or autoscaling, are unavailable. ::: @@ -14,13 +14,13 @@ attaching persistent storage, or autoscaling, are unavailable. ## Prerequisites * [Constellation CLI](./install.md#install-the-constellation-cli) -* A x86-64 CPU with at least 4 cores +* An x86-64 CPU with at least 4 cores * Recommended are 6 cores or more * Hardware virtualization enabled in the BIOS/UEFI (often referred to as Intel VT-x or AMD-V/SVM) * At least 4 GB RAM * Recommend are 6 GB or more * 20 GB of free disk space -* a Linux operating system +* A Linux operating system * [KVM kernel module](https://www.linux-kvm.org/page/Main_Page) enabled * [Docker](https://docs.docker.com/engine/install/) * [xsltproc](https://gitlab.gnome.org/GNOME/libxslt/-/wikis/home) @@ -46,13 +46,13 @@ Setting up your mini Constellation cluster is as easy as running the following c constellation mini up ``` -This will configure your current directory as the working directory for Constellation. +This will configure your current directory as the [workspace](../architecture/orchestration.md#workspaces) for this cluster. All `constellation` commands concerning this cluster need to be issued from this directory. The command will create your cluster and initialize it. Depending on your system, this may take up to 10 minutes. The output should look like the following: -```shell +```shell-session $ constellation mini up Downloading image to ./constellation.qcow2 Done. @@ -73,7 +73,7 @@ You can now connect to your cluster by executing: export KUBECONFIG="$PWD/constellation-admin.conf" ``` -You can now configure `kubectl` to connect to your local Constellation cluster: +Configure `kubectl` to connect to your local Constellation cluster: ```bash export KUBECONFIG="$PWD/constellation-admin.conf" @@ -88,7 +88,7 @@ kubectl get nodes If your cluster is running as expected the output should look like the following: -```shell +```shell-session $ kubectl get nodes NAME STATUS ROLES AGE VERSION control-plane-0 Ready control-plane,master 2m59s v1.23.9 @@ -116,29 +116,29 @@ worker-0 Ready 32s v1.23.9 Once you are done, you can clean up the created resources using the following command: -```shell +```bash constellation mini down ``` -This will destroy your cluster and clean up the your working directory. -The VM image and cluster configuration file (`constellation-conf.yaml`) will be left behind and may be reused to create new clusters. +This will destroy your cluster and clean up your workspace. +The VM image and cluster configuration file (`constellation-conf.yaml`) will be kept and may be reused to create new clusters. ## Troubleshooting ### VMs have no internet access -`iptables` rules may prevent your VMs form properly accessing the internet. -Make sure your rules are'nt dropping forwarded packages. +`iptables` rules may prevent your VMs from accessing the internet. +Make sure your rules aren't dropping forwarded packages. List your rules: -```shell +```bash sudo iptables -S ``` The output may look similar to the following: -```shell +```shell-session -P INPUT ACCEPT -P FORWARD DROP -P OUTPUT ACCEPT @@ -148,8 +148,8 @@ The output may look similar to the following: -N DOCKER-USER ``` -If your `FORWARD` chain is set to `DROP`, you will need to update your rules: +If your `FORWARD` chain is set to `DROP`, you need to update your rules: -```shell +```bash sudo iptables -P FORWARD ACCEPT ``` diff --git a/docs/versioned_docs/version-2.1/getting-started/mini-constellation.md b/docs/versioned_docs/version-2.1/getting-started/mini-constellation.md index 8807239d1..cf1b404e4 100644 --- a/docs/versioned_docs/version-2.1/getting-started/mini-constellation.md +++ b/docs/versioned_docs/version-2.1/getting-started/mini-constellation.md @@ -1,12 +1,12 @@ # Mini Constellation -With `constellation mini`, users can deploy and test Constellation locally without the need for a cloud subscription. +With `constellation mini`, you can deploy and test Constellation locally without a cloud subscription. The command uses virtualization to create a local cluster with one control-plane and one worker node. :::info -Since mini Constellation is running on your local system, please note that common cloud features, such as load-balancing, +Since mini Constellation is running on your local system, common cloud features, such as load-balancing, attaching persistent storage, or autoscaling, are unavailable. ::: @@ -14,13 +14,13 @@ attaching persistent storage, or autoscaling, are unavailable. ## Prerequisites * [Constellation CLI](./install.md#install-the-constellation-cli) -* A x86-64 CPU with at least 4 cores +* An x86-64 CPU with at least 4 cores * Recommended are 6 cores or more * Hardware virtualization enabled in the BIOS/UEFI (often referred to as Intel VT-x or AMD-V/SVM) * At least 4 GB RAM * Recommend are 6 GB or more * 20 GB of free disk space -* a Linux operating system +* A Linux operating system * [KVM kernel module](https://www.linux-kvm.org/page/Main_Page) enabled * [Docker](https://docs.docker.com/engine/install/) * [xsltproc](https://gitlab.gnome.org/GNOME/libxslt/-/wikis/home) @@ -46,13 +46,13 @@ Setting up your mini Constellation cluster is as easy as running the following c constellation mini up ``` -This will configure your current directory as the working directory for Constellation. +This will configure your current directory as the [workspace](../architecture/orchestration.md#workspaces) for this cluster. All `constellation` commands concerning this cluster need to be issued from this directory. The command will create your cluster and initialize it. Depending on your system, this may take up to 10 minutes. The output should look like the following: -```shell +```shell-session $ constellation mini up Downloading image to ./constellation.qcow2 Done. @@ -73,7 +73,7 @@ You can now connect to your cluster by executing: export KUBECONFIG="$PWD/constellation-admin.conf" ``` -You can now configure `kubectl` to connect to your local Constellation cluster: +Configure `kubectl` to connect to your local Constellation cluster: ```bash export KUBECONFIG="$PWD/constellation-admin.conf" @@ -88,7 +88,7 @@ kubectl get nodes If your cluster is running as expected the output should look like the following: -```shell +```shell-session $ kubectl get nodes NAME STATUS ROLES AGE VERSION control-plane-0 Ready control-plane,master 2m59s v1.23.9 @@ -116,29 +116,29 @@ worker-0 Ready 32s v1.23.9 Once you are done, you can clean up the created resources using the following command: -```shell +```bash constellation mini down ``` -This will destroy your cluster and clean up the your working directory. -The VM image and cluster configuration file (`constellation-conf.yaml`) will be left behind and may be reused to create new clusters. +This will destroy your cluster and clean up your workspace. +The VM image and cluster configuration file (`constellation-conf.yaml`) will be kept and may be reused to create new clusters. ## Troubleshooting ### VMs have no internet access -`iptables` rules may prevent your VMs form properly accessing the internet. -Make sure your rules are'nt dropping forwarded packages. +`iptables` rules may prevent your VMs from accessing the internet. +Make sure your rules aren't dropping forwarded packages. List your rules: -```shell +```bash sudo iptables -S ``` The output may look similar to the following: -```shell +```shell-session -P INPUT ACCEPT -P FORWARD DROP -P OUTPUT ACCEPT @@ -148,8 +148,8 @@ The output may look similar to the following: -N DOCKER-USER ``` -If your `FORWARD` chain is set to `DROP`, you will need to update your rules: +If your `FORWARD` chain is set to `DROP`, you need to update your rules: -```shell +```bash sudo iptables -P FORWARD ACCEPT ```