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

add a guide of importing liteio to other projects #4

Merged
merged 2 commits into from
Nov 30, 2023
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions doc/en/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ The Disk-Controller is primarily built using the controller-runtime library. In

Since users may be running LiteIO in different environments, they may have specific requirements for reconciling StoragePools and Volumes. To address this issue, LiteIO offers a plugin mechanism that includes reconciler and scheduler plugins.

## Import liteio to your project

`go.mod` example:

```
module your-project

go 1.17

require (
code.alipay.com/dbplatform/node-disk-controller v1.0.0
)


replace code.alipay.com/dbplatform/node-disk-controller => github.com/eosphoros-ai/liteio v1.0.0
```

The above config will download mod from URL `github.com/eosphoros-ai/[email protected]` and use it as mod `code.alipay.com/dbplatform/node-disk-controller`.
Remember to replace mod version `v1.0.0` with a real version name.


## Reconciler Plugin

The Plugin includes three methods:
Expand Down