-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.yaml
More file actions
856 lines (822 loc) · 24.3 KB
/
api.yaml
File metadata and controls
856 lines (822 loc) · 24.3 KB
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
openapi: 3.0.3
info:
title: Kploy API
description: |
API for the Kploy GitOps Kubernetes deployment system.
Two audiences share this surface. The kploy operator runs in each
cluster and authenticates with a cluster-scoped bearer token. The
kploy CLI is used by humans and authenticates with a GitHub OAuth
user-to-server token. Operations are tagged with `operator` or
`user` to make it clear which security scheme applies; the
document-level default applies to both.
version: 1.0.0
servers:
- url: /api/v1
description: API base path
tags:
- name: operator
description: Operator-facing endpoints (cluster bearer token).
- name: user
description: User-facing endpoints used by the `kploy` CLI (GitHub OAuth user token).
security:
- ClusterToken: []
- UserToken: []
paths:
###################################################################
# User-facing endpoints (CLI)
###################################################################
/auth/device-flow-config:
get:
tags: [user]
security: []
summary: GitHub OAuth Device Flow config for this kploy instance
description: |
Returns the GitHub App client ID the CLI should use for Device Flow
login. Unauthenticated by design — this lets `kploy auth login`
bootstrap before the user has a token.
operationId: getDeviceFlowConfig
responses:
'200':
description: Device flow config
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceFlowConfig'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs:
get:
tags: [user]
security:
- UserToken: []
summary: List organizations
description: Returns the GitHub organizations where the Kploy GitHub App is installed and the caller has access.
operationId: listOrgs
responses:
'200':
description: List of organizations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Organization'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos:
get:
tags: [user]
security:
- UserToken: []
summary: List repositories
description: Returns the repositories in the org for which Kploy has at least one environment configured.
operationId: listRepos
parameters:
- $ref: '#/components/parameters/Org'
responses:
'200':
description: List of repositories
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Repository'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/envs:
get:
tags: [user]
security:
- UserToken: []
summary: List environments
operationId: listEnvs
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
responses:
'200':
description: List of environments
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Environment'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags: [user]
security:
- UserToken: []
summary: Create an environment
operationId: createEnv
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentCreate'
responses:
'201':
description: Environment created
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
description: Environment name already exists
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/envs/{env}:
get:
tags: [user]
security:
- UserToken: []
summary: Get environment
operationId: getEnv
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
responses:
'200':
description: Environment
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/deployments/{deployment_id}/logs:
get:
tags: [user]
security:
- UserToken: []
summary: List the log lines for a deployment
description: |
Returns the deployment's log output as a JSON array, ordered by
emission timestamp. Suitable for batch viewing; no streaming yet.
operationId: listDeploymentLogs
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/DeploymentID'
responses:
'200':
description: List of log entries
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DeploymentLogEntry'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/clusters:
get:
tags: [user]
security:
- UserToken: []
summary: List clusters in the org
operationId: listClusters
parameters:
- $ref: '#/components/parameters/Org'
responses:
'200':
description: List of clusters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Cluster'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags: [user]
security:
- UserToken: []
summary: Create a cluster
description: |
Mints a new cluster with a one-shot bearer token. The token is
returned plaintext exactly once.
operationId: createCluster
parameters:
- $ref: '#/components/parameters/Org'
responses:
'201':
description: Cluster created
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterCreated'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
###################################################################
# Operator-facing endpoints
###################################################################
/cluster/{cluster_id}:
get:
tags: [operator]
security:
- ClusterToken: []
summary: Get cluster information
description: Returns the cluster's environments. Path parameter is redundant with the auth token but kept for compatibility with existing operators.
operationId: getCluster
parameters:
- name: cluster_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Cluster information
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterDetail'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/envs/{env}/manifest:
get:
tags: [operator]
security:
- ClusterToken: []
summary: Get the latest manifest for an environment
operationId: getEnvironmentManifest
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
- name: If-None-Match
in: header
schema:
type: string
description: ETag-like value (the X-Kploy-Manifest-SHA returned previously). Server returns 304 if unchanged.
responses:
'200':
description: Environment manifest
headers:
X-Kploy-Manifest-SHA:
schema:
type: string
description: SHA of the manifest
X-Kploy-Head-SHA:
schema:
type: string
description: SHA of the environment's branch HEAD
content:
application/x-yaml:
schema:
type: string
'204':
description: No manifest has been built for this environment yet
'304':
description: Not modified
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/envs/{env}/tracked-images:
get:
tags: [operator, user]
summary: List tracked images
description: |
Operators use this to know which images to poll for new tags.
Users use it to inspect what's currently being tracked. Same
response for both — auth scheme is the only difference.
operationId: listTrackedImages
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
responses:
'200':
description: List of tracked images
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrackedImage'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
tags: [operator]
security:
- ClusterToken: []
summary: Update available tags for one tracked image
description: |
Operator reports the set of tags discovered for a single image
in its registry. May trigger auto-deployment.
operationId: updateTrackedImage
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
available_tags:
type: array
items:
type: string
required: [name, available_tags]
responses:
'200':
description: Updated
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
tags: [user]
security:
- UserToken: []
summary: Replace the tracked-image list for an environment
description: |
Adds new images (`available_tags` starts empty), preserves
existing images that remain in the list, removes any that
aren't listed.
operationId: replaceTrackedImages
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
images:
type: array
items:
type: string
required: [images]
responses:
'200':
description: Updated tracked-image list
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TrackedImage'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: Invalid image name
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/envs/{env}/deployments:
get:
tags: [user]
security:
- UserToken: []
summary: List recent deployments for an environment
operationId: listDeployments
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
responses:
'200':
description: List of deployments
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Deployment'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags: [operator]
security:
- ClusterToken: []
summary: Trigger a deployment
description: |
Operator-side trigger: invoked after the operator detects a new
manifest SHA on the env's branch. Performs the GitHub
required-status-checks dance and creates a GitHub Deployment.
operationId: createDeployment
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/Env'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
sha:
type: string
required: [sha]
responses:
'200':
description: Deployment created
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentSummary'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
description: Deployment already in progress
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentSummary'
'422':
description: GitHub rejected the deployment because required status checks failed
'500':
$ref: '#/components/responses/InternalServerError'
'503':
description: Required status checks are still running; retry later
/orgs/{org}/repos/{repo}/deployments/{deployment_id}/progress:
post:
tags: [operator]
security:
- ClusterToken: []
summary: Update deployment progress
description: Operator streams output lines as the deployment runs.
operationId: updateDeploymentProgress
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/DeploymentID'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
output:
type: string
nullable: true
timestamp:
type: string
format: date-time
nullable: true
responses:
'200':
description: Progress recorded
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/orgs/{org}/repos/{repo}/deployments/{deployment_id}/complete:
patch:
tags: [operator]
security:
- ClusterToken: []
summary: Mark deployment complete
operationId: completeDeployment
parameters:
- $ref: '#/components/parameters/Org'
- $ref: '#/components/parameters/Repo'
- $ref: '#/components/parameters/DeploymentID'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
status:
$ref: '#/components/schemas/DeploymentStatus'
required: [status]
responses:
'200':
description: Marked complete
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
components:
securitySchemes:
ClusterToken:
type: apiKey
in: header
name: X-Kploy-Token
description: Cluster bearer token. Used by the kploy operator.
UserToken:
type: http
scheme: bearer
description: GitHub OAuth user-to-server token (issued via GitHub Device Flow). Used by the kploy CLI.
parameters:
Org:
name: org
in: path
required: true
schema:
type: string
description: GitHub organization (or user) login.
Repo:
name: repo
in: path
required: true
schema:
type: string
description: Repository name (no owner prefix).
Env:
name: env
in: path
required: true
schema:
type: string
description: Environment name.
DeploymentID:
name: deployment_id
in: path
required: true
schema:
type: integer
format: int64
description: GitHub deployment ID.
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Missing or invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
message:
type: string
required: [message]
Organization:
type: object
properties:
name:
type: string
avatar_url:
type: string
required: [name, avatar_url]
Repository:
type: object
properties:
name:
type: string
required: [name]
Environment:
type: object
properties:
name:
type: string
branch:
type: string
cluster_id:
type: string
kubernetes_namespace:
type: string
head_sha:
type: string
manifests_sha:
type: string
nullable: true
required: [name, branch, cluster_id, kubernetes_namespace, head_sha]
EnvironmentCreate:
type: object
properties:
name:
type: string
cluster_id:
type: string
branch:
type: string
kubernetes_namespace:
type: string
tracked_images:
type: array
items:
type: string
required: [name, cluster_id, branch, kubernetes_namespace]
EnvironmentSummary:
type: object
description: Compact environment representation used by `GET /cluster/{cluster_id}` so the operator can see all its envs at once.
properties:
name:
type: string
repository_name:
type: string
manifests_sha:
type: string
nullable: true
namespace:
type: string
required: [name, repository_name, namespace]
TrackedImage:
type: object
properties:
name:
type: string
available_tags:
type: array
items:
type: string
current_tag:
type: string
nullable: true
required: [name, available_tags]
Cluster:
type: object
properties:
id:
type: string
connected:
type: boolean
last_seen_at:
type: string
format: date-time
nullable: true
required: [id, connected]
ClusterCreated:
type: object
properties:
id:
type: string
token:
type: string
required: [id, token]
DeviceFlowConfig:
type: object
properties:
github_client_id:
type: string
required: [github_client_id]
ClusterDetail:
type: object
description: Cluster + its environments. Returned by `GET /cluster/{cluster_id}` for the operator.
properties:
id:
type: string
organization:
type: string
environments:
type: array
items:
$ref: '#/components/schemas/EnvironmentSummary'
required: [id, organization, environments]
DeploymentStatus:
type: string
enum: [success, failure, error]
Deployment:
type: object
properties:
id:
type: integer
format: int64
environment:
type: string
commit_sha:
type: string
commit_message:
type: string
status:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required: [id, environment, commit_sha, status, created_at, updated_at]
DeploymentLogEntry:
type: object
properties:
output:
type: string
emitted_at:
type: string
format: date-time
required: [output, emitted_at]
DeploymentSummary:
type: object
description: Minimal deployment shape returned to the operator after a `POST .../deployments`.
properties:
id:
type: integer
format: int64
environment:
type: string
nullable: true
namespace:
type: string
nullable: true
required: [id]