Skip to content

Commit 7ccd951

Browse files
authored
Merge pull request #27020 from jboxman/ocp-apis-46
Update API reference docs
2 parents 24ad22b + cfc3445 commit 7ccd951

File tree

188 files changed

+15907
-4716
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+15907
-4716
lines changed

_topic_map.yml

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1808,6 +1808,8 @@ Topics:
18081808
File: dns-config-openshift-io-v1
18091809
- Name: 'FeatureGate [config.openshift.io/v1]'
18101810
File: featuregate-config-openshift-io-v1
1811+
- Name: 'HelmChartRepository [helm.openshift.io/v1beta1]'
1812+
File: helmchartrepository-helm-openshift-io-v1beta1
18111813
- Name: 'Image [config.openshift.io/v1]'
18121814
File: image-config-openshift-io-v1
18131815
- Name: 'Infrastructure [config.openshift.io/v1]'
@@ -1909,8 +1911,8 @@ Topics:
19091911
File: configmap-core-v1
19101912
- Name: 'ControllerRevision [apps/v1]'
19111913
File: controllerrevision-apps-v1
1912-
- Name: 'Event [events.k8s.io/v1beta1]'
1913-
File: event-events-k8s-io-v1beta1
1914+
- Name: 'Event [events.k8s.io/v1]'
1915+
File: event-events-k8s-io-v1
19141916
- Name: 'Event [core/v1]'
19151917
File: event-core-v1
19161918
- Name: 'Lease [coordination.k8s.io/v1]'
@@ -1926,6 +1928,8 @@ Topics:
19261928
File: alertmanager-monitoring-coreos-com-v1
19271929
- Name: 'PodMonitor [monitoring.coreos.com/v1]'
19281930
File: podmonitor-monitoring-coreos-com-v1
1931+
- Name: 'Probe [monitoring.coreos.com/v1]'
1932+
File: probe-monitoring-coreos-com-v1
19291933
- Name: 'Prometheus [monitoring.coreos.com/v1]'
19301934
File: prometheus-monitoring-coreos-com-v1
19311935
- Name: 'PrometheusRule [monitoring.coreos.com/v1]'
@@ -1949,10 +1953,12 @@ Topics:
19491953
File: egressnetworkpolicy-network-openshift-io-v1
19501954
- Name: 'HostSubnet [network.openshift.io/v1]'
19511955
File: hostsubnet-network-openshift-io-v1
1952-
- Name: 'Ingress [networking.k8s.io/v1beta1]'
1953-
File: ingress-networking-k8s-io-v1beta1
1954-
- Name: 'IngressClass [networking.k8s.io/v1beta1]'
1955-
File: ingressclass-networking-k8s-io-v1beta1
1956+
- Name: 'Ingress [networking.k8s.io/v1]'
1957+
File: ingress-networking-k8s-io-v1
1958+
- Name: 'IngressClass [networking.k8s.io/v1]'
1959+
File: ingressclass-networking-k8s-io-v1
1960+
- Name: 'IPPool [whereabouts.cni.cncf.io/v1alpha1]'
1961+
File: ippool-whereabouts-cni-cncf-io-v1alpha1
19561962
- Name: 'NetNamespace [network.openshift.io/v1]'
19571963
File: netnamespace-network-openshift-io-v1
19581964
- Name: 'NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]'
@@ -1996,6 +2002,10 @@ Topics:
19962002
File: operator-apis-index
19972003
- Name: 'Authentication [operator.openshift.io/v1]'
19982004
File: authentication-operator-openshift-io-v1
2005+
- Name: 'CloudCredential [operator.openshift.io/v1]'
2006+
File: cloudcredential-operator-openshift-io-v1
2007+
- Name: 'ClusterCSIDriver [operator.openshift.io/v1]'
2008+
File: clustercsidriver-operator-openshift-io-v1
19992009
- Name: 'Console [operator.openshift.io/v1]'
20002010
File: console-operator-openshift-io-v1
20012011
- Name: 'Config [operator.openshift.io/v1]'
@@ -2032,8 +2042,12 @@ Topics:
20322042
File: openshiftapiserver-operator-openshift-io-v1
20332043
- Name: 'OpenShiftControllerManager [operator.openshift.io/v1]'
20342044
File: openshiftcontrollermanager-operator-openshift-io-v1
2045+
- Name: 'OperatorPKI [network.operator.openshift.io/v1]'
2046+
File: operatorpki-network-operator-openshift-io-v1
20352047
- Name: 'ServiceCA [operator.openshift.io/v1]'
20362048
File: serviceca-operator-openshift-io-v1
2049+
- Name: 'Storage [operator.openshift.io/v1]'
2050+
File: storage-operator-openshift-io-v1
20372051
- Name: OperatorHub APIs
20382052
Dir: operatorhub_apis
20392053
Topics:
@@ -2047,8 +2061,6 @@ Topics:
20472061
File: installplan-operators-coreos-com-v1alpha1
20482062
- Name: 'OperatorGroup [operators.coreos.com/v1]'
20492063
File: operatorgroup-operators-coreos-com-v1
2050-
- Name: 'OperatorSource [operators.coreos.com/v1]'
2051-
File: operatorsource-operators-coreos-com-v1
20522064
- Name: 'PackageManifest [packages.operators.coreos.com/v1]'
20532065
File: packagemanifest-packages-operators-coreos-com-v1
20542066
- Name: 'Subscription [operators.coreos.com/v1alpha1]'
@@ -2069,6 +2081,15 @@ Topics:
20692081
File: project-project-openshift-io-v1
20702082
- Name: 'ProjectRequest [project.openshift.io/v1]'
20712083
File: projectrequest-project-openshift-io-v1
2084+
- Name: Provisioning APIs
2085+
Dir: provisioning_apis
2086+
Topics:
2087+
- Name: About Provisioning APIs
2088+
File: provisioning-apis-index
2089+
- Name: 'BareMetalHost [metal3.io/v1alpha1]'
2090+
File: baremetalhost-metal3-io-v1alpha1
2091+
- Name: 'Provisioning [metal3.io/v1alpha1]'
2092+
File: provisioning-metal3-io-v1alpha1
20722093
- Name: RBAC APIs
20732094
Dir: rbac_apis
20742095
Topics:
@@ -2106,19 +2127,23 @@ Topics:
21062127
File: appliedclusterresourcequota-quota-openshift-io-v1
21072128
- Name: 'ClusterResourceQuota [quota.openshift.io/v1]'
21082129
File: clusterresourcequota-quota-openshift-io-v1
2130+
- Name: 'FlowSchema [flowcontrol.apiserver.k8s.io/v1alpha1]'
2131+
File: flowschema-flowcontrol-apiserver-k8s-io-v1alpha1
21092132
- Name: 'LimitRange [core/v1]'
21102133
File: limitrange-core-v1
21112134
- Name: 'PriorityClass [scheduling.k8s.io/v1]'
21122135
File: priorityclass-scheduling-k8s-io-v1
2136+
- Name: 'PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1alpha1]'
2137+
File: prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1alpha1
21132138
- Name: 'ResourceQuota [core/v1]'
21142139
File: resourcequota-core-v1
21152140
- Name: Security APIs
21162141
Dir: security_apis
21172142
Topics:
21182143
- Name: About Security APIs
21192144
File: security-apis-index
2120-
- Name: 'CertificateSigningRequest [certificates.k8s.io/v1beta1]'
2121-
File: certificatesigningrequest-certificates-k8s-io-v1beta1
2145+
- Name: 'CertificateSigningRequest [certificates.k8s.io/v1]'
2146+
File: certificatesigningrequest-certificates-k8s-io-v1
21222147
- Name: 'CredentialsRequest [cloudcredential.openshift.io/v1]'
21232148
File: credentialsrequest-cloudcredential-openshift-io-v1
21242149
- Name: 'PodSecurityPolicyReview [security.openshift.io/v1]'
@@ -2148,6 +2173,10 @@ Topics:
21482173
File: persistentvolumeclaim-core-v1
21492174
- Name: 'StorageClass [storage.k8s.io/v1]'
21502175
File: storageclass-storage-k8s-io-v1
2176+
- Name: 'StorageState [migration.k8s.io/v1alpha1]'
2177+
File: storagestate-migration-k8s-io-v1alpha1
2178+
- Name: 'StorageVersionMigration [migration.k8s.io/v1alpha1]'
2179+
File: storageversionmigration-migration-k8s-io-v1alpha1
21512180
- Name: 'VolumeAttachment [storage.k8s.io/v1]'
21522181
File: volumeattachment-storage-k8s-io-v1
21532182
- Name: 'VolumeSnapshot [snapshot.storage.k8s.io/v1beta1]'

