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: docs/content/development/contribute/documentation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ card:
5
5
name: contribute
6
6
---
7
7
8
-
Documentation https://ovh.github.io/cds is generated with Hugo. Source are under https://github.com/ovh/cds/tree/{{< param "version" >}}/docs/content
8
+
Documentation https://ovh.github.io/cds is generated with Hugo. Source are under https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/docs/content
Copy file name to clipboardexpand all lines: docs/content/development/contribute/hatchery.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ card:
9
9
10
10
* First of all you need to create a new package like the other into the hatchery package. Let's call this package vSphere for our example.
11
11
12
-
* You have to implement the Service interface (see [here](https://github.com/ovh/cds/blob/{{< param "version" >}}/engine/types.go)) in order to configure launch this new hatchery mode via CDS engine CLI.
12
+
* You have to implement the Service interface (see [here](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/engine/types.go)) in order to configure launch this new hatchery mode via CDS engine CLI.
13
13
14
-
* Your have to create a Configuration structure composed of the [hatchery.CommonConfiguration](https://godoc.org/github.com/ovh/cds/sdk/hatchery#CommonConfiguration) and the variables you need to access to vSphere API. You finally have to update the [engine main.go file](https://github.com/ovh/cds/blob/{{< param "version" >}}/engine/main.go) to manage this new service and add and manage the configuration structure as part of the [global configuration](https://github.com/ovh/cds/blob/{{< param "version" >}}/engine/types.go).
14
+
* Your have to create a Configuration structure composed of the [hatchery.CommonConfiguration](https://godoc.org/github.com/ovh/cds/sdk/hatchery#CommonConfiguration) and the variables you need to access to vSphere API. You finally have to update the [engine main.go file](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/engine/main.go) to manage this new service and add and manage the configuration structure as part of the [global configuration](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/engine/types.go).
15
15
16
16
* You need to implement the hatchery interface (see [here](https://godoc.org/github.com/ovh/cds/sdk/hatchery#Interface))
Copy file name to clipboardexpand all lines: docs/content/development/contribute/plugin.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,14 @@ A CDS worker executes job, and job is composed of steps.
9
9
10
10
A step is an [action]({{< relref "/docs/actions/_index.md" >}})
11
11
12
-
A Plugin is simply an executable which expose a GRPC server corresponding to the right [proto file](https://github.com/ovh/cds/tree/{{< param "version" >}}/sdk/grpcplugin/actionplugin/actionplugin.proto). You can use the programming language of your choice. The CDS worker will simply query the GRPC server of the plugin.
12
+
A Plugin is simply an executable which expose a GRPC server corresponding to the right [proto file](https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/sdk/grpcplugin/actionplugin/actionplugin.proto). You can use the programming language of your choice. The CDS worker will simply query the GRPC server of the plugin.
13
13
14
14
In order to communicate with a CDS worker, a plugin MUST fill the following requirements:
15
15
16
16
+ Expose a GRPC server
17
-
+ Implement methods and messages coming from this [proto file](https://github.com/ovh/cds/tree/{{< param "version" >}}/sdk/grpcplugin/actionplugin/actionplugin.proto)
17
+
+ Implement methods and messages coming from this [proto file](https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/sdk/grpcplugin/actionplugin/actionplugin.proto)
18
18
+ Display this message at the launch of your plugin XXX is ready to accept new connection where XXX is your ip address with port or your Unix socket (example: `127.0.0.1:55939 is ready to accept new connection` or for a Unix socket `XXX.sock is ready to accept new connection`). Note that your plugin can use any Unix socket or tcp port as long as it informs the worker using the log line above.
19
19
20
-
More resources that may help you in developing a CDS plugin are available: [SDK in this directory](https://github.com/ovh/cds/tree/{{< param "version" >}}/sdk/grpcplugin/actionplugin) with some examples [here](https://github.com/ovh/cds/tree/{{< param "version" >}}/contrib/grpcplugins/action/examples).
20
+
More resources that may help you in developing a CDS plugin are available: [SDK in this directory](https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/sdk/grpcplugin/actionplugin) with some examples [here](https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/contrib/grpcplugins/action/examples).
21
21
22
-
Contribute on https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action
22
+
Contribute on https://github.com/ovh/cds/tree/{{< param "version" "master" >}}/contrib/grpcplugins/action
Copy file name to clipboardexpand all lines: docs/content/docs/components/_index.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -15,16 +15,16 @@ cards:
15
15
description: "The most powerful Command Line for a CI/CD Platform. cdsctl is the CDS Command Line - you can script everything with it, cdsctl also provide some cool commands such as cdsctl shell to browse your projects and workflows without the need to open a browser."
16
16
button: "cdsctl reference"
17
17
button_path: "/docs/components/cdsctl"
18
-
- name: worker
19
-
title: "CDS Worker"
20
-
description: "A pipeline is structured in sequential stages containing one or multiple concurrent jobs. A Job will be executed by a worker. The binary worker is available from CDS Job"
21
-
button: "worker reference"
22
-
button_path: "/docs/components/worker"
23
18
- name: hatchery
24
19
title: "Hatchery"
25
20
description: "Hatchery is a service dedicated to spawn and kill worker in accordance with build queue needs."
26
21
button: "Discover the Hatchery component"
27
22
button_path: "/docs/components/hatchery"
23
+
- name: worker
24
+
title: "CDS Worker"
25
+
description: "A pipeline is structured in sequential stages containing one or multiple concurrent jobs. A Job will be executed by a worker. The binary worker is available from CDS Job"
26
+
button: "worker reference"
27
+
button_path: "/docs/components/worker"
28
28
- name: Engine
29
29
title: "Engine"
30
30
description: "Engine is the core component of CDS"
Copy file name to clipboardexpand all lines: docs/content/docs/concepts/workflow/notifications.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ For the go templating you have few variables you can use/iterate over.
28
28
-`.TotalKO`: total number of KO tests
29
29
-`.TotalSkipped`: total number of skipped tests
30
30
31
-
If you need to know about other variable you can check `WorkflowNodeRun` data structure [here](https://github.com/ovh/cds/blob/{{< param "version" >}}/sdk/workflow_run.go).
31
+
If you need to know about other variable you can check `WorkflowNodeRun` data structure [here](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/sdk/workflow_run.go).
32
32
33
33
For example by default the template of pull-request comment is:
If you need to trigger some specific actions on the technical side, like for example use a microservice which listens to all events in your workflow (updates, launch, stop, etc.), you can add an event integration like, for example, [Kafka]({{< relref "/docs/integrations/kafka/kafka_events.md">}}) and listen to the kafka topic to trigger some actions on your side. Events are more like sending notifications to machines instead of user notifications which are made for users. The see structure of sent events, you can look [here](https://github.com/ovh/cds/blob/{{< param "version" >}}/sdk/event.go) and [here](https://github.com/ovh/cds/blob/{{< param "version" >}}/sdk/event_workflow.go).
75
+
If you need to trigger some specific actions on the technical side, like for example use a microservice which listens to all events in your workflow (updates, launch, stop, etc.), you can add an event integration like, for example, [Kafka]({{< relref "/docs/integrations/kafka/kafka_events.md">}}) and listen to the kafka topic to trigger some actions on your side. Events are more like sending notifications to machines instead of user notifications which are made for users. The see structure of sent events, you can look [here](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/sdk/event.go) and [here](https://github.com/ovh/cds/blob/{{< param "version" "master" >}}/sdk/event_workflow.go).
0 commit comments