Skip to content

Commit

Permalink
Merge pull request #4 from silentred/main
Browse files Browse the repository at this point in the history
add a guide of importing liteio to other projects
  • Loading branch information
silentred authored Nov 30, 2023
2 parents 3b75579 + 80f91e7 commit dd34122
Showing 1 changed file with 21 additions and 0 deletions.
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

0 comments on commit dd34122

Please sign in to comment.