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

User guide for SODA Integration with Ceph CSI drivers with SODA Plug n Play #163

Merged
merged 14 commits into from
May 20, 2021
Merged

User guide for SODA Integration with Ceph CSI drivers with SODA Plug n Play #163

merged 14 commits into from
May 20, 2021

Conversation

click2cloud-repo
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind new feature
/kind bug fix
/kind cleanup
/kind revert change
/kind design

/kind documentation

/kind enhancement

What this PR does / why we need it:
This PR includes information which is required to use ceph csi with hotpot project and ceph csi with SODA plug n play.
Which issue(s) this PR fixes:

Fixes #

Test Report Added?:

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind TESTED

/kind NOT-TESTED

Test Report:

Special notes for your reviewer:

Copy link
Member

@anvithks anvithks left a comment

Choose a reason for hiding this comment

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

@Click2cloud-Ceres Please update the document with correct format for the website.
You can refer to the other docs under the user guide section.
The SODA documentation uses Hugo and the Learn theme.

content/guides/user-guides/ceph-csi/csi/_index.md Outdated Show resolved Hide resolved
@anvithks anvithks added the user-guide Feature User Guide label Apr 27, 2021
@anvithks anvithks added this to To Do in SODA - Jerba Release v1.4.0(Q2 2021) via automation Apr 27, 2021
@anvithks anvithks added the hold Hold merging this PR. label Apr 27, 2021
Copy link
Member

@anvithks anvithks left a comment

Choose a reason for hiding this comment

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

@Click2cloud-Ceres Some of the content is using OpenSDS and has some formatting issues.
Please check the individual comments.

content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
grep -q "^rbd default features" /etc/ceph/ceph.conf || sed -i '/\[global\]/arbd default features = 1' /etc/ceph/ceph.conf
```

#### Deploy CEPH-CSI configmap.
Copy link
Member

Choose a reason for hiding this comment

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

Could you specify the path where this would be located.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure @anvithks, I have made some changes in this step, please review

content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved

* For csi block plugin:

* Update profile id of StorageClass in csi/examples/kubernetes/block/nginx.yaml according to actual profile you
Copy link
Member

Choose a reason for hiding this comment

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

The profile id field is profile. Use single back ticks to highlight variables and keys.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have used a single tick but not sure about its appearance please check and suggest if changes required.

Copy link
Member

Choose a reason for hiding this comment

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

I think I was not very clear when I commented here.

The profile id field is profile. Use single back ticks to highlight variables and keys.

The above comment was for the line of text above the code block.
Update profile id of StorageClass -> Update profile of StorageClass with the profile id of the profile you created.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@anvithks I have made the changes.


* For csi file plugin:

* Update profile id of StorageClass in csi/examples/kubernetes/file/nginx.yaml according to actual profile you
Copy link
Member

Choose a reason for hiding this comment

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

Same as above, use profile

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done @anvithks

content/guides/user-guides/csi/ceph csi/_index.md Outdated Show resolved Hide resolved
SODA - Jerba Release v1.4.0(Q2 2021) automation moved this from To Do to In progress Apr 29, 2021
@anvithks anvithks removed the hold Hold merging this PR. label Apr 29, 2021
@@ -0,0 +1,11 @@
---
title: CSI
Copy link
Member

Choose a reason for hiding this comment

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

This content will come under UserGuide -> NBP -> CSI

Copy link
Contributor Author

Choose a reason for hiding this comment

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

corrected @asifdxtreme

## Selecting the vendor CSI driver

You can select the CSI driver supported by SODA Plug-N-Play
from [here](https://docs.sodafoundation.io/guides/user-guides/nbp/csi-pnp/) Once selected follow the instruction given
Copy link
Member

Choose a reason for hiding this comment

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

broken link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

resolved


##### For this example we are selecting the [CEPH-RBD CSI Driver](https://github.com/ceph/ceph-csi).

Following are some additional steps we need to perform for this plugin
Copy link
Member

Choose a reason for hiding this comment

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

Following are the pre-requisites for Ceph CSI Driver

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes done.



mon initial members = ubuntu
mon host = 192.168.1.59
Copy link
Member

Choose a reason for hiding this comment

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

These IP's are env specific? if yes then please add a comment for it to change as per env

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually, this file is auto-generated at the time of hotpot installation, It automatically takes the IP address where it is installed, here we are just adding rbd default features from grep and sed command.


### [Kubernetes](https://github.com/kubernetes/kubernetes) local cluster

You can startup `v1.14.0` k8s local cluster by executing commands blow:
Copy link
Member

Choose a reason for hiding this comment

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

For CSI PnP we recommend users to use v1.17+

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This k8s example refers to the hotpot project where we use the soda CSI plugin (sushi project). If needed I can change to v1.17+. please confirm.

Copy link
Member

Choose a reason for hiding this comment

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

let's keep v1.17+ only

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure, thanx

@anvithks anvithks changed the title Ceph csi documentation User guide for SODA Integration with Ceph CSI drivers with SODA Plug n Play Apr 30, 2021
asifdxtreme
asifdxtreme previously approved these changes May 7, 2021
Copy link
Member

@asifdxtreme asifdxtreme left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -0,0 +1,396 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

Please remove the space in the folder name. Use hyphen.
/guides/user-guides/csi/ceph csi/_index.md -> /guides/user-guides/csi/ceph-csi/_index.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Member

@anvithks anvithks left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@kumarashit kumarashit left a comment

Choose a reason for hiding this comment

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

LGTM

@kumarashit kumarashit merged commit ffb5538 into sodafoundation:master May 20, 2021
SODA - Jerba Release v1.4.0(Q2 2021) automation moved this from In progress to Done May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user-guide Feature User Guide
Development

Successfully merging this pull request may close these issues.

None yet

5 participants