api-map.yaml

Lines changed: 74 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,11 @@
114114
version: v1
115115
plural: featuregates
116116
namespaced: false
117+
- kind: HelmChartRepository
118+
group: helm.openshift.io
119+
version: v1beta1
120+
plural: helmchartrepositories
121+
namespaced: false
117122
- kind: Image
118123
group: config.openshift.io
119124
version: v1
@@ -316,7 +321,7 @@
316321
namespaced: true
317322
- kind: Event
318323
group: events.k8s.io
319-
version: v1beta1
324+
version: v1
320325
plural: events
321326
namespaced: true
322327
- kind: Event
@@ -346,6 +351,11 @@
346351
version: v1
347352
plural: podmonitors
348353
namespaced: true
354+
- kind: Probe
355+
group: monitoring.coreos.com
356+
version: v1
357+
plural: probes
358+
namespaced: true
349359
- kind: Prometheus
350360
group: monitoring.coreos.com
351361
version: v1
@@ -395,14 +405,19 @@
395405
namespaced: false
396406
- kind: Ingress
397407
group: networking.k8s.io
398-
version: v1beta1
408+
version: v1
399409
plural: ingresses
400410
namespaced: true
401411
- kind: IngressClass
402412
group: networking.k8s.io
403-
version: v1beta1
413+
version: v1
404414
plural: ingressclasses
405415
namespaced: false
416+
- kind: IPPool
417+
group: whereabouts.cni.cncf.io
418+
version: v1alpha1
419+
plural: ippools
420+
namespaced: true
406421
- kind: NetNamespace
407422
group: network.openshift.io
408423
version: v1
@@ -479,6 +494,16 @@
479494
version: v1
480495
plural: authentications
481496
namespaced: false
497+
- kind: CloudCredential
498+
group: operator.openshift.io
499+
version: v1
500+
plural: cloudcredentials
501+
namespaced: false
502+
- kind: ClusterCSIDriver
503+
group: operator.openshift.io
504+
version: v1
505+
plural: clustercsidrivers
506+
namespaced: false
482507
- kind: Console
483508
group: operator.openshift.io
484509
version: v1
@@ -569,11 +594,21 @@
569594
version: v1
570595
plural: openshiftcontrollermanagers
571596
namespaced: false
597+
- kind: OperatorPKI
598+
group: network.operator.openshift.io
599+
version: v1
600+
plural: operatorpkis
601+
namespaced: true
572602
- kind: ServiceCA
573603
group: operator.openshift.io
574604
version: v1
575605
plural: servicecas
576606
namespaced: false
607+
- kind: Storage
608+
group: operator.openshift.io
609+
version: v1
610+
plural: storages
611+
namespaced: false
577612
- name: OperatorHub APIs
578613
resources:
579614
- kind: CatalogSource
@@ -596,11 +631,6 @@
596631
version: v1
597632
plural: operatorgroups
598633
namespaced: true
599-
- kind: OperatorSource
600-
group: operators.coreos.com
601-
version: v1
602-
plural: operatorsources
603-
namespaced: true
604634
- kind: PackageManifest
605635
group: packages.operators.coreos.com
606636
version: v1
@@ -636,6 +666,18 @@
636666
version: v1
637667
plural: projectrequests
638668
namespaced: false
669+
- name: Provisioning APIs
670+
resources:
671+
- kind: BareMetalHost
672+
group: metal3.io
673+
version: v1alpha1
674+
plural: baremetalhosts
675+
namespaced: true
676+
- kind: Provisioning
677+
group: metal3.io
678+
version: v1alpha1
679+
plural: provisionings
680+
namespaced: false
639681
- name: RBAC APIs
640682
resources:
641683
- kind: ClusterRoleBinding
@@ -697,6 +739,11 @@
697739
version: v1
698740
plural: clusterresourcequotas
699741
namespaced: false
742+
- kind: FlowSchema
743+
group: flowcontrol.apiserver.k8s.io
744+
version: v1alpha1
745+
plural: flowschemas
746+
namespaced: false
700747
- kind: LimitRange
701748
group: core
702749
version: v1
@@ -707,6 +754,11 @@
707754
version: v1
708755
plural: priorityclasses
709756
namespaced: false
757+
- kind: PriorityLevelConfiguration
758+
group: flowcontrol.apiserver.k8s.io
759+
version: v1alpha1
760+
plural: prioritylevelconfigurations
761+
namespaced: false
710762
- kind: ResourceQuota
711763
group: core
712764
version: v1
@@ -716,7 +768,7 @@
716768
resources:
717769
- kind: CertificateSigningRequest
718770
group: certificates.k8s.io
719-
version: v1beta1
771+
version: v1
720772
plural: certificatesigningrequests
721773
namespaced: false
722774
- kind: CredentialsRequest
@@ -781,6 +833,16 @@
781833
version: v1
782834
plural: storageclasses
783835
namespaced: false
836+
- kind: StorageState
837+
group: migration.k8s.io
838+
version: v1alpha1
839+
plural: storagestates
840+
namespaced: false
841+
- kind: StorageVersionMigration
842+
group: migration.k8s.io
843+
version: v1alpha1
844+
plural: storageversionmigrations
845+
namespaced: false
784846
- kind: VolumeAttachment
785847
group: storage.k8s.io
786848
version: v1
@@ -909,25 +971,8 @@
909971
namespaced: true
910972

