Skip to content

Revise storage requirements and capacities in documentation #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sed-i wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Revise storage requirements and capacities in documentation #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/reference/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Evaluate the [telemetry volume needed](/how-to/configure-and-tune/evaluate-telem
and refer to the [sizing guide](system-requirements) for concrete numbers.

## Set up distributed storage
In production, **do not** use hostPath storage ([`hostpath-storage`](https://canonical.com/microk8s/docs/addon-hostpath-storage) in MicroK8s; `local-storage` in Canonical K8s):
In production, do not use hostPath storage ([`hostpath-storage`](https://canonical.com/microk8s/docs/addon-hostpath-storage) in MicroK8s; `local-storage` in Canonical K8s):
- `PersistentVolumeClaims` created by the host path storage provisioner are bound to the local node, so it is *impossible to move them to a different node*.
- A `hostpath` volume can *grow beyond the capacity set in the volume claim manifest*.

Expand Down Expand Up @@ -73,12 +73,12 @@ The default storage allocation for charmed persistent volumes is 1GB. The follow

| Charm | Storage volume | Description | Capacity | Typical unit count |
| --------------------------- | ---------------- | -------------------------------------------------------------- | ------------ | ------------------ |
| loki-k8s | loki-chunks | WAL for received logs | 100GB | 3 |
| prometheus-k8s | database | WAL for received metrics | 50GB | 3 |
| loki-k8s | loki-chunks | WAL for received logs, and long term storage | 1TB | 1 |
| prometheus-k8s | database | WAL for received metrics, and long term storage | 500GB | 1 |
| grafana-k8s | database | Configurations, plugins, user data | 10GB | 1 |
| alertmanager-k8s | data | `nflog` and silences snapshots | 1GB | 3 |
| alertmanager-k8s | data | `nflog` and silences snapshots | 1GB | 1 |
| traefik-k8s | configurations | Dynamic configuration files (YAML), x509 certificates and keys | 1GB | 1 |
| cos-configuration-k8s | content-from-git | Checked-out content from the git repository | 1GB | 1 |

The total Kubernetes persistent volume storage needed by COS depends on the scale of each application, and on the replication count.
For the table above, a COS Lite deployment would require 465 GB per replicated storage pool (e.g. MicroCeph).
For the table above, a COS Lite deployment would require 1.52TB per replicated storage pool (e.g. MicroCeph).
Loading