8000 feat(ui): on action - add url to official doc (#3809) · ovh/cds@3d9a103 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit 3d9a103

Browse files
yesnaultrichardlt
yesnault
authored and
richardlt
committed
feat(ui): on action - add url to official doc (#3809)
close #672 Signed-off-by: Yvonnick Esnault <yvonnick.esnault@corp.ovh.com>
1 parent d3d8a28 commit 3d9a103

‎contrib/grpcplugins/action/kafka-publish/kafka-publish.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: |
77
You are able to send a custom "message" file and all the artifacts you want: there is no file size limit. To improve security, you can encrypt the files content with a GPG Key. From the consumer side, you will need to decrypt files content with you GPG private key and your passphrase.
88
99
This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.
10+
11+
How to use: https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish
1012
parameters:
1113
message:
1214
type: text

‎contrib/grpcplugins/action/kafka-publish/main.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ func (actPlugin *kafkaPublishActionPlugin) Manifest(ctx context.Context, _ *empt
3838
3939
You are able to send a custom "message" file and all the artifacts you want: there is no file size limit. To improve security, you can encrypt the files content with a GPG Key. From the consumer side, you will need to decrypt files content with you GPG private key and your passphrase.
4040
41-
This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.`,
41+
This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.
42+
43+
How to use: https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish
44+
`,
4245
Version: sdk.VERSION,
4346
}, nil
4447
}

‎docs/content/workflows/pipelines/actions/builtin/checkout-application.md renamed to ‎docs/content/workflows/pipelines/actions/builtin/checkoutapplication.md

File renamed without changes.

‎docs/content/workflows/pipelines/actions/builtin/deployapplication.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
+++
2+
title = "DeployApplication"
3+
chapter = true
4+
5+
+++
6+
7+
**DeployApplication** is a builtin action, you can't modify it.
8+
9+
This action is useful only if you have a Deployment Plaftorm associated to your current application.
10+
11+
### Example
12+
13+
* Add a deployment platform on your application.
14+
15+
![img](/images/workflows.pipelines.actions.builtin.deploy-application-1.png)
16+
17+
* Create a workflow, add a pipeline and an application linked to a platform.
18+
19+
![img](/images/workflows.pipelines.actions.builtin.deploy-application-2.png)
20+
21+
* Or edit the pipeline context from your workflow view.
22+
23+
![img](/images/workflows.pipelines.actions.builtin.deploy-application-3.png)
24+
25+
* In the job, use action DeployApplication
26+
27+
![img](/images/workflows.pipelines.actions.builtin.deploy-application-4.png)

‎docs/content/workflows/pipelines/actions/plugins/plugin-archive.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,4 @@ This is a plugin to compress or uncompress an archive. Supported formats: .zip,
1212
* **action**: "compress" or "uncompress" an archive
1313

1414

15-
## More
16-
17-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/archive/README.md)
18-
1915

‎docs/content/workflows/pipelines/actions/plugins/plugin-clair.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,4 @@ This is a plugin to run clair analysis
1010
* **image**: Image to analyze
1111

1212

13-
## More
14-
15-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/clair/README.md)
16-
1713

‎docs/content/workflows/pipelines/actions/plugins/plugin-download.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,4 @@ This is a plugin to download file from URL
1212
* **headers**: Specific headers to add to your request ("headerName"="value" newline separated list)
1313

1414

15-
## More
16-
17-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/download/README.md)
18-
1915

‎docs/content/workflows/pipelines/actions/plugins/plugin-group-tmpl.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,4 @@ Check documentation on text/template for more information https://golang.org/pkg
1515
* **applications**: Applications file variables
1616

1717

18-
## More
19-
20-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/group-tmpl/README.md)
21-
2218

‎docs/content/workflows/pipelines/actions/plugins/plugin-kafka-publish.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,18 @@ This action is a CDS Plugin packaged as a single binary file you can download an
1212

1313
## Parameters
1414

15+
* **kafkaPassword**: Kafka password
16+
* **kafkaAddresses**: Kafka Addresses
1517
* **topic**: Kafka Topic
1618
* **artifacts**: Artifacts list (comma separated)"
17-
* **publicKey**: GPG Public Key (ASCII armored format)
1819
* **key**: Key used by AES Encryption. It have to be the same value as --key on plugin binary
19-
* **waitForAck**: Wait for ACK
20-
* **waitForAckTimeout**: Ack timeout (seconds). Used only if "waitForAck" is true.
21-
* **kafkaAddresses**: Kafka Addresses
2220
* **kafkaUser**: Kafka user
23-
* **kafkaPassword**: Kafka password
2421
* **kafkaGroup**: Kafka Consumer Group (used for acknowledgment)
22+
* **publicKey**: GPG Public Key (ASCII armored format)
23+
* **waitForAck**: Wait for ACK
2524
* **waitForAckTopic**: Wait for ACK topic
25+
* **waitForAckTimeout**: Ack timeout (seconds). Used only if "waitForAck" is true.
2626
* **message**: Kafka Message
2727

2828

29-
## More
30-
31-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish/README.md)
32-
3329

‎docs/content/workflows/pipelines/actions/plugins/plugin-marathon.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Your marathon.json file can be templated with cds variables "{{.cds.variables}}"
1010

1111
## Parameters
1212

13-
* **url**: Marathon URL http://127.0.0.1:8081,http://127.0.0.1:8082,http://127.0.0.1:8083
14-
* **user**: Marathon User (please use project, application or environment variables)
1513
* **password**: Marathon Password (please use project, application or environment variables)
1614
* **configuration**: Marathon application configuration file (json format)
1715
* **waitForDeployment**: Wait for instances deployment.
@@ -20,10 +18,8 @@ If not set, CDS will consider a successful result if marathon accepts the provid
2018

2119
* **insecureSkipVerify**: Skip SSL Verify if you want to use self-signed certificate
2220
* **timeout**: Marathon deployment timeout (seconds). Used only if "waitForDeployment" is true.
21+
* **url**: Marathon URL http://127.0.0.1:8081,http://127.0.0.1:8082,http://127.0.0.1:8083
22+
* **user**: Marathon User (please use project, application or environment variables)
2323

2424

25-
## More
26-
27-
More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/marathon/README.md)
28-
2925

0 commit comments

Comments
 (0)
0