911973
# No properties defined in OpenAPI spec
912-
# - kind: OperatorPKI
913-
# group: network.operator.openshift.io
914-
# version: v1
915-
# - kind: IPPool
974+
# - kind: OverlappingRangeIPReservation
916975
# group: whereabouts.cni.cncf.io
917976
# version: v1alpha1
918-
#- name: migration.k8s.io
919-
# resources:
920-
# - kind: StorageState
921-
# group: migration.k8s.io
922-
# version: v1alpha1
923-
# - kind: StorageVersionMigration
924-
# group: migration.k8s.io
925-
# version: v1alpha1
926-
#- name: metal3.io
927-
# resources:
928-
# - kind: BareMetalHost
929-
# group: metal3.io
930-
# version: v1alpha1
931-
# - kind: Provisioning
932-
# group: metal3.io
933-
# version: v1alpha1
977+
# plural: overlappingrangeipreservations
978+
# namespaced: true

rest_api/authorization_apis/authorization-apis-index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,15 @@ Type::
7373
== SelfSubjectAccessReview [authorization.k8s.io/v1]
7474

7575
Description::
76-
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
76+
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
7777

7878
Type::
7979
`object`
8080

8181
== SelfSubjectRulesReview [authorization.k8s.io/v1]
8282

8383
Description::
84-
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
84+
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
8585

8686
Type::
8787
`object`

rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88

99

1010
Description::
11-
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
11+
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
1212

1313
Type::
1414
`object`

0 commit comments

Comments
 (0)