Skip to content

Commit 5a769b6

Browse files
committed
[docs] Remove trailing spaces from all doc sources.
Double trailing space in Markdown creates a line break `<br>` in HTML. That's never intended in the docs. Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
1 parent 5392748 commit 5a769b6

27 files changed

Lines changed: 141 additions & 141 deletions

File tree

content/en/blog/2024-04-05-diy-create-your-own-cloud-with-kubernetes-part-1/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ update and maintain.
8989
Judge for yourself: in the cloud, to update a node, you typically delete the virtual machine
9090
(or even use `kubectl delete node`) and you let your node management tooling create a new
9191
one, based on an immutable image. The new node will join the cluster and ”just work” as a node;
92-
following a very simple and commonly used pattern in the Kubernetes world.
92+
following a very simple and commonly used pattern in the Kubernetes world.
9393
Many clusters order new virtual machines every few minutes, simply because they can use
9494
cheaper spot instances. However, when you have a physical server, you can't just delete and
9595
recreate it, firstly because it often runs some cluster services, stores data, and its update process
@@ -155,7 +155,7 @@ output:
155155
Then we use the `docker` command line tool to build an OS image:
156156

157157
```
158-
cat config.yaml | docker run --rm -i -v /dev:/dev --privileged "ghcr.io/siderolabs/imager:v1.6.4" -
158+
cat config.yaml | docker run --rm -i -v /dev:/dev --privileged "ghcr.io/siderolabs/imager:v1.6.4" -
159159
```
160160
161161
And as a result, we get a Docker container image with everything we need, which we can use to

content/en/docs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Cozystack is a free PaaS platform and framework for building clouds
1414

1515
With Cozystack, you can transform your bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.
1616

17-
You can use Cozystack to build your own cloud or to provide a cost-effective development environments.
17+
You can use Cozystack to build your own cloud or to provide a cost-effective development environments.

