@intentius/chant-lexicon-k8s 0.41.20 → 0.42.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (249) hide show
  1. package/dist/deep-observe-hooks.d.ts +8 -0
  2. package/dist/deep-observe-hooks.d.ts.map +1 -1
  3. package/dist/integrity.json +2 -2
  4. package/dist/manifest.json +1 -1
  5. package/dist/okf/index.md +250 -0
  6. package/dist/okf/rules/ARGO001.md +16 -0
  7. package/dist/okf/rules/ARGO002.md +16 -0
  8. package/dist/okf/rules/ARGO003.md +15 -0
  9. package/dist/okf/rules/ARGO004.md +17 -0
  10. package/dist/okf/rules/ARGO005.md +15 -0
  11. package/dist/okf/rules/WK8001.md +16 -0
  12. package/dist/okf/rules/WK8002.md +20 -0
  13. package/dist/okf/rules/WK8003.md +19 -0
  14. package/dist/okf/rules/WK8005.md +11 -0
  15. package/dist/okf/rules/WK8006.md +11 -0
  16. package/dist/okf/rules/WK8041.md +11 -0
  17. package/dist/okf/rules/WK8042.md +11 -0
  18. package/dist/okf/rules/WK8101.md +11 -0
  19. package/dist/okf/rules/WK8102.md +11 -0
  20. package/dist/okf/rules/WK8103.md +11 -0
  21. package/dist/okf/rules/WK8104.md +15 -0
  22. package/dist/okf/rules/WK8105.md +11 -0
  23. package/dist/okf/rules/WK8201.md +11 -0
  24. package/dist/okf/rules/WK8202.md +11 -0
  25. package/dist/okf/rules/WK8203.md +11 -0
  26. package/dist/okf/rules/WK8204.md +11 -0
  27. package/dist/okf/rules/WK8205.md +11 -0
  28. package/dist/okf/rules/WK8207.md +11 -0
  29. package/dist/okf/rules/WK8208.md +11 -0
  30. package/dist/okf/rules/WK8209.md +11 -0
  31. package/dist/okf/rules/WK8301.md +16 -0
  32. package/dist/okf/rules/WK8302.md +11 -0
  33. package/dist/okf/rules/WK8303.md +15 -0
  34. package/dist/okf/rules/WK8304.md +15 -0
  35. package/dist/okf/rules/WK8305.md +15 -0
  36. package/dist/okf/rules/WK8306.md +11 -0
  37. package/dist/okf/rules/WK8401.md +15 -0
  38. package/dist/okf/rules/WK8402.md +15 -0
  39. package/dist/okf/rules/WK8403.md +15 -0
  40. package/dist/okf/types/APIGroup.md +16 -0
  41. package/dist/okf/types/APIGroupList.md +13 -0
  42. package/dist/okf/types/APIResourceList.md +14 -0
  43. package/dist/okf/types/APIService.md +14 -0
  44. package/dist/okf/types/APIServiceList.md +14 -0
  45. package/dist/okf/types/APIVersions.md +14 -0
  46. package/dist/okf/types/Alert.md +14 -0
  47. package/dist/okf/types/AppProject.md +19 -0
  48. package/dist/okf/types/Application.md +23 -0
  49. package/dist/okf/types/ApplicationSet.md +18 -0
  50. package/dist/okf/types/Backup.md +14 -0
  51. package/dist/okf/types/BatchJob.md +14 -0
  52. package/dist/okf/types/Binding.md +14 -0
  53. package/dist/okf/types/Bucket.md +14 -0
  54. package/dist/okf/types/CM.md +16 -0
  55. package/dist/okf/types/CSIDriver.md +14 -0
  56. package/dist/okf/types/CSIDriverList.md +14 -0
  57. package/dist/okf/types/CSINode.md +14 -0
  58. package/dist/okf/types/CSINodeList.md +14 -0
  59. package/dist/okf/types/CSIStorageCapacity.md +17 -0
  60. package/dist/okf/types/CSIStorageCapacityList.md +14 -0
  61. package/dist/okf/types/Certificate.md +18 -0
  62. package/dist/okf/types/CertificateRequest.md +14 -0
  63. package/dist/okf/types/CertificateSigningRequest.md +14 -0
  64. package/dist/okf/types/CertificateSigningRequestList.md +14 -0
  65. package/dist/okf/types/Challenge.md +14 -0
  66. package/dist/okf/types/Cluster.md +14 -0
  67. package/dist/okf/types/ClusterIssuer.md +14 -0
  68. package/dist/okf/types/ClusterRole.md +15 -0
  69. package/dist/okf/types/ClusterRoleBinding.md +15 -0
  70. package/dist/okf/types/ClusterRoleBindingList.md +14 -0
  71. package/dist/okf/types/ClusterRoleList.md +14 -0
  72. package/dist/okf/types/ClusterTrustBundle.md +14 -0
  73. package/dist/okf/types/ClusterTrustBundleList.md +14 -0
  74. package/dist/okf/types/ComponentStatus.md +14 -0
  75. package/dist/okf/types/ComponentStatusList.md +14 -0
  76. package/dist/okf/types/ConfigMapList.md +14 -0
  77. package/dist/okf/types/ControllerRevision.md +15 -0
  78. package/dist/okf/types/ControllerRevisionList.md +14 -0
  79. package/dist/okf/types/CoreEventList.md +14 -0
  80. package/dist/okf/types/CrdbCluster.md +14 -0
  81. package/dist/okf/types/CronJob.md +20 -0
  82. package/dist/okf/types/CronJobList.md +14 -0
  83. package/dist/okf/types/CustomResourceDefinition.md +14 -0
  84. package/dist/okf/types/CustomResourceDefinitionList.md +14 -0
  85. package/dist/okf/types/DaemonSet.md +19 -0
  86. package/dist/okf/types/DaemonSetList.md +14 -0
  87. package/dist/okf/types/DeleteOptions.md +18 -0
  88. package/dist/okf/types/Deploy.md +14 -0
  89. package/dist/okf/types/DeploymentList.md +14 -0
  90. package/dist/okf/types/DeviceClass.md +14 -0
  91. package/dist/okf/types/DeviceClassList.md +14 -0
  92. package/dist/okf/types/DeviceTaintRule.md +14 -0
  93. package/dist/okf/types/DeviceTaintRuleList.md +14 -0
  94. package/dist/okf/types/EndpointSlice.md +16 -0
  95. package/dist/okf/types/EndpointSliceList.md +14 -0
  96. package/dist/okf/types/Endpoints.md +14 -0
  97. package/dist/okf/types/EndpointsList.md +14 -0
  98. package/dist/okf/types/Event.md +27 -0
  99. package/dist/okf/types/EventsEvent.md +27 -0
  100. package/dist/okf/types/EventsEventList.md +14 -0
  101. package/dist/okf/types/Eviction.md +14 -0
  102. package/dist/okf/types/FlowSchema.md +14 -0
  103. package/dist/okf/types/FlowSchemaList.md +14 -0
  104. package/dist/okf/types/FluxInstance.md +14 -0
  105. package/dist/okf/types/FluxReport.md +14 -0
  106. package/dist/okf/types/GRPCRoute.md +14 -0
  107. package/dist/okf/types/Gateway.md +14 -0
  108. package/dist/okf/types/GatewayClass.md +14 -0
  109. package/dist/okf/types/GitRepository.md +14 -0
  110. package/dist/okf/types/HTTPRoute.md +14 -0
  111. package/dist/okf/types/HelmChart.md +14 -0
  112. package/dist/okf/types/HelmRelease.md +14 -0
  113. package/dist/okf/types/HelmRepository.md +14 -0
  114. package/dist/okf/types/HorizontalPodAutoscaler.md +14 -0
  115. package/dist/okf/types/HorizontalPodAutoscalerList.md +14 -0
  116. package/dist/okf/types/IPAddress.md +14 -0
  117. package/dist/okf/types/IPAddressList.md +14 -0
  118. package/dist/okf/types/ImagePolicy.md +14 -0
  119. package/dist/okf/types/ImageRepository.md +14 -0
  120. package/dist/okf/types/ImageUpdateAutomation.md +14 -0
  121. package/dist/okf/types/InfisicalDynamicSecret.md +14 -0
  122. package/dist/okf/types/InfisicalPushSecret.md +14 -0
  123. package/dist/okf/types/InfisicalSecret.md +14 -0
  124. package/dist/okf/types/Ing.md +14 -0
  125. package/dist/okf/types/IngressClass.md +14 -0
  126. package/dist/okf/types/IngressClassList.md +14 -0
  127. package/dist/okf/types/IngressList.md +14 -0
  128. package/dist/okf/types/IngressRoute.md +14 -0
  129. package/dist/okf/types/IngressRouteTCP.md +14 -0
  130. package/dist/okf/types/IngressRouteUDP.md +14 -0
  131. package/dist/okf/types/Issuer.md +14 -0
  132. package/dist/okf/types/JobList.md +14 -0
  133. package/dist/okf/types/Kustomization.md +14 -0
  134. package/dist/okf/types/Lease.md +14 -0
  135. package/dist/okf/types/LeaseCandidate.md +14 -0
  136. package/dist/okf/types/LeaseCandidateList.md +14 -0
  137. package/dist/okf/types/LeaseList.md +14 -0
  138. package/dist/okf/types/LimitRange.md +14 -0
  139. package/dist/okf/types/LimitRangeList.md +14 -0
  140. package/dist/okf/types/LocalSubjectAccessReview.md +14 -0
  141. package/dist/okf/types/MicroVM.md +14 -0
  142. package/dist/okf/types/MicroVMClass.md +14 -0
  143. package/dist/okf/types/MicroVMImage.md +14 -0
  144. package/dist/okf/types/MicroVMNetwork.md +14 -0
  145. package/dist/okf/types/MicroVMReplicaSet.md +14 -0
  146. package/dist/okf/types/Middleware.md +14 -0
  147. package/dist/okf/types/MiddlewareTCP.md +14 -0
  148. package/dist/okf/types/MutatingAdmissionPolicy.md +14 -0
  149. package/dist/okf/types/MutatingAdmissionPolicyBinding.md +14 -0
  150. package/dist/okf/types/MutatingAdmissionPolicyBindingList.md +14 -0
  151. package/dist/okf/types/MutatingAdmissionPolicyList.md +14 -0
  152. package/dist/okf/types/MutatingWebhookConfiguration.md +14 -0
  153. package/dist/okf/types/MutatingWebhookConfigurationList.md +14 -0
  154. package/dist/okf/types/Namespace.md +18 -0
  155. package/dist/okf/types/NamespaceList.md +14 -0
  156. package/dist/okf/types/NetPol.md +14 -0
  157. package/dist/okf/types/NetworkPolicyList.md +14 -0
  158. package/dist/okf/types/Node.md +21 -0
  159. package/dist/okf/types/NodeList.md +14 -0
  160. package/dist/okf/types/OCIRepository.md +14 -0
  161. package/dist/okf/types/ObjectStore.md +14 -0
  162. package/dist/okf/types/Order.md +14 -0
  163. package/dist/okf/types/PDB.md +18 -0
  164. package/dist/okf/types/PersistentVolume.md +14 -0
  165. package/dist/okf/types/PersistentVolumeClaim.md +14 -0
  166. package/dist/okf/types/PersistentVolumeClaimList.md +14 -0
  167. package/dist/okf/types/PersistentVolumeList.md +14 -0
  168. package/dist/okf/types/Pod.md +18 -0
  169. package/dist/okf/types/PodCertificateRequest.md +14 -0
  170. package/dist/okf/types/PodCertificateRequestList.md +14 -0
  171. package/dist/okf/types/PodDisruptionBudgetList.md +14 -0
  172. package/dist/okf/types/PodList.md +14 -0
  173. package/dist/okf/types/PodTemplate.md +14 -0
  174. package/dist/okf/types/PodTemplateList.md +14 -0
  175. package/dist/okf/types/Pooler.md +14 -0
  176. package/dist/okf/types/PriorityClass.md +17 -0
  177. package/dist/okf/types/PriorityClassList.md +14 -0
  178. package/dist/okf/types/PriorityLevelConfiguration.md +14 -0
  179. package/dist/okf/types/PriorityLevelConfigurationList.md +14 -0
  180. package/dist/okf/types/PrometheusRule.md +14 -0
  181. package/dist/okf/types/Provider.md +14 -0
  182. package/dist/okf/types/RayCluster.md +20 -0
  183. package/dist/okf/types/RayJob.md +14 -0
  184. package/dist/okf/types/RayService.md +14 -0
  185. package/dist/okf/types/Receiver.md +14 -0
  186. package/dist/okf/types/ReferenceGrant.md +14 -0
  187. package/dist/okf/types/ReplicaSet.md +19 -0
  188. package/dist/okf/types/ReplicaSetList.md +14 -0
  189. package/dist/okf/types/ReplicationController.md +14 -0
  190. package/dist/okf/types/ReplicationControllerList.md +14 -0
  191. package/dist/okf/types/ResourceClaim.md +14 -0
  192. package/dist/okf/types/ResourceClaimList.md +14 -0
  193. package/dist/okf/types/ResourceClaimTemplate.md +14 -0
  194. package/dist/okf/types/ResourceClaimTemplateList.md +14 -0
  195. package/dist/okf/types/ResourceQuota.md +14 -0
  196. package/dist/okf/types/ResourceQuotaList.md +14 -0
  197. package/dist/okf/types/ResourceSet.md +14 -0
  198. package/dist/okf/types/ResourceSetInputProvider.md +14 -0
  199. package/dist/okf/types/ResourceSlice.md +14 -0
  200. package/dist/okf/types/ResourceSliceList.md +14 -0
  201. package/dist/okf/types/Role.md +14 -0
  202. package/dist/okf/types/RoleBinding.md +15 -0
  203. package/dist/okf/types/RoleBindingList.md +14 -0
  204. package/dist/okf/types/RoleList.md +14 -0
  205. package/dist/okf/types/RuntimeClass.md +16 -0
  206. package/dist/okf/types/RuntimeClassList.md +14 -0
  207. package/dist/okf/types/SA.md +16 -0
  208. package/dist/okf/types/Scale.md +14 -0
  209. package/dist/okf/types/ScheduledBackup.md +14 -0
  210. package/dist/okf/types/Sec.md +17 -0
  211. package/dist/okf/types/SecretList.md +14 -0
  212. package/dist/okf/types/SelfSubjectAccessReview.md +14 -0
  213. package/dist/okf/types/SelfSubjectReview.md +13 -0
  214. package/dist/okf/types/SelfSubjectRulesReview.md +14 -0
  215. package/dist/okf/types/ServersTransport.md +14 -0
  216. package/dist/okf/types/ServersTransportTCP.md +14 -0
  217. package/dist/okf/types/Service.md +20 -0
  218. package/dist/okf/types/ServiceAccountList.md +14 -0
  219. package/dist/okf/types/ServiceCIDR.md +14 -0
  220. package/dist/okf/types/ServiceCIDRList.md +14 -0
  221. package/dist/okf/types/ServiceList.md +14 -0
  222. package/dist/okf/types/ServiceMonitor.md +14 -0
  223. package/dist/okf/types/StatefulSet.md +19 -0
  224. package/dist/okf/types/StatefulSetList.md +14 -0
  225. package/dist/okf/types/Status.md +17 -0
  226. package/dist/okf/types/StorageClass.md +20 -0
  227. package/dist/okf/types/StorageClassList.md +14 -0
  228. package/dist/okf/types/StorageVersionMigration.md +14 -0
  229. package/dist/okf/types/StorageVersionMigrationList.md +14 -0
  230. package/dist/okf/types/SubjectAccessReview.md +14 -0
  231. package/dist/okf/types/TLSOption.md +14 -0
  232. package/dist/okf/types/TLSStore.md +14 -0
  233. package/dist/okf/types/TokenRequest.md +14 -0
  234. package/dist/okf/types/TokenReview.md +14 -0
  235. package/dist/okf/types/TraefikService.md +14 -0
  236. package/dist/okf/types/ValidatingAdmissionPolicy.md +14 -0
  237. package/dist/okf/types/ValidatingAdmissionPolicyBinding.md +14 -0
  238. package/dist/okf/types/ValidatingAdmissionPolicyBindingList.md +14 -0
  239. package/dist/okf/types/ValidatingAdmissionPolicyList.md +14 -0
  240. package/dist/okf/types/ValidatingWebhookConfiguration.md +14 -0
  241. package/dist/okf/types/ValidatingWebhookConfigurationList.md +14 -0
  242. package/dist/okf/types/VolumeAttachment.md +14 -0
  243. package/dist/okf/types/VolumeAttachmentList.md +14 -0
  244. package/dist/okf/types/VolumeAttributesClass.md +15 -0
  245. package/dist/okf/types/VolumeAttributesClassList.md +14 -0
  246. package/dist/okf/types/WatchEvent.md +14 -0
  247. package/package.json +2 -2
  248. package/src/deep-observe-hooks.ts +60 -0
  249. package/src/deep-observe.test.ts +114 -0
