-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaction.yaml
127 lines (127 loc) · 5.84 KB
/
action.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
name: Function Action OIDC
description: Deploy a Cognite Function with schedules using OIDC
inputs:
deployment_client_secret:
description: Client secret to be used for deployment of the function.
required: true
deployment_client_id:
description: Client ID to be used for deployment of the function.
required: true
deployment_tenant_id:
description: Tenant ID to be used for deployment of the function.
required: true
schedules_client_secret:
description: |
If function is to be run with schedules, this is the client secret
to be used at runtime. Not providing this while also passing schedules
will cause an error to be raised.
required: false
schedules_client_id:
description: |
If function is to be run with schedules, this is the client ID
to be used at runtime. Not providing this while also passing schedules
will cause an error to be raised.
required: false
schedules_tenant_id:
description: |
If function is to be run with schedules, this is the tenant ID
to be used at runtime. Not providing this while also passing schedules
will cause an error to be raised.
required: false
cdf_project:
description: The name of your CDF project.
required: true
cdf_cluster:
description: The cluster your customer's CDF project lives in, like 'westeurope-1' or 'greenfield'.
required: true
function_external_id:
description: |
External ID and name of function. Must be unique within the CDF project as this action
always overwrites existing.
required: true
function_folder:
description: Path to the folder where the source code for the function(s) can be found.
required: false
function_file:
description: |
Relative path to the function file inside function folder, for example: 'nested/handler.py'. Defaults
to 'handler.py' in the root of the function folder if not provided.
required: false
function_secrets:
description: Base64 encoded string of secrets in JSON format. See README/secrets.
required: false
function_deploy_timeout:
description: Set the timeout limit in seconds for function deployment. Once reached, deployment is cancelled.
required: false
schedule_file:
description: |
Relative path and name from (function_folder) of the file with schedules to be attached.
Not passing this parameter -> no schedules will be attached. If the passed file does not
exist, a warning will be issued, and no schedules will be attached. On all deployments,
all existing schedules are deleted (and recreated if there are any)! Note: Requires
'schedules_client_secret', 'schedules_tenant_id' and 'schedules_client_id' to be passed!
required: false
data_set_id:
description: Data set ID to use for the file uploaded to CDF (the function-associated file, i.e. the zipped code folder)
required: false
common_folder:
description: |
Directory which contains code used by multiple functions. If not provided, only the function folder is packed into the zip file.
required: false
remove_only:
description: |
Short-cut that ONLY removes the function (and all schedules linked) before quitting. Only
requires deployment credentials, 'cdf_project' and 'function_external_id' to be passed.
required: false
post_deploy_cleanup:
description: |
If true (the default), the function zip-file uploaded to CDF Files will be
deleted after the Function has been successfully created.
required: false
await_deployment_success:
description: |
If true (the default), the function deployment will be awaited to verify a successful deployment.
Pass false to skip this check entirely. Warning: You will then need to manually verify the deployment!
required: false
cpu:
description: 'Set number of CPU cores per function, e.g. 0.5.'
required: false
memory:
description: 'Set memory per function measured in GB, e.g. 0.8.'
required: false
owner:
description: Set owner of a function, e.g. "My Client".
required: false
description:
description: Set description field of a function, e.g. "This does X for Y if Z".
required: false
env_vars:
description: Set environment variables for your function. Accepts JSON with string key/value pairs.
required: false
runtime:
description: |
Set function runtime (Python version). Not given translates into the API default, which can be found
along with the allowed versions in the API documentation.
required: false
metadata:
description: |
Set custom metadata for the function. Accepts JSON with string key/value pairs.
For example, '{"version":"1.0.0","released":"2022-09-14"}'.
required: false
index_url:
description: |
Index URL for Python Package Manager to use. Be aware of the intrinsic security
implications of using the index_url option
required: false
extra_index_urls:
description: |
Extra Index URLs for Python Package Manager to use. Be aware of the intrinsic security
implications of using the extra_index_urls option. Accepts JSON encoded list of strings,
for example: '["http://foo.bar", "https://bar.baz"]'
required: false
outputs:
function_external_id:
description: The external ID of the function.
runs:
using: docker
image: docker://cognite/function-action:v1-github