The canonical location of the Kruise Rollout API definition.
Go to file
Zhen Zhang 60eb21ef98
Merge pull request #3 from furykerry/master
correct open api schema generation
2024-01-29 16:06:01 +08:00
.github/workflows init project from kruise-api 2024-01-19 17:52:53 +08:00
client sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
cmd/gen-schema init project from kruise-api 2024-01-19 17:52:53 +08:00
examples/create-update-delete-rollout sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
hack sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
pkg/rollouts correct open api schema generation 2024-01-29 15:59:41 +08:00
rollouts correct open api schema generation 2024-01-29 15:59:41 +08:00
schema correct open api schema generation 2024-01-29 15:59:41 +08:00
utils/scheme sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
.gitignore init project from kruise-api 2024-01-19 17:52:53 +08:00
LICENSE Initial commit 2024-01-18 18:11:42 +08:00
Makefile sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
OWNERS init project from kruise-api 2024-01-19 17:52:53 +08:00
README.md update README for API usage 2024-01-25 10:43:16 +08:00
go.mod sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00
go.sum sync kruise-rollout 0.5 api 2024-01-19 20:06:39 +08:00

README.md

kruise-rollout-api

The canonical location of the Kruise Rollout API definition and client.

Compatibility matrix

Kruise-Rollout-API Kruise-rollout
0.4.1 <= 0.4
0.5.0 0.5

Where does it come from?

kruise-rollout-api is synced from https://github.com/openkruise/rollouts/tree/master/api. Code changes are made in that location, merged into openkruise/rollouts and later synced here.

How to get it

To get the latest version, use go1.16+ and fetch using the go get command. For example:

go get github.com/openkruise/kruise-rollout-api@latest

To get a specific version, use go1.11+ and fetch the desired version using the go get command. For example:

go get github.com/openkruise/kruise-rollout-api@v0.4.1

How to use it

please refer to the example

Things you should NOT do

https://github.com/openkruise/rollouts/tree/master/api is synced to here. All changes must be made in the former. The latter is read-only.