-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from silentred/main
add a guide of importing liteio to other projects
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
|