content/en/docs/development/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ make update # Download new version from upstream
164164
make image # Build cilium image
165165
git diff . # Show diff with changed manifests
166166
make diff # Show diff with applied cluster manifests
167-
make apply # Apply changed manifests to the cluster
167+
make apply # Apply changed manifests to the cluster
168168
kubectl get pod -n cozy-cilium # Check if everything works as expected
169169
git commit -m "Update cilium" # Commit changes to the branch
170170
```

content/en/docs/getting-started/create-tenant.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See the [OIDC guide]({{% ref "/docs/operations/oidc" %}}) for details on how to
3333

3434
## Create a Tenant
3535

36-
Tenants are created using the Cozystack application named `Tenant`.
36+
Tenants are created using the Cozystack application named `Tenant`.
3737
After installation, Cozystack includes a built-in tenant called `tenant-root`.
3838
This root tenant is reserved for platform administrators and should only be used to create child tenants.
3939
Although it’s technically possible to install applications in `tenant-root`,
@@ -153,5 +153,5 @@ In general, administrators do **not** need to retrieve kubeconfig files for nest
153153
These clusters are installed by the tenant user, within their own tenant namespace.
154154
Tenant users have full control over their nested Kubernetes environments.
155155

156-
To access a nested Kubernetes cluster, the tenant user can download the kubeconfig file
156+
To access a nested Kubernetes cluster, the tenant user can download the kubeconfig file
157157
directly from the corresponding application's page in the dashboard.

content/en/docs/getting-started/deploy-app.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ You’ll learn how to:
1616
- Create a managed Kubernetes cluster, configure DNS, and access the cluster.
1717
- Deploy a containerized application to the new cluster.
1818

19-
You don’t need in-depth Kubernetes knowledge to complete this tutorial—most steps are done through the Cozystack web interface.
19+
You don’t need in-depth Kubernetes knowledge to complete this tutorial—most steps are done through the Cozystack web interface.
2020

21-
This is your fast track to a successful first deployment on Cozystack.
21+
This is your fast track to a successful first deployment on Cozystack.
2222
Once you're done, you’ll have a working setup ready for your own applications—and a solid foundation to build upon and showcase to your team.
2323

2424
## Prerequisites
@@ -34,9 +34,9 @@ Before you begin:
3434
- **DNS for dev/testing:** To access the deployed app over HTTPS you need a DNS record set up.
3535
A wildcard DNS record is preferred, as it's more convenient to use.
3636

37-
> 🛠️ **CLI is optional.**
38-
> You don’t need to use `kubectl` or `helm` unless you want to.
39-
> All major steps (like creating the Kubernetes cluster and managed services) can be done entirely in the Cozystack Dashboard.
37+
> 🛠️ **CLI is optional.**
38+
> You don’t need to use `kubectl` or `helm` unless you want to.
39+
> All major steps (like creating the Kubernetes cluster and managed services) can be done entirely in the Cozystack Dashboard.
4040
> The only point where you’ll need the CLI is when deploying the app to a Kubernetes cluster.
4141
4242
## 1. Access the Cozystack Dashboard
@@ -53,10 +53,10 @@ Choose your login method below:
5353

5454
{{< tabs name="access_dashboard" >}}
5555
{{% tab name="OIDC" %}}
56-
Click the `OIDC Login` button.
56+
Click the `OIDC Login` button.
5757
This will take you to the Keycloak login page.
5858

59-
Enter your credentials and click `Login`.
59+
Enter your credentials and click `Login`.
6060
If everything is configured correctly, you'll be logged in and redirected back to the dashboard.
6161
{{% /tab %}}
6262

@@ -78,17 +78,17 @@ As a tenant user, you can’t install or modify them, but your own apps will run
7878

7979
## 2. Create a Managed PostgreSQL
8080

81-
Cozystack lets you provision managed databases directly on the hardware layer for maximum performance.
81+
Cozystack lets you provision managed databases directly on the hardware layer for maximum performance.
8282
Each database is created inside your tenant namespace and is automatically accessible from your nested Kubernetes cluster.
8383

84-
If you're familiar with services like AWS RDS or GCP Cloud SQL, the experience is similar—
84+
If you're familiar with services like AWS RDS or GCP Cloud SQL, the experience is similar—
8585
except it's fully integrated with Cozystack and isolated within your own tenant.
8686

8787
> Throughout this tutorial, you’ll have the option to use either the Cozystack dashboard (UI) or `kubectl`:
8888
>
8989
> - **Cozystack Dashboard** offers the quickest and most straightforward experience—recommended if this is your first time using Cozystack.
9090
> - **`kubectl`** provides in-depth visibility into how managed services are deployed behind the scenes.
91-
>
91+
>
9292
> While neither approach reflects how services are typically deployed in production,
9393
> both are well-suited for learning and experimentation—making them ideal for this tutorial.
9494
@@ -161,7 +161,7 @@ kubectl apply -f postgres.yaml
161161

162162
### 2.2 Get the Connection Credentials
163163

164-
Navigate to the **Applications** tab, then find and open the `instaphoto-postgres` application.
164+
Navigate to the **Applications** tab, then find and open the `instaphoto-postgres` application.
165165
Once the application is installed and ready, you’ll find connection details in the **Application Resources** section of the dashboard.
166166

167167
- The **Secrets** tab contains the database password for each user you defined.
@@ -178,7 +178,7 @@ This will create a service named `postgres-<name>-external-write` with a public
178178
179179
## 3. Create a Cache Service
180180

181-
From this point on, you'll use your tenant credentials to access the platform.
181+
From this point on, you'll use your tenant credentials to access the platform.
182182
Use the tenant's kubeconfig for `kubectl`, and the token from it to access the dashboard.
183183

184184
{{< tabs name="create_redis" >}}
@@ -228,7 +228,7 @@ kubectl apply -f redis.yaml
228228
{{% /tab %}}
229229
{{< /tabs >}}
230230

231-
After a short time, the Redis application will be installed in the `team1` tenant.
231+
After a short time, the Redis application will be installed in the `team1` tenant.
232232
The generated password can be found in the dashboard.
233233

234234
{{< tabs name="redis_password" >}}
@@ -254,19 +254,19 @@ kubectl -n tenant-team1 get secret redis-instaphoto-auth
254254

255255
## 4. Deploy a Nested Kubernetes Cluster
256256

257-
The nested Kubernetes cluster is created in the same way as the database and cache.
257+
The nested Kubernetes cluster is created in the same way as the database and cache.
258258
However, there are a few important additional points to consider:
259259

260260
- **`etcd` must be enabled in the tenant**<br/>
261261
The `etcd` service is required to run a nested Kubernetes cluster and can only be enabled by a Cozystack administrator.
262-
- **Verify your quota.**<br/>
262+
- **Verify your quota.**<br/>
263263
Ensure your tenant has enough CPU, RAM, and disk resources to create and run a cluster.
264-
- **Choose an appropriate instance preset.**<br/>
265-
Avoid selecting presets that are too small. A Kubernetes node consumes approximately 2.5 GB of RAM just for system components.
266-
For example, if you select a 4 GB RAM preset, only about 1.5 GB will be available for your actual workloads.
264+
- **Choose an appropriate instance preset.**<br/>
265+
Avoid selecting presets that are too small. A Kubernetes node consumes approximately 2.5 GB of RAM just for system components.
266+
For example, if you select a 4 GB RAM preset, only about 1.5 GB will be available for your actual workloads.
267267
4 GB is sufficient for testing, but in general, it’s better to provision **fewer nodes with more RAM** than many nodes with minimal RAM.
268-
- **Enable `ingress` and `cert-manager` if needed.**<br/>
269-
If you're deploying web applications, you will likely need ingress and certificate management.
268+
- **Enable `ingress` and `cert-manager` if needed.**<br/>
269+
If you're deploying web applications, you will likely need ingress and certificate management.
270270
Both can be enabled with a checkbox when configuring the nested Kubernetes application in Cozystack.
271271

272272
Once the nested Kubernetes cluster is ready, you'll find its kubeconfig files in the **Secrets** tab of the application page in the dashboard.
@@ -327,8 +327,8 @@ To deploy your application:
327327
1. Run a standard Helm deployment command, for example:
328328

329329
```bash
330-
helm upgrade --install <release-name> <chart-path> -f values.yaml
330+
helm upgrade --install <release-name> <chart-path> -f values.yaml
331331
```
332-
332+
333333
Service names such as the database and cache do not need DNS suffixes.
334334
They are accessible within the same namespace by their service names.

content/en/docs/getting-started/first-deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ It will guide you through the following steps:
3434
1. Configure storage
3535
1. Configure networking
3636
1. Deploy etcd, ingress and monitoring stack
37-
1. Finalize deployment and access Cozystack dashboard
37+
1. Finalize deployment and access Cozystack dashboard
3838
3939
4040
## 1. Create Kubernetes cluster
@@ -104,7 +104,7 @@ Installing Cozystack starts with choosing a Cozystack bundle.
104104
In this tutorial, we'll use the complete `paas-full` bundle, made for installing on bare metal and including everything
105105
Cozystack has to offer.
106106

107-
### 2.1. Prepare Configuration File
107+
### 2.1. Prepare Configuration File
108108

109109
Take the configuration example below and fill in the values according to your network setup.
110110
Make sure to use the same value in `patch.yaml` and `patch-controlplane.yaml` files.
@@ -514,7 +514,7 @@ kubectl patch cm -n cozy-system cozystack --type merge -p='{"data":{
514514
{{% /alert %}}
515515

516516
Use `dashboard.example.org` to access the system dashboard, where `example.org` is your domain specified for `tenant-root`.
517-
In this example, `dashboard.example.org` is located at 192.168.100.200.
517+
In this example, `dashboard.example.org` is located at 192.168.100.200.
518518

519519
Get authentication token from `tenant-root`:
520520
```bash
@@ -524,7 +524,7 @@ kubectl get secret -n tenant-root tenant-root -o go-template='{{ printf "%s\n" (
524524
### 6.3 Access metrics in Grafana
525525

