Skip to content
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.

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

Distorbutedstorage documentation #416

Merged
merged 2 commits into from
Oct 29, 2023
Merged

Distorbutedstorage documentation #416

merged 2 commits into from
Oct 29, 2023

Conversation

LiZhenCheng9527
Copy link
Contributor

What type of PR is this?
Provide documentation on the use of distorbutedstorage

Signed-off-by: LiZhenCheng9527 <[email protected]>
@netlify
Copy link

netlify bot commented Oct 27, 2023

Deploy Preview for kurator-dev canceled.

Name Link
🔨 Latest commit 06e9875
🔍 Latest deploy log https://app.netlify.com/sites/kurator-dev/deploys/653d4ed15821bb0008337d39

manager:
count: 2
annotations:
role: ManagerNodeAnnotation
Copy link
Member

Choose a reason for hiding this comment

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

there is no device setting, what real volume does it use?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Without specifying a device, rook's osd-prepare job scans the node for all devices that can be retrieved with command lsflk --all.


- `clusters`: Contains the two `AttachedCluster` objects created earlier, indicating that the distributedstorage plugin will be installed on these two clusters.
- `plugin`: The `distributedStorage` indicates the configuration of a distributedstorage plugin. `dataDirHostPath` defines the directory in which the rook-ceph cluster will save the cluster configuration. `monitor` and `manager` provide configuration for the mon and mgr components of ceph. For more configuration options, please refer to the [Fleet API](https://kurator.dev/docs/references/fleet-api/).
- In addition to the configuration fields mentioned above, kurator also provides `storage.devices` field that allows you to specify the use of disks mounted in a specific directory such as `sda` in the cluster. And `storage.nodes` field that allows you to specify the use of storage resources on specific nodes. For more configuration options, please refer to the [Fleet API](https://kurator.dev/docs/references/fleet-api/).
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure what you mean by sda in the cluster? Is it set in the example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sda is a device mounted on /dev/sda. if a specific mount path is specified, rook will check the specified path on all nodes in the cluster for the presence of storage resources that comply with requirements.

Copy link
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

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

/lgtm

please respond the comments below each one. And this is missing examples for filesystem and object storage


Let's delve into the `spec` section of the above Fleet:

- `clusters`: Contains the two `AttachedCluster` objects created earlier, indicating that the distributedstorage plugin will be installed on these two clusters.
Copy link
Member

Choose a reason for hiding this comment

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

in these two clusters

There are a few things to note in the above block storage class configuration:

- provisioner is configured in the format (operator-namespace).rbd.csi.ceph.com. Change "rook-ceph" provisioner prefix to match the operator namespace if needed.
- `parametes.clusterID` is the namespace where the rook cluster is running.
Copy link
Member

Choose a reason for hiding this comment

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

clusterID is namespace?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the documentation for rook, it is mentioned that the clusterID is the namespace where the rook cluster is running.
You can refer to the following link rook documtation

@kurator-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

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

Successfully merging this pull request may close these issues.

5 participants