1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/api-config.yaml
Jason Boxman 7852c2d022 Use v2 config for APIs
This introduces API support levels and an output dir.
2021-02-07 22:13:19 +00:00

1055 lines
25 KiB
YAML

version: 2
outputDir: rest_api
apisToHide: []
apiSupportLevels:
- apiGroup: openshift\.io$
supportLevels:
- apiVersion: v\d+
level: 1
- apiVersion: v\d+beta\d+
level: 2
- apiVersion: v\d+alpha\d+
level: 4
- apiGroup: ^\w+$
supportLevels:
- apiVersion: v\d+
level: 1
- apiVersion: v\d+beta\d+
level: 2
- apiGroup: k8s\.io$
supportLevels:
- apiVersion: v\d+
level: 1
- apiVersion: v\d+beta\d+
level: 2
- apiGroup: monitoring\.coreos\.com$
supportLevels:
- apiVersion: v\d+
level: 1
- apiGroup: operators\.coreos\.com$
supportLevels:
- apiVersion: v\d+
level: 1
- apiVersion: v\d+alpha\d+
level: 3
- apiGroup: metal3\.io$
supportLevels:
- apiVersion: v\d+alpha\d+
level: 4
packageMap: {} # replace regex
apiMap:
- name: Authorization APIs
resources:
- kind: LocalResourceAccessReview
group: authorization.openshift.io
version: v1
plural: localresourceaccessreviews
namespaced: true
- kind: LocalSubjectAccessReview
group: authorization.openshift.io
version: v1
plural: localsubjectaccessreviews
namespaced: true
- kind: ResourceAccessReview
group: authorization.openshift.io
version: v1
plural: resourceaccessreviews
namespaced: false
- kind: SelfSubjectRulesReview
group: authorization.openshift.io
version: v1
plural: selfsubjectrulesreviews
namespaced: true
- kind: SubjectAccessReview
group: authorization.openshift.io
version: v1
plural: subjectaccessreviews
namespaced: false
- kind: SubjectRulesReview
group: authorization.openshift.io
version: v1
plural: subjectrulesreviews
namespaced: true
- kind: TokenReview
group: authentication.k8s.io
version: v1
plural: tokenreviews
namespaced: false
- kind: LocalSubjectAccessReview
group: authorization.k8s.io
version: v1
plural: localsubjectaccessreviews
namespaced: true
- kind: SelfSubjectAccessReview
group: authorization.k8s.io
version: v1
plural: selfsubjectaccessreviews
namespaced: false
- kind: SelfSubjectRulesReview
group: authorization.k8s.io
version: v1
plural: selfsubjectrulesreviews
namespaced: false
- kind: SubjectAccessReview
group: authorization.k8s.io
version: v1
plural: subjectaccessreviews
namespaced: false
- name: Autoscale APIs
resources:
- kind: ClusterAutoscaler
group: autoscaling.openshift.io
version: v1
plural: clusterautoscalers
namespaced: false
- kind: MachineAutoscaler
group: autoscaling.openshift.io
version: v1beta1
plural: machineautoscalers
namespaced: true
- kind: HorizontalPodAutoscaler
group: autoscaling
version: v1
plural: horizontalpodautoscalers
namespaced: true
- name: Config APIs
resources:
- kind: APIServer
group: config.openshift.io
version: v1
plural: apiservers
namespaced: false
- kind: Authentication
group: config.openshift.io
version: v1
plural: authentications
namespaced: false
- kind: Build
group: config.openshift.io
version: v1
plural: builds
namespaced: false
- kind: ClusterOperator
group: config.openshift.io
version: v1
plural: clusteroperators
namespaced: false
- kind: ClusterVersion
group: config.openshift.io
version: v1
plural: clusterversions
namespaced: false
- kind: Console
group: config.openshift.io
version: v1
plural: consoles
namespaced: false
- kind: DNS
group: config.openshift.io
version: v1
plural: dnses
namespaced: false
- kind: FeatureGate
group: config.openshift.io
version: v1
plural: featuregates
namespaced: false
- kind: HelmChartRepository
group: helm.openshift.io
version: v1beta1
plural: helmchartrepositories
namespaced: false
- kind: Image
group: config.openshift.io
version: v1
plural: images
namespaced: false
- kind: Infrastructure
group: config.openshift.io
version: v1
plural: infrastructures
namespaced: false
- kind: Ingress
group: config.openshift.io
version: v1
plural: ingresses
namespaced: false
- kind: Network
group: config.openshift.io
version: v1
plural: networks
namespaced: false
- kind: OAuth
group: config.openshift.io
version: v1
plural: oauths
namespaced: false
- kind: OperatorHub
group: config.openshift.io
version: v1
plural: operatorhubs
namespaced: false
- kind: Project
group: config.openshift.io
version: v1
plural: projects
namespaced: false
- kind: Proxy
group: config.openshift.io
version: v1
plural: proxies
namespaced: false
- kind: Scheduler
group: config.openshift.io
version: v1
plural: schedulers
namespaced: false
- name: Console APIs
resources:
- kind: ConsoleCLIDownload
group: console.openshift.io
version: v1
plural: consoleclidownloads
namespaced: false
- kind: ConsoleExternalLogLink
group: console.openshift.io
version: v1
plural: consoleexternalloglinks
namespaced: false
- kind: ConsoleLink
group: console.openshift.io
version: v1
plural: consolelinks
namespaced: false
- kind: ConsoleNotification
group: console.openshift.io
version: v1
plural: consolenotifications
namespaced: false
- kind: ConsoleQuickStart
group: console.openshift.io
version: v1
plural: consolequickstarts
namespaced: false
- kind: ConsoleYAMLSample
group: console.openshift.io
version: v1
plural: consoleyamlsamples
namespaced: false
- name: Extension APIs
resources:
- kind: APIService
group: apiregistration.k8s.io
version: v1
plural: apiservices
namespaced: false
- kind: CustomResourceDefinition
group: apiextensions.k8s.io
version: v1
plural: customresourcedefinitions
namespaced: false
- kind: MutatingWebhookConfiguration
group: admissionregistration.k8s.io
version: v1
plural: mutatingwebhookconfigurations
namespaced: false
- kind: ValidatingWebhookConfiguration
group: admissionregistration.k8s.io
version: v1
plural: validatingwebhookconfigurations
namespaced: false
- name: Image APIs
resources:
- kind: Image
group: image.openshift.io
version: v1
plural: images
namespaced: false
- kind: ImageSignature
group: image.openshift.io
version: v1
plural: imagesignatures
namespaced: false
- kind: ImageStreamImage
group: image.openshift.io
version: v1
plural: imagestreamimages
namespaced: true
- kind: ImageStreamImport
group: image.openshift.io
version: v1
plural: imagestreamimports
namespaced: true
- kind: ImageStreamMapping
group: image.openshift.io
version: v1
plural: imagestreammappings
namespaced: true
- kind: ImageStream
group: image.openshift.io
version: v1
plural: imagestreams
namespaced: true
- kind: ImageStreamTag
group: image.openshift.io
version: v1
plural: imagestreamtags
namespaced: true
- kind: ImageTag
group: image.openshift.io
version: v1
plural: imagetags
namespaced: true
- name: Machine APIs
resources:
- kind: ContainerRuntimeConfig
group: machineconfiguration.openshift.io
version: v1
plural: containerruntimeconfigs
namespaced: false
- kind: ControllerConfig
group: machineconfiguration.openshift.io
version: v1
plural: controllerconfigs
namespaced: false
- kind: KubeletConfig
group: machineconfiguration.openshift.io
version: v1
plural: kubeletconfigs
namespaced: false
- kind: MachineConfigPool
group: machineconfiguration.openshift.io
version: v1
plural: machineconfigpools
namespaced: false
- kind: MachineConfig
group: machineconfiguration.openshift.io
version: v1
plural: machineconfigs
namespaced: false
- kind: MachineHealthCheck
group: machine.openshift.io
version: v1beta1
plural: machinehealthchecks
namespaced: true
- kind: Machine
group: machine.openshift.io
version: v1beta1
plural: machines
namespaced: true
- kind: MachineSet
group: machine.openshift.io
version: v1beta1
plural: machinesets
namespaced: true
- name: Metadata APIs
resources:
- kind: Binding
group: core
version: v1
plural: bindings
namespaced: true
- kind: ComponentStatus
group: core
version: v1
plural: componentstatuses
namespaced: false
- kind: ConfigMap
group: core
version: v1
plural: configmaps
namespaced: true
- kind: ControllerRevision
group: apps
version: v1
plural: controllerrevisions
namespaced: true
- kind: Event
group: events.k8s.io
version: v1
plural: events
namespaced: true
- kind: Event
group: core
version: v1
plural: events
namespaced: true
- kind: Lease
group: coordination.k8s.io
version: v1
plural: leases
namespaced: true
- kind: Namespace
group: core
version: v1
plural: namespaces
namespaced: false
- name: Monitoring APIs
resources:
- kind: Alertmanager
group: monitoring.coreos.com
version: v1
plural: alertmanagers
namespaced: true
- kind: AlertmanagerConfig
group: monitoring.coreos.com
version: v1alpha1
plural: alertmanagerconfigs
namespaced: true
- kind: PodMonitor
group: monitoring.coreos.com
version: v1
plural: podmonitors
namespaced: true
- kind: Probe
group: monitoring.coreos.com
version: v1
plural: probes
namespaced: true
- kind: Prometheus
group: monitoring.coreos.com
version: v1
plural: prometheuses
namespaced: true
- kind: PrometheusRule
group: monitoring.coreos.com
version: v1
plural: prometheusrules
namespaced: true
- kind: ServiceMonitor
group: monitoring.coreos.com
version: v1
plural: servicemonitors
namespaced: true
- kind: ThanosRuler
group: monitoring.coreos.com
version: v1
plural: thanosrulers
namespaced: true
- name: Network APIs
resources:
- kind: ClusterNetwork
group: network.openshift.io
version: v1
plural: clusternetworks
namespaced: false
- kind: Endpoints
group: core
version: v1
plural: endpoints
namespaced: true
- kind: EndpointSlice
group: discovery.k8s.io
version: v1beta1
plural: endpointslices
namespaced: true
- kind: EgressNetworkPolicy
group: network.openshift.io
version: v1
plural: egressnetworkpolicies
namespaced: true
- kind: HostSubnet
group: network.openshift.io
version: v1
plural: hostsubnets
namespaced: false
- kind: Ingress
group: networking.k8s.io
version: v1
plural: ingresses
namespaced: true
- kind: IngressClass
group: networking.k8s.io
version: v1
plural: ingressclasses
namespaced: false
- kind: IPPool
group: whereabouts.cni.cncf.io
version: v1alpha1
plural: ippools
namespaced: true
- kind: NetNamespace
group: network.openshift.io
version: v1
plural: netnamespaces
namespaced: false
- kind: NetworkAttachmentDefinition
group: k8s.cni.cncf.io
version: v1
plural: network-attachment-definitions
namespaced: true
- kind: NetworkPolicy
group: networking.k8s.io
version: v1
plural: networkpolicies
namespaced: true
- kind: PodNetworkConnectivityCheck
group: controlplane.operator.openshift.io
version: v1alpha1
plural: podnetworkconnectivitychecks
namespaced: true
- kind: Route
group: route.openshift.io
version: v1
plural: routes
namespaced: true
- kind: Service
group: core
version: v1
plural: services
namespaced: true
- name: Node APIs
resources:
- kind: Node
group: core
version: v1
plural: nodes
namespaced: false
- kind: Profile
group: tuned.openshift.io
version: v1
plural: profiles
namespaced: true
- kind: RuntimeClass
group: node.k8s.io
version: v1
plural: runtimeclasses
namespaced: false
- kind: Tuned
group: tuned.openshift.io
version: v1
plural: tuneds
namespaced: true
- name: OAuth APIs
resources:
- kind: OAuthAccessToken
group: oauth.openshift.io
version: v1
plural: oauthaccesstokens
namespaced: false
- kind: OAuthAuthorizeToken
group: oauth.openshift.io
version: v1
plural: oauthauthorizetokens
namespaced: false
- kind: OAuthClientAuthorization
group: oauth.openshift.io
version: v1
plural: oauthclientauthorizations
namespaced: false
- kind: OAuthClient
group: oauth.openshift.io
version: v1
plural: oauthclients
namespaced: false
- kind: UserOAuthAccessToken
group: oauth.openshift.io
version: v1
plural: useroauthaccesstokens
namespaced: false
- name: Operator APIs
resources:
- kind: Authentication
group: operator.openshift.io
version: v1
plural: authentications
namespaced: false
- kind: CloudCredential
group: operator.openshift.io
version: v1
plural: cloudcredentials
namespaced: false
- kind: ClusterCSIDriver
group: operator.openshift.io
version: v1
plural: clustercsidrivers
namespaced: false
- kind: Console
group: operator.openshift.io
version: v1
plural: consoles
namespaced: false
- kind: Config
group: operator.openshift.io
version: v1
plural: configs
namespaced: false
- kind: Config
group: imageregistry.operator.openshift.io
version: v1
plural: configs
namespaced: false
- kind: Config
group: samples.operator.openshift.io
version: v1
plural: configs
namespaced: false
- kind: CSISnapshotController
group: operator.openshift.io
version: v1
plural: csisnapshotcontrollers
namespaced: false
- kind: DNS
group: operator.openshift.io
version: v1
plural: dnses
namespaced: false
- kind: DNSRecord
group: ingress.operator.openshift.io
version: v1
plural: dnsrecords
namespaced: true
- kind: Etcd
group: operator.openshift.io
version: v1
plural: etcds
namespaced: false
- kind: ImageContentSourcePolicy
group: operator.openshift.io
version: v1alpha1
plural: imagecontentsourcepolicies
namespaced: false
- kind: ImagePruner
group: imageregistry.operator.openshift.io
version: v1
plural: imagepruners
namespaced: false
- kind: IngressController
group: operator.openshift.io
version: v1
plural: ingresscontrollers
namespaced: true
- kind: KubeAPIServer
group: operator.openshift.io
version: v1
plural: kubeapiservers
namespaced: false
- kind: KubeControllerManager
group: operator.openshift.io
version: v1
plural: kubecontrollermanagers
namespaced: false
- kind: KubeScheduler
group: operator.openshift.io
version: v1
plural: kubeschedulers
namespaced: false
- kind: KubeStorageVersionMigrator
group: operator.openshift.io
version: v1
plural: kubestorageversionmigrators
namespaced: false
- kind: Network
group: operator.openshift.io
version: v1
plural: networks
namespaced: false
- kind: OpenShiftAPIServer
group: operator.openshift.io
version: v1
plural: openshiftapiservers
namespaced: false
- kind: OpenShiftControllerManager
group: operator.openshift.io
version: v1
plural: openshiftcontrollermanagers
namespaced: false
- kind: OperatorPKI
group: network.operator.openshift.io
version: v1
plural: operatorpkis
namespaced: true
- kind: ServiceCA
group: operator.openshift.io
version: v1
plural: servicecas
namespaced: false
- kind: Storage
group: operator.openshift.io
version: v1
plural: storages
namespaced: false
- name: OperatorHub APIs
resources:
- kind: CatalogSource
group: operators.coreos.com
version: v1alpha1
plural: catalogsources
namespaced: true
- kind: ClusterServiceVersion
group: operators.coreos.com
version: v1alpha1
plural: clusterserviceversions
namespaced: true
- kind: InstallPlan
group: operators.coreos.com
version: v1alpha1
plural: installplans
namespaced: true
- kind: Operator
group: operators.coreos.com
version: v1
plural: operators
namespaced: false
- kind: OperatorCondition
group: operators.coreos.com
version: v1
plural: operatorconditions
namespaced: true
- kind: OperatorGroup
group: operators.coreos.com
version: v1
plural: operatorgroups
namespaced: true
- kind: PackageManifest
group: packages.operators.coreos.com
version: v1
plural: packagemanifests
namespaced: true
- kind: Subscription
group: operators.coreos.com
version: v1alpha1
plural: subscriptions
namespaced: true
- name: Policy APIs
resources:
- kind: PodDisruptionBudget
group: policy
version: v1beta1
plural: poddisruptionbudgets
namespaced: true
# https://bugzilla.redhat.com/show_bug.cgi?id=1875493
# - kind: PodSecurityPolicy
# group: policy
# version: v1beta1
# plural: podsecuritypolicies
# namespaced: false
- name: Project APIs
resources:
- kind: Project
group: project.openshift.io
version: v1
plural: projects
namespaced: false
- kind: ProjectRequest
group: project.openshift.io
version: v1
plural: projectrequests
namespaced: false
- name: Provisioning APIs
resources:
- kind: BareMetalHost
group: metal3.io
version: v1alpha1
plural: baremetalhosts
namespaced: true
- kind: Provisioning
group: metal3.io
version: v1alpha1
plural: provisionings
namespaced: false
- name: RBAC APIs
resources:
- kind: ClusterRoleBinding
group: rbac.authorization.k8s.io
version: v1
plural: clusterrolebindings
namespaced: false
- kind: ClusterRole
group: rbac.authorization.k8s.io
version: v1
plural: clusterroles
namespaced: false
- kind: RoleBinding
group: rbac.authorization.k8s.io
version: v1
plural: rolebindings
namespaced: true
- kind: Role
group: rbac.authorization.k8s.io
version: v1
plural: roles
namespaced: true
- name: Role APIs
resources:
- kind: ClusterRoleBinding
group: authorization.openshift.io
version: v1
plural: clusterrolebindings
namespaced: false
- kind: ClusterRole
group: authorization.openshift.io
version: v1
plural: clusterroles
namespaced: false
- kind: RoleBindingRestriction
group: authorization.openshift.io
version: v1
plural: rolebindingrestrictions
namespaced: true
- kind: RoleBinding
group: authorization.openshift.io
version: v1
plural: rolebindings
namespaced: true
- kind: Role
group: authorization.openshift.io
version: v1
plural: roles
namespaced: true
- name: Schedule and quota APIs
resources:
- kind: AppliedClusterResourceQuota
group: quota.openshift.io
version: v1
plural: appliedclusterresourcequotas
namespaced: true
- kind: ClusterResourceQuota
group: quota.openshift.io
version: v1
plural: clusterresourcequotas
namespaced: false
- kind: FlowSchema
group: flowcontrol.apiserver.k8s.io
version: v1alpha1
plural: flowschemas
namespaced: false
- kind: LimitRange
group: core
version: v1
plural: limitranges
namespaced: true
- kind: PriorityClass
group: scheduling.k8s.io
version: v1
plural: priorityclasses
namespaced: false
- kind: PriorityLevelConfiguration
group: flowcontrol.apiserver.k8s.io
version: v1alpha1
plural: prioritylevelconfigurations
namespaced: false
- kind: ResourceQuota
group: core
version: v1
plural: resourcequotas
namespaced: true
- name: Security APIs
resources:
- kind: CertificateSigningRequest
group: certificates.k8s.io
version: v1
plural: certificatesigningrequests
namespaced: false
- kind: CredentialsRequest
group: cloudcredential.openshift.io
version: v1
plural: credentialsrequests
namespaced: true
- kind: PodSecurityPolicyReview
group: security.openshift.io
version: v1
plural: podsecuritypolicyreviews
namespaced: true
- kind: PodSecurityPolicySelfSubjectReview
group: security.openshift.io
version: v1
plural: podsecuritypolicyselfsubjectreviews
namespaced: true
- kind: PodSecurityPolicySubjectReview
group: security.openshift.io
version: v1
plural: podsecuritypolicysubjectreviews
namespaced: true
- kind: RangeAllocation
group: security.openshift.io
version: v1
plural: rangeallocations
namespaced: false
# This is internal only, and must be ignored
# - kind: RangeAllocation
# group: security.internal.openshift.io
# version: v1
# plural: rangeallocations
# namespaced: false
- kind: Secret
group: core
version: v1
plural: secrets
namespaced: true
- kind: SecurityContextConstraints
group: security.openshift.io
version: v1
plural: securitycontextconstraints
namespaced: false
- kind: ServiceAccount
group: core
version: v1
plural: serviceaccounts
namespaced: true
- name: Storage APIs
resources:
- kind: CSIDriver
group: storage.k8s.io
version: v1
plural: csidrivers
namespaced: false
- kind: CSINode
group: storage.k8s.io
version: v1
plural: csinodes
namespaced: false
- kind: PersistentVolumeClaim
group: core
version: v1
plural: persistentvolumeclaims
namespaced: true
- kind: StorageClass
group: storage.k8s.io
version: v1
plural: storageclasses
namespaced: false
- kind: StorageState
group: migration.k8s.io
version: v1alpha1
plural: storagestates
namespaced: false
- kind: StorageVersionMigration
group: migration.k8s.io
version: v1alpha1
plural: storageversionmigrations
namespaced: false
- kind: VolumeAttachment
group: storage.k8s.io
version: v1
plural: volumeattachments
namespaced: false
- kind: VolumeSnapshot
group: snapshot.storage.k8s.io
version: v1
plural: volumesnapshots
namespaced: true
- kind: VolumeSnapshotClass
group: snapshot.storage.k8s.io
version: v1
plural: volumesnapshotclasses
namespaced: false
- kind: VolumeSnapshotContent
group: snapshot.storage.k8s.io
version: v1
plural: volumesnapshotcontents
namespaced: false
- name: Template APIs
resources:
- kind: BrokerTemplateInstance
group: template.openshift.io
version: v1
plural: brokertemplateinstances
namespaced: false
- kind: PodTemplate
group: core
version: v1
plural: podtemplates
namespaced: true
- kind: Template
group: template.openshift.io
version: v1
plural: processedtemplates
namespaced: true
- kind: TemplateInstance
group: template.openshift.io
version: v1
plural: templateinstances
namespaced: true
- name: User and group APIs
resources:
- kind: Group
group: user.openshift.io
version: v1
plural: groups
namespaced: false
- kind: Identity
group: user.openshift.io
version: v1
plural: identities
namespaced: false
- kind: UserIdentityMapping
group: user.openshift.io
version: v1
plural: useridentitymappings
namespaced: false
- kind: User
group: user.openshift.io
version: v1
plural: users
namespaced: false
- name: Workloads APIs
resources:
- kind: BuildConfig
group: build.openshift.io
version: v1
plural: buildconfigs
namespaced: true
- kind: Build
group: build.openshift.io
version: v1
plural: builds
namespaced: true
- kind: CronJob
group: batch
version: v1beta1
plural: cronjobs
namespaced: true
- kind: DaemonSet
group: apps
version: v1
plural: daemonsets
namespaced: true
- kind: Deployment
group: apps
version: v1
plural: deployments
namespaced: true
- kind: DeploymentConfig
group: apps.openshift.io
version: v1
plural: deploymentconfigs
namespaced: true
- kind: Job
group: batch
version: v1
plural: jobs
namespaced: true
- kind: Pod
group: core
version: v1
plural: pods
namespaced: true
- kind: ReplicationController
group: core
version: v1
plural: replicationcontrollers
namespaced: true
- kind: PersistentVolume
group: core
version: v1
plural: persistentvolumes
namespaced: false
- kind: ReplicaSet
group: apps
version: v1
plural: replicasets
namespaced: true
- kind: StatefulSet
group: apps
version: v1
plural: statefulsets
namespaced: true
# No properties defined in OpenAPI spec
# - kind: OverlappingRangeIPReservation
# group: whereabouts.cni.cncf.io
# version: v1alpha1
# plural: overlappingrangeipreservations
# namespaced: true