@@ -0,0 +1,11 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8208
4
+ description: No hostPID — sharing host PID namespace allows visibility into all host processes
5
+ id: WK8208
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ No hostPID — sharing host PID namespace allows visibility into all host processes
@@ -0,0 +1,11 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8209
4
+ description: No hostIPC — sharing host IPC namespace can expose shared memory segments
5
+ id: WK8209
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ No hostIPC — sharing host IPC namespace can expose shared memory segments
@@ -0,0 +1,16 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8301
4
+ description: Probes required — containers should have livenessProbe and readinessProbe
5
+ id: WK8301
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ Probes required — containers should have livenessProbe and readinessProbe
12
+
13
+ ## Applies to
14
+
15
+ - [CronJob](/types/CronJob.md)
16
+ - [Service](/types/Service.md)
@@ -0,0 +1,11 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8302
4
+ description: Replicas >= 2 recommended — single-replica Deployments have no high availability
5
+ id: WK8302
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ Replicas >= 2 recommended — single-replica Deployments have no high availability
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8303
4
+ description: PDB recommended for HA Deployments — ensures availability during voluntary disruptions
5
+ id: WK8303
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ PDB recommended for HA Deployments — ensures availability during voluntary disruptions
12
+
13
+ ## Applies to
14
+
15
+ - [PDB](/types/PDB.md)
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8304
4
+ description: SSL redirect without certificate — ssl-redirect annotation requires a valid certificate-arn and HTTPS listen-ports
5
+ id: WK8304
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ SSL redirect without certificate — ssl-redirect annotation requires a valid certificate-arn and HTTPS listen-ports
12
+
13
+ ## Applies to
14
+
15
+ - [Certificate](/types/Certificate.md)
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8305
4
+ description: Ingress port not matching Service — backend port must match a declared Service port
5
+ id: WK8305
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ Ingress port not matching Service — backend port must match a declared Service port
12
+
13
+ ## Applies to
14
+
15
+ - [Service](/types/Service.md)
@@ -0,0 +1,11 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8306
4
+ description: Container command starts with flag — first element should be a binary, not a flag
5
+ id: WK8306
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ Container command starts with flag — first element should be a binary, not a flag
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8401
4
+ description: shmSize must not exceed the container memory limit — pod will not schedule if it does
5
+ id: WK8401
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ shmSize must not exceed the container memory limit — pod will not schedule if it does
12
+
13
+ ## Applies to
14
+
15
+ - [RayCluster](/types/RayCluster.md)
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8402
4
+ description: RayCluster should set spec.rayVersion so KubeRay selects the correct autoscaler image
5
+ id: WK8402
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ RayCluster should set spec.rayVersion so KubeRay selects the correct autoscaler image
12
+
13
+ ## Applies to
14
+
15
+ - [RayCluster](/types/RayCluster.md)
@@ -0,0 +1,15 @@
1
+ ---
2
+ type: post-synth-check
3
+ title: WK8403
4
+ description: spec.rayVersion should match the Ray version in the head container image tag
5
+ id: WK8403
6
+ severity: error
7
+ category: post-synth
8
+ lexicon: k8s
9
+ docs: https://intentius.io/chant/lexicons/k8s/rules/
10
+ ---
11
+ spec.rayVersion should match the Ray version in the head container image tag
12
+
13
+ ## Applies to
14
+
15
+ - [RayCluster](/types/RayCluster.md)
@@ -0,0 +1,16 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIGroup
4
+ description: k8s resource type K8s::Core::APIGroup
5
+ name: APIGroup
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::APIGroup
8
+ ---
9
+ `K8s::Core::APIGroup`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `name` (`string`, required): name is the name of the group.
14
+ - `versions` (`Record<string, unknown>[]`, required): versions are the versions supported in this group.
15
+ - `preferredVersion` (`Record<string, unknown>`, optional): preferredVersion is the version preferred by the API server, which probably is the storage version.
16
+ - `serverAddressByClientCIDRs` (`Record<string, unknown>[]`, optional): a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
@@ -0,0 +1,13 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIGroupList
4
+ description: k8s resource type K8s::Core::APIGroupList
5
+ name: APIGroupList
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::APIGroupList
8
+ ---
9
+ `K8s::Core::APIGroupList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `groups` (`Record<string, unknown>[]`, required): groups is a list of APIGroup.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIResourceList
4
+ description: k8s resource type K8s::Core::APIResourceList
5
+ name: APIResourceList
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::APIResourceList
8
+ ---
9
+ `K8s::Core::APIResourceList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `groupVersion` (`string`, required): groupVersion is the group and version this APIResourceList is for.
14
+ - `resources` (`Record<string, unknown>[]`, required): resources contains the name of the resources and if they are namespaced.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIService
4
+ description: k8s resource type K8s::Apiregistration::APIService
5
+ name: APIService
6
+ lexicon: k8s
7
+ resource_type: K8s::Apiregistration::APIService
8
+ ---
9
+ `K8s::Apiregistration::APIService`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
14
+ - `spec` (`Record<string, unknown>`, optional): Spec contains information for locating and communicating with a server
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIServiceList
4
+ description: k8s resource type K8s::Apiregistration::APIServiceList
5
+ name: APIServiceList
6
+ lexicon: k8s
7
+ resource_type: K8s::Apiregistration::APIServiceList
8
+ ---
9
+ `K8s::Apiregistration::APIServiceList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `items` (`Record<string, unknown>[]`, required): Items is the list of APIService
14
+ - `metadata` (`Record<string, unknown>`, optional): Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: APIVersions
4
+ description: k8s resource type K8s::Core::APIVersions
5
+ name: APIVersions
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::APIVersions
8
+ ---
9
+ `K8s::Core::APIVersions`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `serverAddressByClientCIDRs` (`Record<string, unknown>[]`, required): a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
14
+ - `versions` (`string[]`, required): versions are the api versions that are available.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Alert
4
+ description: k8s resource type K8s::Flux::Alert
5
+ name: Alert
6
+ lexicon: k8s
7
+ resource_type: K8s::Flux::Alert
8
+ ---
9
+ `K8s::Flux::Alert`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
14
+ - `spec` (`Record<string, unknown>`, optional): AlertSpec defines an alerting rule for events involving a list of objects.
@@ -0,0 +1,19 @@
1
+ ---
2
+ type: resource-type
3
+ title: AppProject
4
+ description: k8s resource type K8s::Argo::AppProject
5
+ name: AppProject
6
+ lexicon: k8s
7
+ resource_type: K8s::Argo::AppProject
8
+ ---
9
+ `K8s::Argo::AppProject`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): AppProjectSpec is the specification of an AppProject
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
15
+
16
+ ## Governed by
17
+
18
+ - [ARGO002](/rules/ARGO002.md): Application.spec.project must reference a declared AppProject (or the built-in default)
19
+ - [ARGO004](/rules/ARGO004.md): ApplicationSet template must scope to a single AppProject
@@ -0,0 +1,23 @@
1
+ ---
2
+ type: resource-type
3
+ title: Application
4
+ description: k8s resource type K8s::Argo::Application
5
+ name: Application
6
+ lexicon: k8s
7
+ resource_type: K8s::Argo::Application
8
+ ---
9
+ `K8s::Argo::Application`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
15
+ - `operation` (`Record<string, unknown>`, optional): Operation contains information about a requested or running operation
16
+
17
+ ## Governed by
18
+
19
+ - [ARGO001](/rules/ARGO001.md): Production Application must not enable automated prune
20
+ - [ARGO002](/rules/ARGO002.md): Application.spec.project must reference a declared AppProject (or the built-in default)
21
+ - [ARGO003](/rules/ARGO003.md): Application.spec.destination must reference a registered cluster or the in-cluster target
22
+ - [ARGO004](/rules/ARGO004.md): ApplicationSet template must scope to a single AppProject
23
+ - [ARGO005](/rules/ARGO005.md): Application source.path should resolve to an existing directory under the build root
@@ -0,0 +1,18 @@
1
+ ---
2
+ type: resource-type
3
+ title: ApplicationSet
4
+ description: k8s resource type K8s::Argo::ApplicationSet
5
+ name: ApplicationSet
6
+ lexicon: k8s
7
+ resource_type: K8s::Argo::ApplicationSet
8
+ ---
9
+ `K8s::Argo::ApplicationSet`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required)
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
15
+
16
+ ## Governed by
17
+
18
+ - [ARGO004](/rules/ARGO004.md): ApplicationSet template must scope to a single AppProject
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Backup
4
+ description: k8s resource type K8s::Cnpg::Backup
5
+ name: Backup
6
+ lexicon: k8s
7
+ resource_type: K8s::Cnpg::Backup
8
+ ---
9
+ `K8s::Cnpg::Backup`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): Specification of the desired behavior of the backup. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: BatchJob
4
+ description: k8s resource type K8s::Batch::Job
5
+ name: BatchJob
6
+ lexicon: k8s
7
+ resource_type: K8s::Batch::Job
8
+ ---
9
+ `K8s::Batch::Job`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
14
+ - `spec` (`Record<string, unknown>`, optional): Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Binding
4
+ description: k8s resource type K8s::Core::Binding
5
+ name: Binding
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::Binding
8
+ ---
9
+ `K8s::Core::Binding`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `target` (`ObjectReference`, required): The target object that you want to bind to the standard object.
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Bucket
4
+ description: k8s resource type K8s::Flux::Bucket
5
+ name: Bucket
6
+ lexicon: k8s
7
+ resource_type: K8s::Flux::Bucket
8
+ ---
9
+ `K8s::Flux::Bucket`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
14
+ - `spec` (`Record<string, unknown>`, optional): BucketSpec specifies the required configuration to produce an Artifact for an object storage bucket.
@@ -0,0 +1,16 @@
1
+ ---
2
+ type: resource-type
3
+ title: CM
4
+ description: k8s resource type K8s::Core::ConfigMap
5
+ name: CM
6
+ lexicon: k8s
7
+ resource_type: K8s::Core::ConfigMap
8
+ ---
9
+ `K8s::Core::ConfigMap`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `binaryData` (`Record<string, string>`, optional): BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
14
+ - `data` (`Record<string, string>`, optional): Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
15
+ - `immutable` (`boolean`, optional): Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
16
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSIDriver
4
+ description: k8s resource type K8s::Storage::CSIDriver
5
+ name: CSIDriver
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSIDriver
8
+ ---
9
+ `K8s::Storage::CSIDriver`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): spec represents the specification of the CSI Driver.
14
+ - `metadata` (`ObjectMeta`, optional): Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSIDriverList
4
+ description: k8s resource type K8s::Storage::CSIDriverList
5
+ name: CSIDriverList
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSIDriverList
8
+ ---
9
+ `K8s::Storage::CSIDriverList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `items` (`Record<string, unknown>[]`, required): items is the list of CSIDriver
14
+ - `metadata` (`Record<string, unknown>`, optional): Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSINode
4
+ description: k8s resource type K8s::Storage::CSINode
5
+ name: CSINode
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSINode
8
+ ---
9
+ `K8s::Storage::CSINode`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): spec is the specification of CSINode
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. metadata.name must be the Kubernetes node name.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSINodeList
4
+ description: k8s resource type K8s::Storage::CSINodeList
5
+ name: CSINodeList
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSINodeList
8
+ ---
9
+ `K8s::Storage::CSINodeList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `items` (`Record<string, unknown>[]`, required): items is the list of CSINode
14
+ - `metadata` (`Record<string, unknown>`, optional): Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,17 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSIStorageCapacity
4
+ description: k8s resource type K8s::Storage::CSIStorageCapacity
5
+ name: CSIStorageCapacity
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSIStorageCapacity
8
+ ---
9
+ `K8s::Storage::CSIStorageCapacity`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `storageClassName` (`string`, required): storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
14
+ - `capacity` (`string`, optional): capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.
15
+ - `maximumVolumeSize` (`string`, optional): maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
16
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
17
+ - `nodeTopology` (`LabelSelector`, optional): nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CSIStorageCapacityList
4
+ description: k8s resource type K8s::Storage::CSIStorageCapacityList
5
+ name: CSIStorageCapacityList
6
+ lexicon: k8s
7
+ resource_type: K8s::Storage::CSIStorageCapacityList
8
+ ---
9
+ `K8s::Storage::CSIStorageCapacityList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `items` (`Record<string, unknown>[]`, required): items is the list of CSIStorageCapacity objects.
14
+ - `metadata` (`Record<string, unknown>`, optional): Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@@ -0,0 +1,18 @@
1
+ ---
2
+ type: resource-type
3
+ title: Certificate
4
+ description: k8s resource type K8s::CertManager::Certificate
5
+ name: Certificate
6
+ lexicon: k8s
7
+ resource_type: K8s::CertManager::Certificate
8
+ ---
9
+ `K8s::CertManager::Certificate`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
14
+ - `spec` (`Record<string, unknown>`, optional): Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
15
+
16
+ ## Governed by
17
+
18
+ - [WK8304](/rules/WK8304.md): SSL redirect without certificate — ssl-redirect annotation requires a valid certificate-arn and HTTPS listen-ports
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CertificateRequest
4
+ description: k8s resource type K8s::CertManager::CertificateRequest
5
+ name: CertificateRequest
6
+ lexicon: k8s
7
+ resource_type: K8s::CertManager::CertificateRequest
8
+ ---
9
+ `K8s::CertManager::CertificateRequest`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
14
+ - `spec` (`Record<string, unknown>`, optional): Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CertificateSigningRequest
4
+ description: k8s resource type K8s::Certificates::CertificateSigningRequest
5
+ name: CertificateSigningRequest
6
+ lexicon: k8s
7
+ resource_type: K8s::Certificates::CertificateSigningRequest
8
+ ---
9
+ `K8s::Certificates::CertificateSigningRequest`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): spec contains the certificate request, and is immutable after creation. Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.
14
+ - `metadata` (`ObjectMeta`, optional)
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: CertificateSigningRequestList
4
+ description: k8s resource type K8s::Certificates::CertificateSigningRequestList
5
+ name: CertificateSigningRequestList
6
+ lexicon: k8s
7
+ resource_type: K8s::Certificates::CertificateSigningRequestList
8
+ ---
9
+ `K8s::Certificates::CertificateSigningRequestList`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `items` (`Record<string, unknown>[]`, required): items is a collection of CertificateSigningRequest objects
14
+ - `metadata` (`Record<string, unknown>`, optional)
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Challenge
4
+ description: k8s resource type K8s::Acme::Challenge
5
+ name: Challenge
6
+ lexicon: k8s
7
+ resource_type: K8s::Acme::Challenge
8
+ ---
9
+ `K8s::Acme::Challenge`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required)
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: Cluster
4
+ description: k8s resource type K8s::Cnpg::Cluster
5
+ name: Cluster
6
+ lexicon: k8s
7
+ resource_type: K8s::Cnpg::Cluster
8
+ ---
9
+ `K8s::Cnpg::Cluster`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): Specification of the desired behavior of the cluster. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.
@@ -0,0 +1,14 @@
1
+ ---
2
+ type: resource-type
3
+ title: ClusterIssuer
4
+ description: k8s resource type K8s::CertManager::ClusterIssuer
5
+ name: ClusterIssuer
6
+ lexicon: k8s
7
+ resource_type: K8s::CertManager::ClusterIssuer
8
+ ---
9
+ `K8s::CertManager::ClusterIssuer`, a resource type of the k8s lexicon.
10
+
11
+ ## Properties
12
+
13
+ - `spec` (`Record<string, unknown>`, required): Desired state of the ClusterIssuer resource.
14
+ - `metadata` (`ObjectMeta`, optional): Standard object's metadata.