Skip to content

docs: Documentation Maintenance and Content Cleanup for Main and v4.5 Docs#588

Open
balaharish7 wants to merge 1 commit into
openebs:mainfrom
balaharish7:update4.5docs
Open

docs: Documentation Maintenance and Content Cleanup for Main and v4.5 Docs#588
balaharish7 wants to merge 1 commit into
openebs:mainfrom
balaharish7:update4.5docs

Conversation

@balaharish7

Copy link
Copy Markdown
Contributor

Changes Completed

  • Removed obsolete KB articles:

    • How to create a BlockDeviceClaim for a particular BlockDevice?
    • How to provision Local PV on K3OS?
  • Moved the following KB entries to the FAQ document:

    • How do I reuse an existing PV after re-creating Kubernetes StatefulSet and its PVC?
    • How to prevent container logs from exhausting disk space?
  • Removed an invalid CNCF hyperlink from the Use Cases document.

  • Merged duplicate storage recommendation tables and revised the Data Engines Overview content to eliminate redundancy.

  • Updated the StorageClass parameter table in the Local PV LVM StorageClass Parameters document by consolidating supported values into a simplified format.

  • Reorganized the StorageClass Parameters document by moving the parameter overview section to the beginning and improving overall content structure.

  • Simplified the PersistentVolumeClaim conformance matrix in the Local PV LVM Deployment document by consolidating supported parameters and values into a concise reference table.

  • Added a StorageClass parameter reference table to the Local PV ZFS StorageClass Parameters document to improve readability and navigation.

  • Removed quorum-related terminology from the Kubernetes Upgrade Best Practices document and updated the guidance to align with Replicated PV Mayastor behavior.

  • Moved the Kubernetes Upgrade Best Practices document from:

    • Local Storage > Additional Information
    • To Replicated Storage > Additional Information
  • Removed the FAQ entry:

    • Can the size/capacity of a Disk Pool be changed?
  • Updated the FAQ:

    • Does Replicated Storage support snapshots and clones?
  • Performed miscellaneous formatting, alignment, and consistency improvements across multiple documents.

… Documentation

Signed-off-by: Bala Harish <bala.harish.ac@datacore.com>
Comment thread docs/main/faqs/faqs.md


- Run `kubectl get pvc` to fetch the volume name. The volume name looks like: *pvc-ee171da3-07d5-11e8-a5be-42010a8001be*.
- For each volume, you will notice one I/O controller pod and one or more replicas (as per the storage class configuration). You can use the volume ID (ee171da3-07d5-11e8-a5be-42010a8001be) to view information about the volume and replicas using the [kubectl plugin](../user-guides/replicated-storage-user-guide/replicated-pv-mayastor/advanced-operations/kubectl-plugin.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be specific for mayastor

Comment thread docs/main/faqs/faqs.md
}
```

2. Restart the docker daemon on the nodes. This may cause a temporary disruption of the running containers and cause the node to show up as `Not Ready` until the daemon has restarted successfully.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Restart the docker daemon on the nodes. This may cause a temporary disruption of the running containers and cause the node to show up as `Not Ready` until the daemon has restarted successfully.
2. Restart the docker daemon on the nodes. This may cause a temporary disruption of the running containers and cause the node to show up as `NotReady` until the daemon has restarted successfully.

Comment thread docs/main/faqs/faqs.md

To resolve this issue, reinstate or recreate the pod to ensure that the volume is properly mounted and recognized by the control plane.

### How do I reuse an existing PV - after re-creating Kubernetes StatefulSet and its PVC {#reuse-pv-after-recreating-sts}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is a FAQ, this makes more sense as a kb type thing, if needed at all

Comment thread docs/main/faqs/faqs.md
kubectl get pods -n <namespace>
```

### How to prevent container logs from exhausting disk space? {#enable-log-rotation-on-cluster-nodes}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants