forked from project-kessel/inventory-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
924 lines (923 loc) · 42.7 KB
/
openapi.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
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
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/api/inventory/v1/livez:
get:
tags:
- KesselInventoryHealthService
operationId: KesselInventoryHealthService_GetLivez
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1.GetLivezResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1/readyz:
get:
tags:
- KesselInventoryHealthService
operationId: KesselInventoryHealthService_GetReadyz
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1.GetReadyzResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1beta1/resource-relationships/k8s-policy_is-propagated-to_k8s-cluster:
put:
tags:
- KesselK8SPolicyIsPropagatedToK8SClusterService
operationId: KesselK8SPolicyIsPropagatedToK8SClusterService_UpdateK8SPolicyIsPropagatedToK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.UpdateK8SPolicyIsPropagatedToK8SClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.UpdateK8SPolicyIsPropagatedToK8SClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
post:
tags:
- KesselK8SPolicyIsPropagatedToK8SClusterService
operationId: KesselK8SPolicyIsPropagatedToK8SClusterService_CreateK8SPolicyIsPropagatedToK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.CreateK8SPolicyIsPropagatedToK8SClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.CreateK8SPolicyIsPropagatedToK8SClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
delete:
tags:
- KesselK8SPolicyIsPropagatedToK8SClusterService
operationId: KesselK8SPolicyIsPropagatedToK8SClusterService_DeleteK8SPolicyIsPropagatedToK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.DeleteK8SPolicyIsPropagatedToK8SClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.DeleteK8SPolicyIsPropagatedToK8SClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1beta1/resources/k8s-clusters:
put:
tags:
- KesselK8SClusterService
operationId: KesselK8SClusterService_UpdateK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateK8sClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateK8sClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
post:
tags:
- KesselK8SClusterService
operationId: KesselK8SClusterService_CreateK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateK8sClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateK8sClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
delete:
tags:
- KesselK8SClusterService
operationId: KesselK8SClusterService_DeleteK8SCluster
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteK8sClusterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteK8sClusterResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1beta1/resources/k8s-policies:
put:
tags:
- KesselK8SPolicyService
operationId: KesselK8SPolicyService_UpdateK8SPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateK8sPolicyRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateK8sPolicyResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
post:
tags:
- KesselK8SPolicyService
operationId: KesselK8SPolicyService_CreateK8SPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateK8sPolicyRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateK8sPolicyResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
delete:
tags:
- KesselK8SPolicyService
operationId: KesselK8SPolicyService_DeleteK8SPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteK8sPolicyRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteK8sPolicyResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1beta1/resources/notifications-integrations:
put:
tags:
- KesselNotificationsIntegrationService
operationId: KesselNotificationsIntegrationService_UpdateNotificationsIntegration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateNotificationsIntegrationRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateNotificationsIntegrationResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
post:
tags:
- KesselNotificationsIntegrationService
operationId: KesselNotificationsIntegrationService_CreateNotificationsIntegration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateNotificationsIntegrationRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateNotificationsIntegrationResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
delete:
tags:
- KesselNotificationsIntegrationService
operationId: KesselNotificationsIntegrationService_DeleteNotificationsIntegration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteNotificationsIntegrationRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteNotificationsIntegrationResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/api/inventory/v1beta1/resources/rhel-hosts:
put:
tags:
- KesselRhelHostService
operationId: KesselRhelHostService_UpdateRhelHost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateRhelHostRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.UpdateRhelHostResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
post:
tags:
- KesselRhelHostService
operationId: KesselRhelHostService_CreateRhelHost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateRhelHostRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.CreateRhelHostResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
delete:
tags:
- KesselRhelHostService
operationId: KesselRhelHostService_DeleteRhelHost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteRhelHostRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.DeleteRhelHostResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
components:
schemas:
google.protobuf.Any:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
google.rpc.Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/google.protobuf.Any'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
kessel.inventory.v1.GetLivezResponse:
type: object
properties:
status:
type: string
code:
type: integer
format: uint32
kessel.inventory.v1.GetReadyzResponse:
type: object
properties:
status:
type: string
code:
type: integer
format: uint32
kessel.inventory.v1beta1.relationships.CreateK8SPolicyIsPropagatedToK8SClusterRequest:
type: object
properties:
k8s-policy_is-propagated-to_k8s-cluster:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.K8SPolicyIsPropagatedToK8SCluster'
description: The resource relationship to create in Kessel Asset Inventory
kessel.inventory.v1beta1.relationships.CreateK8SPolicyIsPropagatedToK8SClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.relationships.DeleteK8SPolicyIsPropagatedToK8SClusterRequest:
type: object
properties:
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.ReporterData'
description: "The resource-relationship to be deleted will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instance_id>:<reporter_data.subject_local_resource_id>\\\"\n AND \\\"<reporter_data.reporter_type>:<reporter_instance_id>:<reporter_data.object_local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.relationships.DeleteK8SPolicyIsPropagatedToK8SClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.relationships.K8SPolicyIsPropagatedToK8SCluster:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.Metadata'
description: Metadata about this resource
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.ReporterData'
description: Write only reporter specific data
relationship_data:
$ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.K8SPolicyIsPropagatedToK8SClusterDetail'
kessel.inventory.v1beta1.relationships.K8SPolicyIsPropagatedToK8SClusterDetail:
type: object
properties:
k8s_policy_id:
readOnly: true
type: string
description: The resource ID assigned to the resource by Kessel Asset Inventory.
k8s_cluster_id:
readOnly: true
type: string
description: The resource ID assigned to the resource by Kessel Asset Inventory.
status:
enum:
- STATUS_UNSPECIFIED
- STATUS_OTHER
- VIOLATIONS
- NO_VIOLATIONS
type: string
format: enum
kessel.inventory.v1beta1.relationships.Metadata:
type: object
properties:
id:
readOnly: true
type: string
description: Kessel Asset Inventory generated identifier.
relationship_type:
readOnly: true
type: string
description: The type of Resource relationship
created_at:
readOnly: true
type: string
description: Date and time when the inventory item was first reported.
format: date-time
updated_at:
readOnly: true
type: string
description: Date and time when the inventory item was last updated.
format: date-time
deleted_at:
readOnly: true
type: string
description: Date and time when the inventory item was deleted.
format: date-time
org_id:
type: string
description: |-
The org id in which this resource is a member for access control. A
resource can only be a member of one org.
kessel.inventory.v1beta1.relationships.ReporterData:
type: object
properties:
reporter_type:
enum:
- REPORTER_TYPE_UNSPECIFIED
- REPORTER_TYPE_OTHER
- ACM
- HBI
- OCM
- NOTIFICATIONS
type: string
format: enum
reporter_instance_id:
readOnly: true
type: string
description: |-
The ID of the instance of the reporter. This is derived from the
authentication mechanism, i.e. authentication token.
reporter_version:
type: string
description: version of the reporter
first_reported:
readOnly: true
type: string
description: Date and time when the inventory item was first reported by this reporter
format: date-time
last_reported:
readOnly: true
type: string
description: Date and time when the inventory item was last updated by this reporter
format: date-time
subject_local_resource_id:
type: string
description: "The ID assigned by the reporter to resource which is the subject of the relationship. For example \n OCM cluster ID, HBI's host id, or ACM managed cluster name etc."
object_local_resource_id:
type: string
description: "The ID assigned by the reporter to resource which is the object of the relationship. For example \n OCM cluster ID, HBI's host id, or ACM managed cluster name etc."
kessel.inventory.v1beta1.relationships.UpdateK8SPolicyIsPropagatedToK8SClusterRequest:
type: object
properties:
k8s-policy_is-propagated-to_k8s-cluster:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.relationships.K8SPolicyIsPropagatedToK8SCluster'
description: "The resource-relationship to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instance_id>:<reporter_data.subject_local_resource_id>\\\"\n AND \\\"<reporter_data.reporter_type>:<reporter_instance_id>:<reporter_data.object_local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.relationships.UpdateK8SPolicyIsPropagatedToK8SClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.CreateK8sClusterRequest:
type: object
properties:
k8s_cluster:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sCluster'
description: The k8s cluster to create in Kessel Asset Inventory
kessel.inventory.v1beta1.resources.CreateK8sClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.CreateK8sPolicyRequest:
type: object
properties:
k8s_policy:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sPolicy'
description: The policy to create in Kessel Asset Inventory
kessel.inventory.v1beta1.resources.CreateK8sPolicyResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.CreateNotificationsIntegrationRequest:
type: object
properties:
integration:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.NotificationsIntegration'
description: The NotificationsIntegration to create in Kessel Asset Inventory
kessel.inventory.v1beta1.resources.CreateNotificationsIntegrationResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.CreateRhelHostRequest:
type: object
properties:
rhel_host:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.RhelHost'
description: The Rhel Host to create in Kessel Asset Inventory
kessel.inventory.v1beta1.resources.CreateRhelHostResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.DeleteK8sClusterRequest:
type: object
properties:
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: "The resource to be deleted will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\" \n from the request body."
kessel.inventory.v1beta1.resources.DeleteK8sClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.DeleteK8sPolicyRequest:
type: object
properties:
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: "The resource to be deleted will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.DeleteK8sPolicyResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.DeleteNotificationsIntegrationRequest:
type: object
properties:
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: "The resource to be deleted will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.DeleteNotificationsIntegrationResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.DeleteRhelHostRequest:
type: object
properties:
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: "The resource to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.DeleteRhelHostResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.K8sCluster:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.Metadata'
description: Metadata about this resource
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: Write only reporter specific data
resource_data:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sClusterDetail'
kessel.inventory.v1beta1.resources.K8sClusterDetail:
type: object
properties:
external_cluster_id:
type: string
description: The OCP cluster ID or ARN etc for *KS
cluster_status:
enum:
- CLUSTER_STATUS_UNSPECIFIED
- CLUSTER_STATUS_OTHER
- READY
- FAILED
- OFFLINE
type: string
format: enum
kube_version:
type: string
description: The version of kubernetes
kube_vendor:
enum:
- KUBE_VENDOR_UNSPECIFIED
- KUBE_VENDOR_OTHER
- AKS
- EKS
- IKS
- OPENSHIFT
- GKE
type: string
format: enum
vendor_version:
type: string
description: The version of the productized kubernetes distribution
cloud_platform:
enum:
- CLOUD_PLATFORM_UNSPECIFIED
- CLOUD_PLATFORM_OTHER
- NONE_UPI
- BAREMETAL_IPI
- BAREMETAL_UPI
- AWS_IPI
- AWS_UPI
- AZURE_IPI
- AZURE_UPI
- IBMCLOUD_IPI
- IBMCLOUD_UPI
- KUBEVIRT_IPI
- OPENSTACK_IPI
- OPENSTACK_UPI
- GCP_IPI
- GCP_UPI
- NUTANIX_IPI
- NUTANIX_UPI
- VSPHERE_IPI
- VSPHERE_UPI
- OVIRT_IPI
type: string
format: enum
nodes:
type: array
items:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sClusterDetailNodesInner'
kessel.inventory.v1beta1.resources.K8sClusterDetailNodesInner:
type: object
properties:
name:
type: string
description: The name of the node (this can contain private info)
cpu:
type: string
description: CPU Capacity of the node defined in CPU units, e.g. \"0.5\"
memory:
type: string
description: Memory Capacity of the node defined as MiB, e.g. \"50Mi\"
labels:
type: array
items:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ResourceLabel'
description: |-
Map of string keys and string values that can be used to organize and
categorize (scope and select) resources
Todo: Do we require at least 1 label?
kessel.inventory.v1beta1.resources.K8sPolicy:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.Metadata'
description: Metadata about this resource
reporter_data:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: Write only reporter specific data
resource_data:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sPolicyDetail'
kessel.inventory.v1beta1.resources.K8sPolicyDetail:
type: object
properties:
disabled:
type: boolean
description: Defines if the policy is currently enabled or disabled across all targets
severity:
enum:
- SEVERITY_UNSPECIFIED
- SEVERITY_OTHER
- LOW
- MEDIUM
- HIGH
- CRITICAL
type: string
format: enum
kessel.inventory.v1beta1.resources.Metadata:
type: object
properties:
id:
readOnly: true
type: string
description: Kessel Asset Inventory generated identifier.
resource_type:
readOnly: true
type: string
description: The type of the Resource
created_at:
readOnly: true
type: string
description: Date and time when the inventory item was first reported.
format: date-time
updated_at:
readOnly: true
type: string
description: Date and time when the inventory item was last updated.
format: date-time
deleted_at:
readOnly: true
type: string
description: Date and time when the inventory item was deleted.
format: date-time
org_id:
type: string
description: |-
The org id in which this resource is a member for access control. A
resource can only be a member of one org.
workspace_id:
type: string
description: |-
The workspace id in which this resource is a member for access control. A
resource can only be a member of one workspace.
labels:
type: array
items:
$ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ResourceLabel'
kessel.inventory.v1beta1.resources.NotificationsIntegration:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.Metadata'
description: Metadata about this resource
reporter_data:
writeOnly: true
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: Write only reporter specific data
kessel.inventory.v1beta1.resources.ReporterData:
type: object
properties:
reporter_type:
enum:
- REPORTER_TYPE_UNSPECIFIED
- REPORTER_TYPE_OTHER
- ACM
- HBI
- OCM
- NOTIFICATIONS
type: string
format: enum
reporter_instance_id:
readOnly: true
type: string
description: |-
The ID of the instance of the reporter. This is derived from the
authentication mechanism, i.e. authentication token.
console_href:
type: string
description: |-
The URL for this resource in the reporter's management UI console. For
example this would be the cluster URL in the HCC Console for an OCM
reported cluster.
api_href:
type: string
description: Reporter specific API link to the resource.
local_resource_id:
type: string
description: |-
The ID assigned to this resource by the reporter, for example OCM cluster
ID, HBI's host id, or ACM managed cluster name etc.
reporter_version:
type: string
description: version of the reporter
kessel.inventory.v1beta1.resources.ResourceLabel:
type: object
properties:
key:
type: string
value:
type: string
kessel.inventory.v1beta1.resources.RhelHost:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.Metadata'
description: Metadata about this resource
reporter_data:
writeOnly: true
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.ReporterData'
description: Write only reporter specific data
kessel.inventory.v1beta1.resources.UpdateK8sClusterRequest:
type: object
properties:
k8s_cluster:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sCluster'
description: "The resource to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.UpdateK8sClusterResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.UpdateK8sPolicyRequest:
type: object
properties:
k8s_policy:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.K8sPolicy'
description: "The resource to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.UpdateK8sPolicyResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.UpdateNotificationsIntegrationRequest:
type: object
properties:
integration:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.NotificationsIntegration'
description: "The resource to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.UpdateNotificationsIntegrationResponse:
type: object
properties: {}
kessel.inventory.v1beta1.resources.UpdateRhelHostRequest:
type: object
properties:
rhel_host:
allOf:
- $ref: '#/components/schemas/kessel.inventory.v1beta1.resources.RhelHost'
description: "The resource to be updated will be defined by \n \\\"<reporter_data.reporter_type>:<reporter_instaance_id>:<reporter_data.local_resource_id>\\\"\n from the request body."
kessel.inventory.v1beta1.resources.UpdateRhelHostResponse:
type: object
properties: {}
tags:
- name: KesselInventoryHealthService
- name: KesselK8SClusterService
- name: KesselK8SPolicyIsPropagatedToK8SClusterService
- name: KesselK8SPolicyService
- name: KesselNotificationsIntegrationService
- name: KesselRhelHostService