526526
Use `grafana.example.org` to access the system monitoring, where `example.org` is your domain specified for `tenant-root`.
527-
In this example, `grafana.example.org` is located at 192.168.100.200.
527+
In this example, `grafana.example.org` is located at 192.168.100.200.
528528

529529
- login: `admin`
530530
- request a password:

content/en/docs/getting-started/hardware-requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Understanding each role ensures the stability and scalability of your environmen
4141

4242
- **Primary Disk**: This disk contains the Talos Linux operating system, essential system kernel modules and
4343
Cozystack system base pods, logs, and base container images.
44-
44+
4545
Minimum: 32 GB; approximately 26 GB is used in a standard Cozystack setup.
4646
The Talos installation expects `/dev/sda` as the system disk (virtio drives usually appear as `/dev/vda`).
4747

@@ -110,4 +110,4 @@ Achieving high availability adds to the basic production environment requirement
110110
- Expect a significant amount of horizontal, inter-node traffic inside clusters.
111111
It is usually caused by multiple replicas of services and databases deployed across different nodes exchanging data.
112112
Also, virtual machines with live migration require replicated volumes, which further increases the amount of traffic.
113-
113+

content/en/docs/guides/applications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ Deployment involves the following components:
3535
of Kubernetes control planes as pods within a root cluster.
3636
Each control plane pod includes essential components like `kube-apiserver`, `controller-manager`, and `scheduler`,
3737
allowing for efficient multi-tenancy and resource utilization.
38-
38+
3939
- **Etcd Cluster**: A dedicated etcd cluster is deployed using Ænix's [aenix-io/etcd-operator](https://github.com/aenix-io/etcd-operator).
4040
It provides reliable and scalable key-value storage for the Kubernetes control plane.
41-
41+
4242
- **Worker Nodes**: Virtual Machines are provisioned to serve as worker nodes.
4343
These nodes are configured to join the tenant Kubernetes cluster, enabling the deployment and management of workloads.
4444

content/en/docs/guides/bundles/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ It includes three optional components:
137137

138138
## Learn More
139139

140-
To see the full list of components and configuration options for each bundle, refer to the
140+
To see the full list of components and configuration options for each bundle, refer to the
141141
[bundle reference documentation]({{% ref "/docs/operations/bundles" %}}).
142142

143143
To deploy a selected bundle, follow the [Cozystack quickstart guide]({{% ref "/docs/getting-started/first-deployment" %}}) or platform installation documentation.

content/en/docs/guides/concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Once access is granted to the tenant Kubernetes, the user can order physical vol
2121

2222
All use cases are presented here:
2323

24-
* [**Using Cozystack to build public cloud**](/docs/guides/use-cases/public-cloud/)
24+
* [**Using Cozystack to build public cloud**](/docs/guides/use-cases/public-cloud/)
2525
How to use Cozystack to build public cloud
2626

27-
* [**Using Cozystack to build private cloud**](/docs/guides/use-cases/private-cloud/)
27+
* [**Using Cozystack to build private cloud**](/docs/guides/use-cases/private-cloud/)
2828
How to use Cozystack to build private cloud
2929

3030
* [**Using Cozystack as Kubernetes distribution**](/docs/guides/use-cases/kubernetes-distribution/)

0 commit comments

Comments
 (0)