You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/concepts/cicd.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,36 +7,36 @@ description:
7
7
8
8
## Overview
9
9
10
-
OpenFunction has realized automatic building and serving, what we need now is to trigger it when the code changes, thus forming a complete CICD.
10
+
Previously users can use OpenFunction to build function or application source code into container images and then deploy the built image directly to the underlying sync/async Serverless runtime without user intervention.
11
11
12
-
OpenFunction use Revision Controller to trigger build when the source code changed, or rerun the application when the image changed.
12
+
But OpenFunction can neither rebuild the image and then redeploy it whenever the function or application source code changes nor redeploy the image whenever this image changes (When the image is built and pushed manually or in another function)
13
13
14
-
The Revision Controller will:
15
-
-Watch the source code in github, gitlab or gitee, rebuild the function when source code changed.
16
-
-Watch the bundle container image which include the soucre code, rebuild the function when image changed.
17
-
-Watch the images of functions that without builder, rerun the image when image changed.
14
+
Starting from v1.0.0, OpenFunction adds the ability to detect source code or image changes and then rebuilt and/or redeploy the new built image in a new component called `Revision Controller`. The Revision Controller is able to:
15
+
-Detect source code changes in github, gitlab or gitee, then rebuild and redeploy the new built image whenever the source code changes.
16
+
-Detect the bundle container image (image containing the source code) changes, then rebuild and redeploy the new built image whenever the bundle image changes.
17
+
-Detect the function or application image changes, then redeploy the new image whenever the function or application image changes.
18
18
19
19
## Quick start
20
20
21
-
### Install
21
+
### Install`Revision Controller`
22
22
23
-
You can install the Revision Controller when installing the [OpenFunction](https://openfunction.dev/docs/getting-started/installation/#install-openfunction), just need to add the following flag to the helm command.
23
+
You can enable `Revision Controller` when installing [OpenFunction](https://openfunction.dev/docs/getting-started/installation/#install-openfunction) by simply adding the following flag to the helm command.
24
24
25
25
```shell
26
26
--set revisionController.enable=true
27
27
```
28
28
29
-
Or you can install the`Revision Controller` after the `OpenFunction`installed by the following command.
29
+
You can also enable`Revision Controller` after `OpenFunction`is installed:
> The `Revision Controller`willbe installed to the `openfunction` namespace by default, if you want to install it to another namespace, please download the `bundle.yaml` and modify it before apply.
35
+
> The `Revision Controller`will be installed to the `openfunction` namespace by default. You can download `bundle.yaml` and change the namespace manually if you want to install it to another namespace.
36
36
37
-
### How to use
37
+
### Detect source code or image changes
38
38
39
-
To watch a function, just need to add some annotations to it.
39
+
To detect source code or image changes, you'll need to add revision controller switch and params like below to a function's annotation.
| **openfunction.io/revision-controller** | Whether to start a revision controller for this function, known values are enable and disable. |
64
+
| **openfunction.io/revision-controller** | Whether to enable revision controller to detect source code or image changes for this function, can be set to either `enable` or `disable`. |
65
65
| **openfunction.io/revision-controller-params** | Parameters for revision controller. |
0 commit comments