apl-api/src/openapi/workload.yaml at 7d1d7691044216b371c4ac9b6783a6f08b36c4e0 · linode/apl-api · GitHub

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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
Workload:
  x-acl:
    platformAdmin:
      - create-any
      - read-any
      - update-any
      - delete-any
    teamAdmin:
      - create
      - read
      - update
      - delete
    teamMember:
      - create
      - read
      - update
      - delete
  type: object
  description: Define the location of the Workloads's manifests or Helm chart.
  properties:
    id:
      type: string
    teamId:
      $ref: 'definitions.yaml#/idName'
    name:
      title: Name
      $ref: 'definitions.yaml#/idName'
    icon:
      $ref: 'definitions.yaml#/wordCharacterPattern'
    url:
      description: URL to either Helm or Git repository
      $ref: 'definitions.yaml#/url'
    chartProvider:
      type: string
      title: Chart provider
      enum: ['helm', 'git']
      default: git
    path:
      description: A relative directory path within the Git repository. Absolute paths cause errors. (only valid for applications sourced from Git).
      $ref: 'definitions.yaml#/wordCharacterPattern'
    chart:
      description: Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
      $ref: 'definitions.yaml#/wordCharacterPattern'
    revision:
      description: In case of Git, this can be commit, tag, or branch. If omitted, will equal to main. In case of Helm, this is a semver tag for the Chart's version.
      $ref: 'definitions.yaml#/wordCharacterPattern'
      default: main
    chartMetadata:
      title: Chart metadata
      properties:
        helmChartVersion:
          type: string
          title: Helm chart version
          default: ''
        helmChartDescription:
          type: string
          title: Helm chart description
          default: ''
    namespace:
      description: Workload namespace. Applicable only for team-admin. Default value is 'team-<team_id>'.
      $ref: 'definitions.yaml#/idName'
    createNamespace:
      title: Create a new namespace
      type: boolean
      default: false
    sidecarInject:
      title: Enable istio sidecar injection
      type: boolean
      default: false
    imageUpdateStrategy:
      description: Automatically update the image. Only supported when the image is stored in Harbor.
      title: Auto Image Updater
      type: object
      oneOf:
        - title: Disabled
          x-hideTitle: true
          type: object
          properties:
            type:
              type: string
              enum:
                - disabled
              default: disabled
        - title: digest
          type: object
          x-hideTitle: true
          description: Update to the most recent pushed version of a given tag.
          properties:
            digest:
              additionalProperties: false
              type: object
              title: Digest
              properties:
                imageRepository:
                  type: string
                  description: The image repository name.
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                tag:
                  description: Tag of the build.
                  type: string
                  default: latest
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                imageParameter:
                  type: string
                  default: image.repository
                tagParameter:
                  type: string
                  default: image.tag
              required:
                - imageRepository
                - tag
            type:
              type: string
              enum:
                - digest
              default: digest
        - title: semver
          x-hideTitle: true
          type: object
          description: Update to a semantic version.
          properties:
            semver:
              additionalProperties: false
              type: object
              title: Semver
              properties:
                imageRepository:
                  type: string
                  description: The container image repository name.
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                versionConstraint:
                  type: string
                  default: 'v1.0'
                  description: 'Example: v1.0 would allow the image to be updated to any patch version within the v1.0 minor release.'
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                imageParameter:
                  type: string
                  default: image.repository
                tagParameter:
                  type: string
                  default: image.tag
              required:
                - imageRepository
                - versionConstraint
            type:
              type: string
              enum:
                - semver
              default: semver
  required:
    - name
    - url

WorkloadValues:
  x-acl:
    platformAdmin: [read-any, update-any]
    teamAdmin: [read, update]
    teamMember: [read, update]
  type: object
  properties:
    id:
      type: string
    teamId:
      $ref: 'definitions.yaml#/idName'
    name:
      $ref: 'definitions.yaml#/idName'
    values:
      oneOf:
        - type: object
        - type: string
  required:
    - values

AplWorkloadSpec:
  type: object
  description: Define the location of the Workloads's manifests or Helm chart.
  properties:
    icon:
      $ref: 'definitions.yaml#/wordCharacterPattern'
    url:
      description: URL to either Helm or Git repository
      $ref: 'definitions.yaml#/url'
    chartProvider:
      type: string
      title: Chart provider
      enum: ['helm', 'git']
      default: git
    path:
      description: A relative directory path within the Git repository. Absolute paths cause errors. (only valid for applications sourced from Git).
      $ref: 'definitions.yaml#/wordCharacterPattern'
    chart:
      description: Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
      $ref: 'definitions.yaml#/wordCharacterPattern'
    revision:
      description: In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.
      $ref: 'definitions.yaml#/wordCharacterPattern'
      default: main
    chartMetadata:
      title: Chart metadata
      properties:
        helmChartVersion:
          type: string
          title: Helm chart version
          default: ''
        helmChartDescription:
          type: string
          title: Helm chart description
          default: ''
    namespace:
      description: Workload namespace. Applicable only for team-admin. Default value is 'team-<team_id>'.
      $ref: 'definitions.yaml#/idName'
    createNamespace:
      title: Create a new namespace
      type: boolean
      default: false
    sidecarInject:
      title: Enable istio sidecar injection
      type: boolean
      default: false
    imageUpdateStrategy:
      description: Automatically update the image. Only supported when the image is stored in Harbor.
      title: Auto Image Updater
      type: object
      oneOf:
        - title: Disabled
          x-hideTitle: true
          type: object
          properties:
            type:
              type: string
              enum:
                - disabled
              default: disabled
        - title: digest
          type: object
          x-hideTitle: true
          description: Update to the most recent pushed version of a given tag.
          properties:
            digest:
              additionalProperties: false
              type: object
              title: Digest
              properties:
                imageRepository:
                  type: string
                  description: The image repository name.
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                tag:
                  description: Tag of the build.
                  type: string
                  default: latest
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                imageParameter:
                  type: string
                  default: image.repository
                tagParameter:
                  type: string
                  default: image.tag
              required:
                - imageRepository
                - tag
            type:
              type: string
              enum:
                - digest
              default: digest
        - title: semver
          x-hideTitle: true
          type: object
          description: Update to a semantic version.
          properties:
            semver:
              additionalProperties: false
              type: object
              title: Semver
              properties:
                imageRepository:
                  type: string
                  description: The container image repository name.
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                versionConstraint:
                  type: string
                  default: 'v1.0'
                  description: 'Example: v1.0 would allow the image to be updated to any patch version within the v1.0 minor release.'
                  $ref: 'definitions.yaml#/wordCharacterPattern'
                imageParameter:
                  type: string
                  default: image.repository
                tagParameter:
                  type: string
                  default: image.tag
              required:
                - imageRepository
                - versionConstraint
            type:
              type: string
              enum:
                - semver
              default: semver
    values:
      type: string
  required:
    - url