Skip to content

Commit

Permalink
docs: restructured the replicated storage section
Browse files Browse the repository at this point in the history
Signed-off-by: Bala Harish <[email protected]>
  • Loading branch information
balaharish7 committed Apr 5, 2024
1 parent f42c6f1 commit 7b16b07
Show file tree
Hide file tree
Showing 27 changed files with 856 additions and 854 deletions.
4 changes: 4 additions & 0 deletions docs/i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -186,5 +186,9 @@
"sidebar.docs.category.Local PV ZFS": {
"message": "Local PV ZFS",
"description": "The label for category Local PV ZFS in sidebar docs"
},
"sidebar.docs.category.Replicated Storage User Guide": {
"message": "Replicated Storage User Guide",
"description": "The label for category Replicated Storage User Guide in sidebar docs"
}
}

Large diffs are not rendered by default.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: This section explains about the Call-Home Metrics.
---
# Call-home Metrics

## Replicated Engine Default Information Collection
## Replicated Storage Default Information Collection

By default, Replicated engine collects basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole.
By default, Replicated Storage (a.k.a Replicated Engine and f.k.a Mayastor) collects basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole.

:::info
No user-identifiable information, hostnames, passwords, or volume data are collected. **ONLY** the below-mentioned information is collected from the cluster.
Expand All @@ -21,34 +21,34 @@ A summary of the information collected is given below:
| :--- |
|**K8s cluster ID**: This is a SHA-256 hashed value of the UID of your Kubernetes cluster's `kube-system` namespace.|
|**K8s node count**: This is the number of nodes in your Kubernetes cluster.|
|**Product name**: This field displays the name Replicated Engine |
|**Product version**: This is the deployed version of Replicated Engine.|
|**Deploy namespace**: This is a SHA-256 hashed value of the name of the Kubernetes namespace where Replicated Engine Helm chart is deployed.|
|**Storage node count**: This is the number of nodes on which the Replicated I/O engine is scheduled.|
|**Product name**: This field displays the name Replicated Storage.|
|**Product version**: This is the deployed version of Replicated Storage.|
|**Deploy namespace**: This is a SHA-256 hashed value of the name of the Kubernetes namespace where Replicated Storage Helm chart is deployed.|
|**Storage node count**: This is the number of nodes on which the Replicated I/O Storage is scheduled.|

|**Pool information**|
| :--- |
|**Pool count**: This is the number of Replicated Engine DiskPools in your cluster.|
|**Pool maximum size**: This is the capacity of the Replicated Engine DiskPool with the highest capacity.|
|**Pool minimum size**: This is the capacity of the Replicated Engine DiskPool with the lowest capacity.|
|**Pool mean size**: This is the average capacity of the Replicated Engine DiskPools in your cluster.|
|**Pool capacity percentiles**: This calculates and returns the capacity distribution of Replicated Engine DiskPools for the 50th, 75th and the 90th percentiles.|
|**Pool count**: This is the number of Replicated Storage DiskPools in your cluster.|
|**Pool maximum size**: This is the capacity of the Replicated Storage DiskPool with the highest capacity.|
|**Pool minimum size**: This is the capacity of the Replicated Storage DiskPool with the lowest capacity.|
|**Pool mean size**: This is the average capacity of the Replicated Storage DiskPools in your cluster.|
|**Pool capacity percentiles**: This calculates and returns the capacity distribution of Replicated Storage DiskPools for the 50th, 75th and the 90th percentiles.|
| **Pools created**: This is the number of successful pool creation attempts.|
| **Pools deleted**: This is the number of successful pool deletion attempts.|

|**Volume information**|
| :--- |
|**Volume count**: This is the number of Replicated Engine Volumes in your cluster.|
|**Volume minimum size**: This is the capacity of the Replicated Engine Volume with the lowest capacity.|
|**Volume mean size**: This is the average capacity of the Replicated Engine Volumes in your cluster.|
|**Volume capacity percentiles**: This calculates and returns the capacity distribution of Replicated Engine Volumes for the 50th, 75th and the 90th percentiles.|
|**Volume count**: This is the number of Replicated Storage Volumes in your cluster.|
|**Volume minimum size**: This is the capacity of the Replicated Storage Volume with the lowest capacity.|
|**Volume mean size**: This is the average capacity of the Replicated Storage Volumes in your cluster.|
|**Volume capacity percentiles**: This calculates and returns the capacity distribution of Replicated Storage Volumes for the 50th, 75th and the 90th percentiles.|
| **Volumes created**: This is the number of successful volume creation attempts.|
| **Volumes deleted**: This is the number of successful volume deletion attempts. |

|**Replica Information**|
| :--- |
|**Replica count**: This is the number of Replicated Engine Volume replicas in your cluster.|
|**Average replica count per volume**: This is the average number of replicas each Replicated Engine Volume has in your cluster.|
|**Replica count**: This is the number of Replicated Storage Volume replicas in your cluster.|
|**Average replica count per volume**: This is the average number of replicas each Replicated Storage Volume has in your cluster.|

### Storage Location of Collected Data

Expand Down
Loading

0 comments on commit 7b16b07

Please sign in to comment.